imagebuilder / Client / list_workflow_executions

list_workflow_executions#

imagebuilder.Client.list_workflow_executions(**kwargs)#

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Request Syntax

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

List all workflow runtime instances for the specified image build version resource ARN.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'workflowExecutions': [
        {
            'workflowBuildVersionArn': 'string',
            'workflowExecutionId': 'string',
            'type': 'BUILD'|'TEST'|'DISTRIBUTION',
            'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED',
            'message': 'string',
            'totalStepCount': 123,
            'totalStepsSucceeded': 123,
            'totalStepsFailed': 123,
            'totalStepsSkipped': 123,
            'startTime': 'string',
            'endTime': 'string'
        },
    ],
    'imageBuildVersionArn': 'string',
    'message': 'string',
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- workflowExecutions (list) –
  
  Contains an array of runtime details that represents each time a workflow ran for the requested image build version.
  - (dict) –
    
    Metadata that includes details and status from this runtime instance of the workflow.
    - workflowBuildVersionArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow resource build version that ran.
    - workflowExecutionId (string) –
      
      Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
    - type (string) –
      
      Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    - status (string) –
      
      The current runtime status for this workflow.
    - message (string) –
      
      The runtime output message from the workflow, if applicable.
    - totalStepCount (integer) –
      
      The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
    - totalStepsSucceeded (integer) –
      
      A runtime count for the number of steps in the workflow that ran successfully.
    - totalStepsFailed (integer) –
      
      A runtime count for the number of steps in the workflow that failed.
    - totalStepsSkipped (integer) –
      
      A runtime count for the number of steps in the workflow that were skipped.
    - startTime (string) –
      
      The timestamp when the runtime instance of this workflow started.
    - endTime (string) –
      
      The timestamp when this runtime instance of the workflow finished.
- imageBuildVersionArn (string) –
  
  The resource ARN of the image build version for which you requested a list of workflow runtime details.
- 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 has’ot 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