[ aws . stepfunctions ]
Describes a state machine.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
describe-state-machine
--state-machine-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--state-machine-arn (string)
The Amazon Resource Name (ARN) of the state machine to describe.
--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
stateMachineArn -> (string)
The Amazon Resource Name (ARN) that identifies the state machine.
name -> (string)
The name of the state machine.
A name must not contain:
- whitespace
- brackets `` { } [ ]``
- wildcard characters ? *
- special characters " # % \ ^ | ~ ` $ , ; : /
- control characters (U+0000-001F , U+007F-009F )
status -> (string)
The current status of the state machine.
definition -> (string)
The Amazon States Language definition of the state machine.
roleArn -> (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 AWS resources.)
creationDate -> (timestamp)
The date the state machine is created.