sfn_describe_state_machine

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
See <a href="https://www.paws-r-sdk.com/docs/sfn_describe_state_machine/">https://www.paws-r-sdk.com/docs/sfn_describe_state_machine/</a> for full documentation.

internal

Interface to 'Amazon Web Services' application integration
services, including 'Simple Queue Service' ('SQS') message queue,
'Simple Notification Service' ('SNS') publish/subscribe messaging, and
more <https://aws.amazon.com/>.

Dyfan Jones

paws.application.integration

'Amazon Web Services' Application Integration Services

David Kretch

Adam Banker

Amazon.com, Inc. 

sfn_describe_state_machine function

<dl><dt>stateMachineArn</dt>
<dd>[required] 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,
<code>stateMachineARN:1</code>.</dd>
<dt>includedData</dt>
<dd>If your state machine definition is encrypted with a KMS key, callers
must have <code>kms:Decrypt</code> permission to decrypt the definition.
Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code>
to get a successful response without the encrypted definition.
When calling a labelled ARN for an encrypted state machine, the
<code>includedData = METADATA_ONLY</code> 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 <code>kms:Decrypt</code> permission.</dd></dl>

Arguments

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
See <a href='https://www.paws-r-sdk.com/docs/sfn_describe_state_machine/'>https://www.paws-r-sdk.com/docs/sfn_describe_state_machine/</a> for full documentation.

Provides information about a state machine's definition, its IAM role
Amazon Resource Name (ARN), and configuration — sfn_describe_state_machine

<dl>

<dt>stateMachineArn</dt>
<dd>[required] 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,
<code>stateMachineARN:1</code>.</dd>


<dt>includedData</dt>
<dd>If your state machine definition is encrypted with a KMS key, callers
must have <code>kms:Decrypt</code> permission to decrypt the definition.
Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code>
to get a successful response without the encrypted definition.
When calling a labelled ARN for an encrypted state machine, the
<code>includedData = METADATA_ONLY</code> 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 <code>kms:Decrypt</code> permission.</dd>

</dl>

sfn_describe_state_machine: Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration

Description

Usage

Arguments