You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::States::Types::DescribeExecutionOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#execution_arn ⇒ String

The Amazon Resource Name (ARN) that id entifies the execution.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) that id entifies the execution.

#input ⇒ String

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

  • (String) —

    The string that contains the JSON input data of the execution.

#input_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:

#name ⇒ String

The name of the execution.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

  • (String) —

    The name of the execution.

#output ⇒ String

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Returns:

  • (String) —

    The JSON output data of the execution.

#output_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:

#start_date ⇒ Time

The date the execution is started.

Returns:

  • (Time) —

    The date the execution is started.

#state_machine_arn ⇒ String

The Amazon Resource Name (ARN) of the executed stated machine.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the executed stated machine.

#status ⇒ String

The current status of the execution.

Possible values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • ABORTED

Returns:

  • (String) —

    The current status of the execution.

#stop_date ⇒ Time

If the execution has already ended, the date the execution stopped.

Returns:

  • (Time) —

    If the execution has already ended, the date the execution stopped.

#trace_header ⇒ String

The AWS X-Ray trace header which was passed to the execution.

Returns:

  • (String) —

    The AWS X-Ray trace header which was passed to the execution.