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 number of items to return in a single request.
nextToken (string) – A token to specify where to start paginating. Use the nextToken value 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'|'CANCELLED',
            'message': 'string',
            'totalStepCount': 123,
            'totalStepsSucceeded': 123,
            'totalStepsFailed': 123,
            'totalStepsSkipped': 123,
            'startTime': 'string',
            'endTime': 'string',
            'parallelGroup': 'string',
            'retried': True|False
        },
    ],
    'imageBuildVersionArn': 'string',
    'message': 'string',
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- workflowExecutions (list) –
  
  An array of runtime details that represents each time a workflow ran for the requested image build version. Image Builder retains workflow execution records for a limited time, so this array can be empty for older image build versions.
  - (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 that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.
    - 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.
    - parallelGroup (string) –
      
      The name of the test group that included the test workflow resource at runtime.
    - retried (boolean) –
      
      Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.
- imageBuildVersionArn (string) –
  
  The resource Amazon Resource Name (ARN) of the image build version for which you requested a list of workflow runtime details.
- message (string) –
  
  The failure reason for the image build version, if it’s in a failed state. This comes from the image itself, not from an individual workflow, so it’s available even when no workflow executions remain for the image.
- 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