Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StepFunctions.DescribeExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an execution.

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 machines.

Synopsis

data DescribeExecution = DescribeExecution' {
- executionArn :: Text
}
newDescribeExecution :: Text -> DescribeExecution
describeExecution_executionArn :: Lens' DescribeExecution Text
data DescribeExecutionResponse = DescribeExecutionResponse' {
- stopDate :: Maybe POSIX
- inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- input :: Maybe (Sensitive Text)
- name :: Maybe Text
- output :: Maybe (Sensitive Text)
- outputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- traceHeader :: Maybe Text
- httpStatus :: Int
- executionArn :: Text
- stateMachineArn :: Text
- status :: ExecutionStatus
- startDate :: POSIX
}
newDescribeExecutionResponse :: Int -> Text -> Text -> ExecutionStatus -> UTCTime -> DescribeExecutionResponse
describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime)
describeExecutionResponse_inputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
describeExecutionResponse_input :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_name :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_output :: Lens' DescribeExecutionResponse (Maybe Text)
describeExecutionResponse_outputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
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.

Constructors

DescribeExecution'
Fields executionArn :: Text The Amazon Resource Name (ARN) of the execution to describe.

Instances

Instances details

Eq DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods (==) :: DescribeExecution -> DescribeExecution -> Bool # (/=) :: DescribeExecution -> DescribeExecution -> Bool #
Read DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods readsPrec :: Int -> ReadS DescribeExecution # readList :: ReadS [DescribeExecution] # readPrec :: ReadPrec DescribeExecution # readListPrec :: ReadPrec [DescribeExecution] #
Show DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods showsPrec :: Int -> DescribeExecution -> ShowS # show :: DescribeExecution -> String # showList :: [DescribeExecution] -> ShowS #
Generic DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Associated Types type Rep DescribeExecution :: Type -> Type # Methods from :: DescribeExecution -> Rep DescribeExecution x # to :: Rep DescribeExecution x -> DescribeExecution #
NFData DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods rnf :: DescribeExecution -> () #
Hashable DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods hashWithSalt :: Int -> DescribeExecution -> Int # hash :: DescribeExecution -> Int #
ToJSON DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods toJSON :: DescribeExecution -> Value # toEncoding :: DescribeExecution -> Encoding # toJSONList :: [DescribeExecution] -> Value # toEncodingList :: [DescribeExecution] -> Encoding #
AWSRequest DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Associated Types type AWSResponse DescribeExecution # Methods request :: DescribeExecution -> Request DescribeExecution # response :: MonadResource m => Logger -> Service -> Proxy DescribeExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExecution))) #
ToHeaders DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods toHeaders :: DescribeExecution -> [Header] #
ToPath DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods toPath :: DescribeExecution -> ByteString #
ToQuery DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods toQuery :: DescribeExecution -> QueryString #
type Rep DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution type Rep DescribeExecution = D1 ('MetaData "DescribeExecution" "Amazonka.StepFunctions.DescribeExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeExecution Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution type AWSResponse DescribeExecution = DescribeExecutionResponse

newDescribeExecution Source #

Arguments

:: Text	`$sel:executionArn:DescribeExecution'`
-> DescribeExecution

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:

$sel:executionArn: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.

Constructors

DescribeExecutionResponse'

Fields

stopDate :: Maybe POSIX
If the execution has already ended, the date the execution stopped.
inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
input :: Maybe (Sensitive Text)
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.
name :: Maybe Text
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 _.
output :: Maybe (Sensitive Text)
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.
outputDetails :: Maybe CloudWatchEventsExecutionDataDetails
traceHeader :: Maybe Text
The AWS X-Ray trace header that was passed to the execution.
httpStatus :: Int
The response's http status code.
executionArn :: Text
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn :: Text
The Amazon Resource Name (ARN) of the executed stated machine.
status :: ExecutionStatus
The current status of the execution.
startDate :: POSIX
The date the execution is started.

Instances

Instances details

Eq DescribeExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods (==) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool # (/=) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool #
Show DescribeExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods showsPrec :: Int -> DescribeExecutionResponse -> ShowS # show :: DescribeExecutionResponse -> String # showList :: [DescribeExecutionResponse] -> ShowS #
Generic DescribeExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Associated Types type Rep DescribeExecutionResponse :: Type -> Type # Methods from :: DescribeExecutionResponse -> Rep DescribeExecutionResponse x # to :: Rep DescribeExecutionResponse x -> DescribeExecutionResponse #
NFData DescribeExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution Methods rnf :: DescribeExecutionResponse -> () #
type Rep DescribeExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeExecution type Rep DescribeExecutionResponse = D1 ('MetaData "DescribeExecutionResponse" "Amazonka.StepFunctions.DescribeExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "stopDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "inputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails)) :: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "outputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails))))) :: ((S1 ('MetaSel ('Just "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionStatus) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeExecutionResponse'`
-> Text	`$sel:executionArn:DescribeExecution'`
-> Text	`$sel:stateMachineArn:DescribeExecutionResponse'`
-> ExecutionStatus	`$sel:status:DescribeExecutionResponse'`
-> UTCTime	`$sel:startDate:DescribeExecutionResponse'`
-> 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:

$sel:stopDate:DescribeExecutionResponse', describeExecutionResponse_stopDate - If the execution has already ended, the date the execution stopped.

$sel:inputDetails:DescribeExecutionResponse', describeExecutionResponse_inputDetails - Undocumented member.

$sel:input: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.

$sel:name: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 _.

$sel:output: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.

$sel:outputDetails:DescribeExecutionResponse', describeExecutionResponse_outputDetails - Undocumented member.

$sel:traceHeader:DescribeExecutionResponse', describeExecutionResponse_traceHeader - The AWS X-Ray trace header that was passed to the execution.

$sel:httpStatus:DescribeExecutionResponse', describeExecutionResponse_httpStatus - The response's http status code.

$sel:executionArn:DescribeExecution', describeExecutionResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution.

$sel:stateMachineArn:DescribeExecutionResponse', describeExecutionResponse_stateMachineArn - The Amazon Resource Name (ARN) of the executed stated machine.

$sel:status:DescribeExecutionResponse', describeExecutionResponse_status - The current status of the execution.

$sel:startDate:DescribeExecutionResponse', describeExecutionResponse_startDate - The date the execution is started.

Response Lenses

describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #

If the execution has already ended, the date the execution stopped.

describeExecutionResponse_inputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails) Source #

Undocumented member.

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_name :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The name of the execution.

A name must not contain: