imagebuilder / Paginator / ListWorkflowStepExecutions

ListWorkflowStepExecutions¶

class imagebuilder.Paginator.ListWorkflowStepExecutions¶

paginator = client.get_paginator('list_workflow_step_executions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from imagebuilder.Client.list_workflow_step_executions().

Request Syntax

response_iterator = paginator.paginate(
    workflowExecutionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

workflowExecutionId (string) –
[REQUIRED]

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'steps': [
        {
            'stepExecutionId': 'string',
            'name': 'string',
            'description': 'string',
            'action': 'string',
            'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
            'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED',
            'message': 'string',
            'inputs': 'string',
            'outputs': 'string',
            'startTime': 'string',
            'endTime': 'string'
        },
    ],
    'workflowBuildVersionArn': 'string',
    'workflowExecutionId': 'string',
    'imageBuildVersionArn': 'string',
    'message': 'string',
    'NextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- steps (list) –
  
  Contains an array of runtime details that represents each step in this runtime instance of the workflow.
  - (dict) –
    
    Runtime details and status for the workflow step.
    - stepExecutionId (string) –
      
      A unique identifier for the workflow step, assigned at runtime.
    - name (string) –
      
      The name of the workflow step.
    - description (string) –
      
      Description of the workflow step.
    - action (string) –
      
      The step action name.
    - status (string) –
      
      Runtime status for the workflow step.
    - rollbackStatus (string) –
      
      Reports on the rollback status of the step, if applicable.
    - message (string) –
      
      Detailed output message that the workflow step provides at runtime.
    - inputs (string) –
      
      Input parameters that Image Builder provides for the workflow step.
    - outputs (string) –
      
      The file names that the workflow step created as output for this runtime instance of the workflow.
    - startTime (string) –
      
      The timestamp when the workflow step started.
    - endTime (string) –
      
      The timestamp when the workflow step finished.
- workflowBuildVersionArn (string) –
  
  The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
- workflowExecutionId (string) –
  
  The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
- imageBuildVersionArn (string) –
  
  The image build version resource ARN that’s associated with the specified runtime instance of the workflow.
- message (string) –
  
  The output message from the list action, if applicable.
- NextToken (string) –
  
  A token to resume pagination.