Class: Aws::States::Types::DescribeStateMachineForExecutionOutput

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::DescribeStateMachineForExecutionOutput

Defined in:

gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition, :variable_references]

Instance Attribute Summary

• #definition ⇒ String

  The Amazon States Language definition of the state machine.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  Settings to configure server-side encryption.

• #label ⇒ String

  A user-defined or an auto-generated string that identifies a Map state.

• #logging_configuration ⇒ Types::LoggingConfiguration

  The LoggingConfiguration data type is used to set CloudWatch Logs options.

• #map_run_arn ⇒ String

  The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution.

• #name ⇒ String

  The name of the state machine associated with the execution.

• #revision_id ⇒ String

  The revision identifier for the state machine.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

• #state_machine_arn ⇒ String

  The Amazon Resource Name (ARN) of the state machine associated with the execution.

• #tracing_configuration ⇒ Types::TracingConfiguration

  Selects whether X-Ray tracing is enabled.

• #update_date ⇒ Time

  The date and time the state machine associated with an execution was updated.

• #variable_references ⇒ Hash<String,Array<String>>

  A map of state name to a list of variables referenced by that state.

Instance Attribute Details

#definition ⇒ String

The Amazon States Language definition of the state machine. See Amazon States Language.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

Settings to configure server-side encryption.

Returns:

• (Types::EncryptionConfiguration)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#label ⇒ String

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#logging_configuration ⇒ Types::LoggingConfiguration

The LoggingConfiguration data type is used to set CloudWatch Logs options.

Returns:

• (Types::LoggingConfiguration)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#map_run_arn ⇒ String

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#name ⇒ String

The name of the state machine associated with the execution.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#revision_id ⇒ String

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#state_machine_arn ⇒ String

The Amazon Resource Name (ARN) of the state machine associated with the execution.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether X-Ray tracing is enabled.

Returns:

• (Types::TracingConfiguration)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#update_date ⇒ Time

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

Returns:

• (Time)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end

#variable_references ⇒ Hash<String,Array<String>>

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

Returns:

• (Hash<String,Array<String>>)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1144

class DescribeStateMachineForExecutionOutput < Struct.new(
  :state_machine_arn,
  :name,
  :definition,
  :role_arn,
  :update_date,
  :logging_configuration,
  :tracing_configuration,
  :map_run_arn,
  :label,
  :revision_id,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :variable_references]
  include Aws::Structure
end