MigrationHubOrchestrator / Client / list_template_steps

list_template_steps#

MigrationHubOrchestrator.Client.list_template_steps(**kwargs)#

List the steps in a template.

Request Syntax

response = client.list_template_steps(
    maxResults=123,
    nextToken='string',
    templateId='string',
    stepGroupId='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.
stepGroupId (string) –
[REQUIRED]

The ID of the step group.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'templateStepSummaryList': [
        {
            'id': 'string',
            'stepGroupId': 'string',
            'templateId': 'string',
            'name': 'string',
            'stepActionType': 'MANUAL'|'AUTOMATED',
            'targetType': 'SINGLE'|'ALL'|'NONE',
            'owner': 'AWS_MANAGED'|'CUSTOM',
            'previous': [
                'string',
            ],
            'next': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The pagination token.
- templateStepSummaryList (list) –
  
  The list of summaries of steps in a template.
  - (dict) –
    
    The summary of the step.
    - id (string) –
      
      The ID of the step.
    - stepGroupId (string) –
      
      The ID of the step group.
    - templateId (string) –
      
      The ID of the template.
    - name (string) –
      
      The name of the step.
    - stepActionType (string) –
      
      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
    - targetType (string) –
      
      The servers on which to run the script.
    - owner (string) –
      
      The owner of the step.
    - previous (list) –
      
      The previous step.
      - (string) –
    - next (list) –
      
      The next step.
      - (string) –

Exceptions

MigrationHubOrchestrator.Client.exceptions.ThrottlingException
MigrationHubOrchestrator.Client.exceptions.AccessDeniedException
MigrationHubOrchestrator.Client.exceptions.InternalServerException
MigrationHubOrchestrator.Client.exceptions.ValidationException
MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException