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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the state machine associated with a specific 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

Creating a Request

data DescribeStateMachineForExecution Source #

See: newDescribeStateMachineForExecution smart constructor.

Constructors

DescribeStateMachineForExecution'
Fields executionArn :: Text The Amazon Resource Name (ARN) of the execution you want state machine information for.

Instances

Instances details

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

newDescribeStateMachineForExecution Source #

Arguments

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

Create a value of DescribeStateMachineForExecution 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:DescribeStateMachineForExecution', describeStateMachineForExecution_executionArn - The Amazon Resource Name (ARN) of the execution you want state machine information for.

Request Lenses

describeStateMachineForExecution_executionArn :: Lens' DescribeStateMachineForExecution Text Source #

The Amazon Resource Name (ARN) of the execution you want state machine information for.

Destructuring the Response

data DescribeStateMachineForExecutionResponse Source #

See: newDescribeStateMachineForExecutionResponse smart constructor.

Constructors

DescribeStateMachineForExecutionResponse'

Fields

tracingConfiguration :: Maybe TracingConfiguration
Selects whether AWS X-Ray tracing is enabled.
loggingConfiguration :: Maybe LoggingConfiguration
httpStatus :: Int
The response's http status code.
stateMachineArn :: Text
The Amazon Resource Name (ARN) of the state machine associated with the execution.
name :: Text
The name of the state machine associated with the execution.
definition :: Sensitive Text
The Amazon States Language definition of the state machine. See Amazon States Language.
roleArn :: Text
The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
updateDate :: POSIX
The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

Instances

Instances details

Eq DescribeStateMachineForExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution Methods (==) :: DescribeStateMachineForExecutionResponse -> DescribeStateMachineForExecutionResponse -> Bool # (/=) :: DescribeStateMachineForExecutionResponse -> DescribeStateMachineForExecutionResponse -> Bool #
Show DescribeStateMachineForExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution Methods showsPrec :: Int -> DescribeStateMachineForExecutionResponse -> ShowS # show :: DescribeStateMachineForExecutionResponse -> String # showList :: [DescribeStateMachineForExecutionResponse] -> ShowS #
Generic DescribeStateMachineForExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution Associated Types type Rep DescribeStateMachineForExecutionResponse :: Type -> Type # Methods from :: DescribeStateMachineForExecutionResponse -> Rep DescribeStateMachineForExecutionResponse x # to :: Rep DescribeStateMachineForExecutionResponse x -> DescribeStateMachineForExecutionResponse #
NFData DescribeStateMachineForExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution Methods rnf :: DescribeStateMachineForExecutionResponse -> () #
type Rep DescribeStateMachineForExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution type Rep DescribeStateMachineForExecutionResponse = D1 ('MetaData "DescribeStateMachineForExecutionResponse" "Amazonka.StepFunctions.DescribeStateMachineForExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "DescribeStateMachineForExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)) :: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newDescribeStateMachineForExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeStateMachineForExecutionResponse'`
-> Text	`$sel:stateMachineArn:DescribeStateMachineForExecutionResponse'`
-> Text	`$sel:name:DescribeStateMachineForExecutionResponse'`
-> Text	`$sel:definition:DescribeStateMachineForExecutionResponse'`
-> Text	`$sel:roleArn:DescribeStateMachineForExecutionResponse'`
-> UTCTime	`$sel:updateDate:DescribeStateMachineForExecutionResponse'`
-> DescribeStateMachineForExecutionResponse

Create a value of DescribeStateMachineForExecutionResponse 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:tracingConfiguration:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_tracingConfiguration - Selects whether AWS X-Ray tracing is enabled.

$sel:loggingConfiguration:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_loggingConfiguration - Undocumented member.

$sel:httpStatus:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_httpStatus - The response's http status code.

$sel:stateMachineArn:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_stateMachineArn - The Amazon Resource Name (ARN) of the state machine associated with the execution.

$sel:name:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_name - The name of the state machine associated with the execution.

$sel:definition:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_definition - The Amazon States Language definition of the state machine. See Amazon States Language.

$sel:roleArn:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

$sel:updateDate:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_updateDate - The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

Response Lenses

describeStateMachineForExecutionResponse_tracingConfiguration :: Lens' DescribeStateMachineForExecutionResponse (Maybe TracingConfiguration) Source #

Selects whether AWS X-Ray tracing is enabled.

describeStateMachineForExecutionResponse_loggingConfiguration :: Lens' DescribeStateMachineForExecutionResponse (Maybe LoggingConfiguration) Source #

Undocumented member.

describeStateMachineForExecutionResponse_httpStatus :: Lens' DescribeStateMachineForExecutionResponse Int Source #

The response's http status code.

describeStateMachineForExecutionResponse_stateMachineArn :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The Amazon Resource Name (ARN) of the state machine associated with the execution.

describeStateMachineForExecutionResponse_name :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The name of the state machine associated with the execution.

describeStateMachineForExecutionResponse_definition :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The Amazon States Language definition of the state machine. See Amazon States Language.

describeStateMachineForExecutionResponse_roleArn :: Lens' DescribeStateMachineForExecutionResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

describeStateMachineForExecutionResponse_updateDate :: Lens' DescribeStateMachineForExecutionResponse UTCTime Source #

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.