imagebuilder / Client / list_waiting_workflow_steps

list_waiting_workflow_steps#

imagebuilder.Client.list_waiting_workflow_steps(**kwargs)#

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

Request Syntax

response = client.list_waiting_workflow_steps(
    maxResults=123,
    nextToken='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.

Return type:

dict

Returns:

Response Syntax

{
    'steps': [
        {
            'stepExecutionId': 'string',
            'imageBuildVersionArn': 'string',
            'workflowExecutionId': 'string',
            'workflowBuildVersionArn': 'string',
            'name': 'string',
            'action': 'string',
            'startTime': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- steps (list) –
  
  An array of the workflow steps that are waiting for action in your Amazon Web Services account.
  - (dict) –
    
    Contains runtime details for an instance of a workflow that ran for the associated image build version.
    - stepExecutionId (string) –
      
      Uniquely identifies the workflow step that ran for the associated image build version.
    - imageBuildVersionArn (string) –
      
      The Amazon Resource Name (ARN) of the image build version that ran the workflow.
    - workflowExecutionId (string) –
      
      Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version.
    - workflowBuildVersionArn (string) –
      
      The ARN of the workflow resource that ran.
    - name (string) –
      
      The name of the workflow step.
    - action (string) –
      
      The name of the step action.
    - startTime (string) –
      
      The timestamp when the workflow step started.
- 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