Method: Aws::States::Client#describe_execution

Defined in:

lib/aws-sdk-states/client.rb

#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you’ve [redriven] an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, ‘DescribeExecution` returns that ARN.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

Executions of an ‘EXPRESS` state machine aren’t supported by ‘DescribeExecution` unless a Map Run dispatched them.

[1]: docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html

Examples:

Request syntax with placeholder values

resp = client.describe_execution({
  execution_arn: "Arn", # required
})

Response structure

resp.execution_arn #=> String
resp.state_machine_arn #=> String
resp.name #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED", "PENDING_REDRIVE"
resp.start_date #=> Time
resp.stop_date #=> Time
resp.input #=> String
resp.input_details.included #=> Boolean
resp.output #=> String
resp.output_details.included #=> Boolean
resp.trace_header #=> String
resp.map_run_arn #=> String
resp.error #=> String
resp.cause #=> String
resp.state_machine_version_arn #=> String
resp.state_machine_alias_arn #=> String
resp.redrive_count #=> Integer
resp.redrive_date #=> Time
resp.redrive_status #=> String, one of "REDRIVABLE", "NOT_REDRIVABLE", "REDRIVABLE_BY_MAP_RUN"
resp.redrive_status_reason #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :execution_arn (required, String) —

  The Amazon Resource Name (ARN) of the execution to describe.

Returns:

• (Types::DescribeExecutionOutput) —

  Returns a response object which responds to the following methods:

  • #execution_arn => String

  • #state_machine_arn => String

  • #name => String

  • #status => String

  • #start_date => Time

  • #stop_date => Time

  • #input => String

  • #input_details => Types::CloudWatchEventsExecutionDataDetails

  • #output => String

  • #output_details => Types::CloudWatchEventsExecutionDataDetails

  • #trace_header => String

  • #map_run_arn => String

  • #error => String

  • #cause => String

  • #state_machine_version_arn => String

  • #state_machine_alias_arn => String

  • #redrive_count => Integer

  • #redrive_date => Time

  • #redrive_status => String

  • #redrive_status_reason => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-states/client.rb', line 1057

def describe_execution(params = {}, options = {})
  req = build_request(:describe_execution, params)
  req.send_request(options)
end