imagebuilder / Client / list_workflow_step_executions

list_workflow_step_executions#

imagebuilder.Client.list_workflow_step_executions(**kwargs)#

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

Request Syntax

response = client.list_workflow_step_executions(
    maxResults=123,
    nextToken='string',
    workflowExecutionId='string'
)

Parameters:

maxResults (integer) – The maximum items to return in a request.
nextToken (string) – A token to specify where to start paginating. This is the nextToken from a previously truncated response.
workflowExecutionId (string) –
[REQUIRED]

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

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) –
  
  The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.InvalidPaginationTokenException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException