Class: Aws::States::Types::DescribeStateMachineOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::States::Types::DescribeStateMachineOutput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-states/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:definition, :description]
Instance Attribute Summary collapse
-
#creation_date ⇒ Time
The date the state machine is created.
-
#definition ⇒ String
The Amazon States Language definition of the state machine.
-
#description ⇒ String
The description of the state machine version.
-
#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.
-
#name ⇒ String
The name of the state machine.
-
#revision_id ⇒ String
The revision identifier for the state machine.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
-
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the state machine.
-
#status ⇒ String
The current status of the state machine.
-
#tracing_configuration ⇒ Types::TracingConfiguration
Selects whether X-Ray tracing is enabled.
-
#type ⇒ String
The ‘type` of the state machine (`STANDARD` or `EXPRESS`).
Instance Attribute Details
#creation_date ⇒ Time
The date the state machine is created.
For a state machine version, ‘creationDate` is the date the version was created.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] 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
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#description ⇒ String
The description of the state machine version.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] 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.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#logging_configuration ⇒ Types::LoggingConfiguration
The ‘LoggingConfiguration` data type is used to set CloudWatch Logs options.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] 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 _.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#revision_id ⇒ String
The revision identifier for the state machine.
Use the ‘revisionId` parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as `definition` and `roleArn`.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] 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.)
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, ‘stateMachineARN:1`.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#status ⇒ String
The current status of the state machine.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#tracing_configuration ⇒ Types::TracingConfiguration
Selects whether X-Ray tracing is enabled.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |
#type ⇒ String
The ‘type` of the state machine (`STANDARD` or `EXPRESS`).
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/aws-sdk-states/types.rb', line 1108 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration, :tracing_configuration, :label, :revision_id, :description) SENSITIVE = [:definition, :description] include Aws::Structure end |