MigrationHubOrchestrator / Client / list_template_step_groups

list_template_step_groups#

MigrationHubOrchestrator.Client.list_template_step_groups(**kwargs)#

List the step groups in a template.

See also: AWS API Documentation

Request Syntax

response = client.list_template_step_groups(
    maxResults=123,
    nextToken='string',
    templateId='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results that can be returned.

  • nextToken (string) – The pagination token.

  • templateId (string) –

    [REQUIRED]

    The ID of the template.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'templateStepGroupSummary': [
        {
            'id': 'string',
            'name': 'string',
            'previous': [
                'string',
            ],
            'next': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token.

    • templateStepGroupSummary (list) –

      The summary of the step group in the template.

      • (dict) –

        The summary of the step group in the template.

        • id (string) –

          The ID of the step group.

        • name (string) –

          The name of the step group.

        • previous (list) –

          The previous step group.

          • (string) –

        • next (list) –

          The next step group.

          • (string) –

Exceptions

  • MigrationHubOrchestrator.Client.exceptions.ThrottlingException

  • MigrationHubOrchestrator.Client.exceptions.AccessDeniedException

  • MigrationHubOrchestrator.Client.exceptions.InternalServerException

  • MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException