Values.DescribeStateMachineOutputSourceProvides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
type nonrec t = {stateMachineArn : Arn.t option;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.
*)name : Name.t option;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, U+FFFE-FFFF) surrogates (U+D800-DFFF) invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)status : StateMachineStatus.t option;The current status of the state machine.
*)definition : Definition.t option;The Amazon States Language definition of the state machine. See Amazon States Language. If called with includedData = METADATA_ONLY, the returned definition will be {}.
*)roleArn : Arn.t option;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.)
*)type_ : StateMachineType.t option;The type of the state machine (STANDARD or EXPRESS).
*)creationDate : Timestamp.t option;The date the state machine is created. For a state machine version, creationDate is the date the version was created.
*)loggingConfiguration : LoggingConfiguration.t option;tracingConfiguration : TracingConfiguration.t option;Selects whether X-Ray tracing is enabled.
*)label : MapRunLabel.t option;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.
*)revisionId : RevisionId.t option;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.
*)description : VersionDescription.t option;The description of the state machine version.
*)encryptionConfiguration : EncryptionConfiguration.t option;Settings to configure server-side encryption.
*)variableReferences : VariableReferences.t option;A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.
*)}type nonrec error = [ | `InvalidArn of InvalidArn.t| `KmsAccessDeniedException of KmsAccessDeniedException.t| `KmsInvalidStateException of KmsInvalidStateException.t| `KmsThrottlingException of KmsThrottlingException.t| `StateMachineDoesNotExist of StateMachineDoesNotExist.t| `Unknown_operation_error of string * string option ]val make :
?stateMachineArn:??? ->
?name:??? ->
?status:??? ->
?definition:??? ->
?roleArn:??? ->
?type_:??? ->
?creationDate:??? ->
?loggingConfiguration:??? ->
?tracingConfiguration:??? ->
?label:??? ->
?revisionId:??? ->
?description:??? ->
?encryptionConfiguration:??? ->
?variableReferences:??? ->
unit ->
tval error_of_json :
string ->
Yojson.Safe.t ->
[> `InvalidArn of InvalidArn.t
| `KmsAccessDeniedException of KmsAccessDeniedException.t
| `KmsInvalidStateException of KmsInvalidStateException.t
| `KmsThrottlingException of KmsThrottlingException.t
| `StateMachineDoesNotExist of StateMachineDoesNotExist.t
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `InvalidArn of InvalidArn.t
| `KmsAccessDeniedException of KmsAccessDeniedException.t
| `KmsInvalidStateException of KmsInvalidStateException.t
| `KmsThrottlingException of KmsThrottlingException.t
| `StateMachineDoesNotExist of StateMachineDoesNotExist.t
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Map of
([> `String of StateName.t ]
* [> `List of [> `String of VariableName.t ] list ])
list
| `String of Arn.t
| `Structure of
(string
* [> `Boolean of IncludeExecutionData.t
| `Enum of string
| `Integer of KmsDataKeyReusePeriodSeconds.t
| `List of
[> `Structure of
(string
* [> `Structure of (string * [> `String of Arn.t ]) list ])
list ]
list
| `String of KmsKeyId.t ])
list
| `Timestamp of Timestamp.t ])
list ]