AWS Step Functions
Describe state machine
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。
Provide information about a state machine’s definition, its IAM role Amazon Resource Name (ARN), and configuration.
Inputs
stateMachineArn [required]
The Amazon Resource Name (ARN) of the state machine for which you want the information.
Outputs
Expand All
stateMachineArn [required]
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.
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 _.
The current status of the state machine.
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.)
The type of the state machine (STANDARD or EXPRESS).
The date the state machine is created. For a state machine version, creationDate is the date the version was created.
Defines which category of execution history events are logged.
Determines whether execution data is included in your log. When set to false, data is excluded.
An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.
An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
Selects whether X-Ray tracing is enabled.
When set to true, X-Ray tracing is enabled.
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.
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.
The description of the state machine version.
