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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-states/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:input, :output, :error, :cause]

Instance Attribute Summary collapse

Instance Attribute Details

#cause ⇒ String

The cause string if the state machine execution failed.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#error ⇒ String

The error string if the state machine execution failed.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#execution_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the execution.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#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) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#input_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#map_run_arn ⇒ String

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#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) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#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.

<note markdown=“1”> This field is set only if the execution succeeds. If the execution fails, this field is null.

</note>

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#output_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#start_date ⇒ Time

The date the execution is started.

Returns:

  • (Time) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#state_machine_alias_arn ⇒ String

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, ‘stateMachineARN:PROD`.

If you start an execution from a ‘StartExecution` request with a state machine version ARN, this field will be null.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#state_machine_arn ⇒ String

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

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#state_machine_version_arn ⇒ String

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, ‘stateMachineARN:1`.

If you start an execution from a ‘StartExecution` request without specifying a state machine version or alias ARN, Step Functions returns a null value.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#status ⇒ String

The current status of the execution.

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#stop_date ⇒ Time

If the execution ended, the date the execution stopped.

Returns:

  • (Time) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end

#trace_header ⇒ String

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

Returns:

  • (String) 


761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/aws-sdk-states/types.rb', line 761

class DescribeExecutionOutput < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :input,
  :input_details,
  :output,
  :output_details,
  :trace_header,
  :map_run_arn,
  :error,
  :cause,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = [:input, :output, :error, :cause]
  include Aws::Structure
end