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, :redrive_status_reason]

Instance Attribute Summary collapse

Instance Attribute Details

#cause ⇒ String

The cause string if the state machine execution failed.

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#error ⇒ String

The error string if the state machine execution failed.

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#execution_arn ⇒ String

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

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  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) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#input_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#map_run_arn ⇒ String

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

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  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) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  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) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#output_details ⇒ Types::CloudWatchEventsExecutionDataDetails

Provides details about execution input or output.

Returns:



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#redrive_count ⇒ Integer

The number of times you’ve redriven an execution. If you have not yet redriven an execution, the ‘redriveCount` is 0. This count is only updated if you successfully redrive an execution.

Returns:

  • (Integer) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#redrive_date ⇒ Time

The date the execution was last redriven. If you have not yet redriven an execution, the ‘redriveDate` is null.

The ‘redriveDate` is unavailable if you redrive a Map Run that starts child workflow executions of type `EXPRESS`.

Returns:

  • (Time) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#redrive_status ⇒ String

Indicates whether or not an execution can be redriven at a given point in time.

  • For executions of type ‘STANDARD`, `redriveStatus` is `NOT_REDRIVABLE` if calling the RedriveExecution API action would return the `ExecutionNotRedrivable` error.

  • For a Distributed Map that includes child workflows of type ‘STANDARD`, `redriveStatus` indicates whether or not the Map Run can redrive child workflow executions.

  • For a Distributed Map that includes child workflows of type ‘EXPRESS`, `redriveStatus` indicates whether or not the Map Run can redrive child workflow executions.

    You can redrive failed or timed out ‘EXPRESS` workflows *only if* they’re a part of a Map Run. When you [redrive] the Map Run, these workflows are restarted using the StartExecution API action.

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

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#redrive_status_reason ⇒ String

When ‘redriveStatus` is `NOT_REDRIVABLE`, `redriveStatusReason` specifies the reason why an execution cannot be redriven.

  • For executions of type ‘STANDARD`, or for a Distributed Map that includes child workflows of type `STANDARD`, `redriveStatusReason` can include one of the following reasons:

    • ‘State machine is in DELETING status`.

    • ‘Execution is RUNNING and cannot be redriven`.

    • ‘Execution is SUCCEEDED and cannot be redriven`.

    • ‘Execution was started before the launch of RedriveExecution`.

    • ‘Execution history event limit exceeded`.

    • ‘Execution has exceeded the max execution time`.

    • ‘Execution redrivable period exceeded`.

  • For a Distributed Map that includes child workflows of type ‘EXPRESS`, `redriveStatusReason` is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#start_date ⇒ Time

The date the execution is started.

Returns:

  • (Time) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  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) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#state_machine_arn ⇒ String

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

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  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) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#status ⇒ String

The current status of the execution.

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#stop_date ⇒ Time

If the execution ended, the date the execution stopped.

Returns:

  • (Time) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end

#trace_header ⇒ String

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

Returns:

  • (String) 


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/aws-sdk-states/types.rb', line 864

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,
  :redrive_count,
  :redrive_date,
  :redrive_status,
  :redrive_status_reason)
  SENSITIVE = [:input, :output, :error, :cause, :redrive_status_reason]
  include Aws::Structure
end