Class: Aws::States::Types::DescribeStateMachineOutput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:definition]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

The date the state machine is created.

Returns:

  • (Time) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#definition ⇒ String

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

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#label ⇒ String

A user-defined or an auto-generated string that identifies a `Map` state. This parameter is present only if the `stateMachineArn` specified in input is a qualified state machine ARN.

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#logging_configuration ⇒ Types::LoggingConfiguration

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

Returns:


875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#name ⇒ String

The name of the state machine.

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) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#state_machine_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the state machine.

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#status ⇒ String

The current status of the state machine.

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether X-Ray tracing is enabled.

Returns:


875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#type ⇒ String

The `type` of the state machine (`STANDARD` or `EXPRESS`).

Returns:

  • (String) 

875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/aws-sdk-states/types.rb', line 875

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label)
  SENSITIVE = [:definition]
  include Aws::Structure
end