workflow_step_groups

Creates, updates, deletes, gets or lists a workflow_step_groups resource.

Overview

Name	workflow_step_groups
Type	Resource
Id	aws.migrationhuborchestrator.workflow_step_groups

Fields

The following fields are returned by SELECT queries:

get_workflow_step_group

Name	Datatype	Description
id	string	The ID of the step group. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the step group.
creation_time	string (date-time)	The time at which the step group was created.
description	string	The description of the step group.
end_time	string (date-time)	The time at which the step group ended.
last_modified_time	string (date-time)	The time at which the step group was last modified.
next	array	The next step group.
owner	string	The owner of the step group. (AWS_MANAGED, CUSTOM)
previous	array	The previous step group.
status	string	The status of the step group. (AWAITING_DEPENDENCIES, READY, IN_PROGRESS, COMPLETED, FAILED, PAUSED, PAUSING, USER_ATTENTION_REQUIRED)
tools	array	List of AWS services utilized in a migration workflow.
workflow_id	string	The ID of the migration workflow.

list_workflow_step_groups

Name	Datatype	Description
id	string	The ID of the step group.
name	string	The name of the step group.
next	array	The next step group.
owner	string	The owner of the step group. (AWS_MANAGED, CUSTOM)
previous	array	The previous step group.
status	string	The status of the step group. (AWAITING_DEPENDENCIES, READY, IN_PROGRESS, COMPLETED, FAILED, PAUSED, PAUSING, USER_ATTENTION_REQUIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_step_group	select	id, workflowId, region		Get the step group of a migration workflow.
list_workflow_step_groups	select	workflowId, region	nextToken, maxResults	List the step groups in a migration workflow.
create_workflow_step_group	insert	region, workflowId, name		Create a step group in a migration workflow.
update_workflow_step_group	update	workflowId, id, region		Update the step group in a migration workflow.
delete_workflow_step_group	delete	workflowId, id, region		Delete a step group in a migration workflow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the step group you want to delete.
region	string	AWS region (default: us-east-1)
workflowId	string	The ID of the migration workflow.
maxResults	integer	The maximum number of results that can be returned.
nextToken	string	The pagination token.

SELECT examples

get_workflow_step_group

Get the step group of a migration workflow.

SELECT
id,
name,
creation_time,
description,
end_time,
last_modified_time,
next,
owner,
previous,
status,
tools,
workflow_id
FROM aws.migrationhuborchestrator.workflow_step_groups
WHERE id = '{{ id }}' -- required
AND workflowId = '{{ workflowId }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_step_groups

List the step groups in a migration workflow.

SELECT
id,
name,
next,
owner,
previous,
status
FROM aws.migrationhuborchestrator.workflow_step_groups
WHERE workflowId = '{{ workflowId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_workflow_step_group

Create a step group in a migration workflow.

INSERT INTO aws.migrationhuborchestrator.workflow_step_groups (
workflowId,
name,
description,
next,
previous,
region
)
SELECT 
'{{ workflowId }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ next }}',
'{{ previous }}',
'{{ region }}'
RETURNING
id,
name,
creation_time,
description,
next,
previous,
tools,
workflow_id
;

Manifest

# Description fields are for documentation purposes
- name: workflow_step_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflow_step_groups resource.
  - name: workflowId
    value: "{{ workflowId }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: next
    value:
      - "{{ next }}"
  - name: previous
    value:
      - "{{ previous }}"

UPDATE examples

update_workflow_step_group

Update the step group in a migration workflow.

UPDATE aws.migrationhuborchestrator.workflow_step_groups
SET 
name = '{{ name }}',
description = '{{ description }}',
next = '{{ next }}',
previous = '{{ previous }}'
WHERE 
workflowId = '{{ workflowId }}' --required
AND id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
description,
last_modified_time,
next,
previous,
tools,
workflow_id;

DELETE examples

delete_workflow_step_group

Delete a step group in a migration workflow.

DELETE FROM aws.migrationhuborchestrator.workflow_step_groups
WHERE workflowId = '{{ workflowId }}' --required
AND id = '{{ id }}' --required
AND region = '{{ region }}' --required
;