Class: Aws::States::Types::DescribeStateMachineInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::States::Types::DescribeStateMachineInput
- Defined in:
- gems/aws-sdk-states/lib/aws-sdk-states/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#included_data ⇒ String
If your state machine definition is encrypted with a KMS key, callers must have
kms:Decrypt
permission to decrypt the definition. -
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) of the state machine for which you want the information.
Instance Attribute Details
#included_data ⇒ String
If your state machine definition is encrypted with a KMS key,
callers must have kms:Decrypt
permission to decrypt the
definition. Alternatively, you can call the API with includedData =
METADATA_ONLY
to get a successful response without the encrypted
definition.
includedData = METADATA_ONLY
parameter will not apply because Step
Functions needs to decrypt the entire state machine definition to
get the Distributed Map state’s definition. In this case, the API
caller needs to have kms:Decrypt
permission.
1166 1167 1168 1169 1170 1171 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1166 class DescribeStateMachineInput < Struct.new( :state_machine_arn, :included_data) SENSITIVE = [] include Aws::Structure end |
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details
about that version. The version ARN is a combination of state
machine ARN and the version number separated by a colon (:). For
example, stateMachineARN:1
.
1166 1167 1168 1169 1170 1171 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1166 class DescribeStateMachineInput < Struct.new( :state_machine_arn, :included_data) SENSITIVE = [] include Aws::Structure end |