Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides information about a state machine's definition, its IAM role
Amazon Resource Name (ARN), and configuration. If the state machine ARN
is a qualified state machine ARN, the response returned includes the
Map
state's label.
A qualified state machine ARN refers to a Distributed Map state
defined within a state machine. For example, the qualified state machine
ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
refers to a Distributed Map state with a label mapStateLabel
in the
state machine named stateMachineName
.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Synopsis
- data DescribeStateMachine = DescribeStateMachine' {}
- newDescribeStateMachine :: Text -> DescribeStateMachine
- describeStateMachine_stateMachineArn :: Lens' DescribeStateMachine Text
- data DescribeStateMachineResponse = DescribeStateMachineResponse' {}
- newDescribeStateMachineResponse :: Int -> Text -> Text -> Text -> Text -> StateMachineType -> UTCTime -> DescribeStateMachineResponse
- describeStateMachineResponse_label :: Lens' DescribeStateMachineResponse (Maybe Text)
- describeStateMachineResponse_loggingConfiguration :: Lens' DescribeStateMachineResponse (Maybe LoggingConfiguration)
- describeStateMachineResponse_status :: Lens' DescribeStateMachineResponse (Maybe StateMachineStatus)
- describeStateMachineResponse_tracingConfiguration :: Lens' DescribeStateMachineResponse (Maybe TracingConfiguration)
- describeStateMachineResponse_httpStatus :: Lens' DescribeStateMachineResponse Int
- describeStateMachineResponse_stateMachineArn :: Lens' DescribeStateMachineResponse Text
- describeStateMachineResponse_name :: Lens' DescribeStateMachineResponse Text
- describeStateMachineResponse_definition :: Lens' DescribeStateMachineResponse Text
- describeStateMachineResponse_roleArn :: Lens' DescribeStateMachineResponse Text
- describeStateMachineResponse_type :: Lens' DescribeStateMachineResponse StateMachineType
- describeStateMachineResponse_creationDate :: Lens' DescribeStateMachineResponse UTCTime
Creating a Request
data DescribeStateMachine Source #
See: newDescribeStateMachine
smart constructor.
DescribeStateMachine' | |
|
Instances
newDescribeStateMachine Source #
Create a value of DescribeStateMachine
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStateMachine
, describeStateMachine_stateMachineArn
- The Amazon Resource Name (ARN) of the state machine to describe.
Request Lenses
describeStateMachine_stateMachineArn :: Lens' DescribeStateMachine Text Source #
The Amazon Resource Name (ARN) of the state machine to describe.
Destructuring the Response
data DescribeStateMachineResponse Source #
See: newDescribeStateMachineResponse
smart constructor.
DescribeStateMachineResponse' | |
|
Instances
newDescribeStateMachineResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> StateMachineType | |
-> UTCTime | |
-> DescribeStateMachineResponse |
Create a value of DescribeStateMachineResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:label:DescribeStateMachineResponse'
, describeStateMachineResponse_label
- 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.
$sel:loggingConfiguration:DescribeStateMachineResponse'
, describeStateMachineResponse_loggingConfiguration
- Undocumented member.
DescribeStateMachineResponse
, describeStateMachineResponse_status
- The current status of the state machine.
$sel:tracingConfiguration:DescribeStateMachineResponse'
, describeStateMachineResponse_tracingConfiguration
- Selects whether X-Ray tracing is enabled.
$sel:httpStatus:DescribeStateMachineResponse'
, describeStateMachineResponse_httpStatus
- The response's http status code.
DescribeStateMachine
, describeStateMachineResponse_stateMachineArn
- The Amazon Resource Name (ARN) that identifies the state machine.
DescribeStateMachineResponse
, describeStateMachineResponse_name
- 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 _.
$sel:definition:DescribeStateMachineResponse'
, describeStateMachineResponse_definition
- The Amazon States Language definition of the state machine. See
Amazon States Language.
DescribeStateMachineResponse
, describeStateMachineResponse_roleArn
- 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.)
DescribeStateMachineResponse
, describeStateMachineResponse_type
- The type
of the state machine (STANDARD
or EXPRESS
).
DescribeStateMachineResponse
, describeStateMachineResponse_creationDate
- The date the state machine is created.
Response Lenses
describeStateMachineResponse_label :: Lens' DescribeStateMachineResponse (Maybe Text) Source #
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.
describeStateMachineResponse_loggingConfiguration :: Lens' DescribeStateMachineResponse (Maybe LoggingConfiguration) Source #
Undocumented member.
describeStateMachineResponse_status :: Lens' DescribeStateMachineResponse (Maybe StateMachineStatus) Source #
The current status of the state machine.
describeStateMachineResponse_tracingConfiguration :: Lens' DescribeStateMachineResponse (Maybe TracingConfiguration) Source #
Selects whether X-Ray tracing is enabled.
describeStateMachineResponse_httpStatus :: Lens' DescribeStateMachineResponse Int Source #
The response's http status code.
describeStateMachineResponse_stateMachineArn :: Lens' DescribeStateMachineResponse Text Source #
The Amazon Resource Name (ARN) that identifies the state machine.
describeStateMachineResponse_name :: Lens' DescribeStateMachineResponse Text Source #
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 _.
describeStateMachineResponse_definition :: Lens' DescribeStateMachineResponse Text Source #
The Amazon States Language definition of the state machine. See Amazon States Language.
describeStateMachineResponse_roleArn :: Lens' DescribeStateMachineResponse Text Source #
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.)
describeStateMachineResponse_type :: Lens' DescribeStateMachineResponse StateMachineType Source #
The type
of the state machine (STANDARD
or EXPRESS
).
describeStateMachineResponse_creationDate :: Lens' DescribeStateMachineResponse UTCTime Source #
The date the state machine is created.