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 all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS
state machine executions
unless they were dispatched by a Map Run.
Synopsis
- data DescribeExecution = DescribeExecution' {
- executionArn :: Text
- newDescribeExecution :: Text -> DescribeExecution
- describeExecution_executionArn :: Lens' DescribeExecution Text
- data DescribeExecutionResponse = DescribeExecutionResponse' {
- cause :: Maybe (Sensitive Text)
- error :: Maybe (Sensitive Text)
- input :: Maybe (Sensitive Text)
- inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- mapRunArn :: Maybe Text
- name :: Maybe Text
- output :: Maybe (Sensitive Text)
- outputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- stopDate :: Maybe POSIX
- traceHeader :: Maybe Text
- httpStatus :: Int
- executionArn :: Text
- stateMachineArn :: Text
- status :: ExecutionStatus
- startDate :: POSIX
- newDescribeExecutionResponse :: Int -> Text -> Text -> ExecutionStatus -> UTCTime -> DescribeExecutionResponse
- describeExecutionResponse_cause :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_error :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_input :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_inputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
- describeExecutionResponse_mapRunArn :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_name :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_output :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_outputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
- describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime)
- describeExecutionResponse_traceHeader :: Lens' DescribeExecutionResponse (Maybe Text)
- describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int
- describeExecutionResponse_executionArn :: Lens' DescribeExecutionResponse Text
- describeExecutionResponse_stateMachineArn :: Lens' DescribeExecutionResponse Text
- describeExecutionResponse_status :: Lens' DescribeExecutionResponse ExecutionStatus
- describeExecutionResponse_startDate :: Lens' DescribeExecutionResponse UTCTime
Creating a Request
data DescribeExecution Source #
See: newDescribeExecution
smart constructor.
DescribeExecution' | |
|
Instances
Create a value of DescribeExecution
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:
DescribeExecution
, describeExecution_executionArn
- The Amazon Resource Name (ARN) of the execution to describe.
Request Lenses
describeExecution_executionArn :: Lens' DescribeExecution Text Source #
The Amazon Resource Name (ARN) of the execution to describe.
Destructuring the Response
data DescribeExecutionResponse Source #
See: newDescribeExecutionResponse
smart constructor.
DescribeExecutionResponse' | |
|
Instances
newDescribeExecutionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ExecutionStatus | |
-> UTCTime | |
-> DescribeExecutionResponse |
Create a value of DescribeExecutionResponse
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:
DescribeExecutionResponse
, describeExecutionResponse_cause
- The cause string if the state machine execution failed.
DescribeExecutionResponse
, describeExecutionResponse_error
- The error string if the state machine execution failed.
DescribeExecutionResponse
, describeExecutionResponse_input
- The string that contains the JSON input data of the execution. Length
constraints apply to the payload size, and are expressed as bytes in
UTF-8 encoding.
DescribeExecutionResponse
, describeExecutionResponse_inputDetails
- Undocumented member.
DescribeExecutionResponse
, describeExecutionResponse_mapRunArn
- The Amazon Resource Name (ARN) that identifies a Map Run, which
dispatched this execution.
DescribeExecutionResponse
, describeExecutionResponse_name
- The name of the execution.
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 _.
DescribeExecutionResponse
, describeExecutionResponse_output
- The JSON output data of the execution. Length constraints apply to the
payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
DescribeExecutionResponse
, describeExecutionResponse_outputDetails
- Undocumented member.
DescribeExecutionResponse
, describeExecutionResponse_stopDate
- If the execution has already ended, the date the execution stopped.
$sel:traceHeader:DescribeExecutionResponse'
, describeExecutionResponse_traceHeader
- The X-Ray trace header that was passed to the execution.
$sel:httpStatus:DescribeExecutionResponse'
, describeExecutionResponse_httpStatus
- The response's http status code.
DescribeExecution
, describeExecutionResponse_executionArn
- The Amazon Resource Name (ARN) that identifies the execution.
DescribeExecutionResponse
, describeExecutionResponse_stateMachineArn
- The Amazon Resource Name (ARN) of the executed stated machine.
DescribeExecutionResponse
, describeExecutionResponse_status
- The current status of the execution.
DescribeExecutionResponse
, describeExecutionResponse_startDate
- The date the execution is started.
Response Lenses
describeExecutionResponse_cause :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The cause string if the state machine execution failed.
describeExecutionResponse_error :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The error string if the state machine execution failed.
describeExecutionResponse_input :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
describeExecutionResponse_inputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails) Source #
Undocumented member.
describeExecutionResponse_mapRunArn :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
describeExecutionResponse_name :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The name of the execution.
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 _.
describeExecutionResponse_output :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
describeExecutionResponse_outputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails) Source #
Undocumented member.
describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #
If the execution has already ended, the date the execution stopped.
describeExecutionResponse_traceHeader :: Lens' DescribeExecutionResponse (Maybe Text) Source #
The X-Ray trace header that was passed to the execution.
describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int Source #
The response's http status code.
describeExecutionResponse_executionArn :: Lens' DescribeExecutionResponse Text Source #
The Amazon Resource Name (ARN) that identifies the execution.
describeExecutionResponse_stateMachineArn :: Lens' DescribeExecutionResponse Text Source #
The Amazon Resource Name (ARN) of the executed stated machine.
describeExecutionResponse_status :: Lens' DescribeExecutionResponse ExecutionStatus Source #
The current status of the execution.
describeExecutionResponse_startDate :: Lens' DescribeExecutionResponse UTCTime Source #
The date the execution is started.