template_step_groups

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

Overview

Name	template_step_groups
Type	Resource
Id	aws.migrationhuborchestrator.template_step_groups

Fields

The following fields are returned by SELECT queries:

get_template_step_group

Name	Datatype	Description
id	string	The ID of the step group.
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.
last_modified_time	string (date-time)	The time at which the step group was last modified.
next	array	The next step group.
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)
template_id	string	The ID of the template.
tools	array	List of AWS services utilized in a migration workflow.

list_template_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.
previous	array	The previous step group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_template_step_group	select	template_id, id, region		Get a step group in a template.
list_template_step_groups	select	template_id, region	maxResults, nextToken	List the step groups in a template.

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.
region	string	AWS region (default: us-east-1)
template_id	string	The ID of the template.
maxResults	integer	The maximum number of results that can be returned.
nextToken	string	The pagination token.

SELECT examples

get_template_step_group

Get a step group in a template.

SELECT
id,
name,
creation_time,
description,
last_modified_time,
next,
previous,
status,
template_id,
tools
FROM aws.migrationhuborchestrator.template_step_groups
WHERE template_id = '{{ template_id }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_template_step_groups

List the step groups in a template.

SELECT
id,
name,
next,
previous
FROM aws.migrationhuborchestrator.template_step_groups
WHERE template_id = '{{ template_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;