imagebuilder / Client / get_workflow_step_execution

get_workflow_step_execution¶

imagebuilder.Client.get_workflow_step_execution(**kwargs)¶

Retrieves runtime information for a specific runtime instance of the workflow step.

Request Syntax

response = client.get_workflow_step_execution(
    stepExecutionId='string'
)

Parameters:

stepExecutionId (string) –

[REQUIRED]

The unique identifier for the runtime instance of the workflow step that you want to get runtime details for. To get the identifiers for the steps that ran in a workflow, call ListWorkflowStepExecutions.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'stepExecutionId': 'string',
    'workflowBuildVersionArn': 'string',
    'workflowExecutionId': 'string',
    'imageBuildVersionArn': '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',
    'onFailure': 'string',
    'timeoutSeconds': 123,
    'attemptNumber': 123,
    'maxAttempts': 123
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- stepExecutionId (string) –
  
  The unique identifier for the runtime instance of the workflow step that you specified in the request.
- workflowBuildVersionArn (string) –
  
  The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
- 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 build version that owns the specified runtime instance of the workflow step.
- name (string) –
  
  The name of the specified runtime instance of the workflow step.
- description (string) –
  
  Describes the specified workflow step.
- action (string) –
  
  The name of the action that the specified step performs.
- status (string) –
  
  The current status for the specified runtime instance of the workflow step.
- rollbackStatus (string) –
  
  Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
- message (string) –
  
  The output message from the specified runtime instance of the workflow step, if applicable.
- inputs (string) –
  
  Input parameters that Image Builder provided for the specified runtime instance of the workflow step, as a JSON-encoded string.
- outputs (string) –
  
  The output values that the specified runtime instance of the workflow step produced, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.
- startTime (string) –
  
  The timestamp when the specified runtime instance of the workflow step started.
- endTime (string) –
  
  The timestamp when the specified runtime instance of the workflow step finished.
- onFailure (string) –
  
  The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn’t set a value, it defaults to Abort.
- timeoutSeconds (integer) –
  
  The maximum duration in seconds for this step to complete its action. If the workflow document doesn’t set a timeout for the step, Image Builder applies the default timeout for the step’s action. This field returns that value.
- attemptNumber (integer) –
  
  The current attempt number for the specified runtime instance of the workflow step. The first run is attempt one. The number increases by one for each retry.
- maxAttempts (integer) –
  
  The maximum number of attempts allowed for the specified runtime instance of the workflow step, based on the retry configuration in the workflow document. If the step doesn’t configure retries, the maximum is one attempt.

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