imagebuilder / Client / get_workflow_execution

get_workflow_execution

imagebuilder.Client.get_workflow_execution(**kwargs)

Get the runtime information that was logged for a specific runtime instance of the workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_execution(
    workflowExecutionId='string'
)

Parameters:

workflowExecutionId (string) –

[REQUIRED]

Use the unique identifier for a runtime instance of the workflow to get runtime details.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'workflowBuildVersionArn': 'string',
    'workflowExecutionId': 'string',
    'imageBuildVersionArn': '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'
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • workflowBuildVersionArn (string) –

    The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified 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 Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

  • type (string) –

    The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

  • status (string) –

    The current runtime status for the specified runtime instance of the workflow.

  • message (string) –

    The output message from the specified runtime instance of the workflow, if applicable.

  • totalStepCount (integer) –

    The total number of steps in the specified runtime instance of the workflow that ran. This number 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 that ran successfully in the specified runtime instance of the workflow.

  • totalStepsFailed (integer) –

    A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

  • totalStepsSkipped (integer) –

    A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

  • startTime (string) –

    The timestamp when the specified runtime instance of the workflow started.

  • endTime (string) –

    The timestamp when the specified runtime instance of the workflow finished.

  • parallelGroup (string) –

    Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException