Amazonka.StepFunctions.DescribeStateMachineForExecution

Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the 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 machines.

Creating a Request

data DescribeStateMachineForExecution

See: newDescribeStateMachineForExecution smart constructor.

Constructors

DescribeStateMachineForExecution'

Fields

• executionArn :: Text

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

Instances

ToJSON DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

toJSON :: DescribeStateMachineForExecution -> Value

toEncoding :: DescribeStateMachineForExecution -> Encoding

toJSONList :: [DescribeStateMachineForExecution] -> Value

toEncodingList :: [DescribeStateMachineForExecution] -> Encoding

ToHeaders DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

toHeaders :: DescribeStateMachineForExecution -> [Header]

ToPath DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

toPath :: DescribeStateMachineForExecution -> ByteString

ToQuery DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

toQuery :: DescribeStateMachineForExecution -> QueryString

AWSRequest DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Associated Types

type AWSResponse DescribeStateMachineForExecution

Methods

request :: (Service -> Service) -> DescribeStateMachineForExecution -> Request DescribeStateMachineForExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStateMachineForExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStateMachineForExecution)))

Generic DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Associated Types

type Rep DescribeStateMachineForExecution :: Type -> Type

Methods

from :: DescribeStateMachineForExecution -> Rep DescribeStateMachineForExecution x

to :: Rep DescribeStateMachineForExecution x -> DescribeStateMachineForExecution

Read DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

readsPrec :: Int -> ReadS DescribeStateMachineForExecution

readList :: ReadS [DescribeStateMachineForExecution]

readPrec :: ReadPrec DescribeStateMachineForExecution

readListPrec :: ReadPrec [DescribeStateMachineForExecution]

Show DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

showsPrec :: Int -> DescribeStateMachineForExecution -> ShowS

show :: DescribeStateMachineForExecution -> String

showList :: [DescribeStateMachineForExecution] -> ShowS

NFData DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

rnf :: DescribeStateMachineForExecution -> ()

Eq DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

(==) :: DescribeStateMachineForExecution -> DescribeStateMachineForExecution -> Bool

(/=) :: DescribeStateMachineForExecution -> DescribeStateMachineForExecution -> Bool

Hashable DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

hashWithSalt :: Int -> DescribeStateMachineForExecution -> Int

hash :: DescribeStateMachineForExecution -> Int

type AWSResponse DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

type AWSResponse DescribeStateMachineForExecution = DescribeStateMachineForExecutionResponse

type Rep DescribeStateMachineForExecution

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

type Rep DescribeStateMachineForExecution = D1 ('MetaData "DescribeStateMachineForExecution" "Amazonka.StepFunctions.DescribeStateMachineForExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeStateMachineForExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeStateMachineForExecution

Arguments

:: Text

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:

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

Request Lenses

describeStateMachineForExecution_executionArn :: Lens' DescribeStateMachineForExecution Text

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

Destructuring the Response

data DescribeStateMachineForExecutionResponse

See: newDescribeStateMachineForExecutionResponse smart constructor.

Constructors

DescribeStateMachineForExecutionResponse'

Fields

• label :: Maybe Text

  A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

• loggingConfiguration :: Maybe LoggingConfiguration
• mapRunArn :: Maybe Text

  The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

• tracingConfiguration :: Maybe TracingConfiguration

  Selects whether X-Ray tracing is enabled.

• 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

Generic DescribeStateMachineForExecutionResponse

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Associated Types

type Rep DescribeStateMachineForExecutionResponse :: Type -> Type

Methods

from :: DescribeStateMachineForExecutionResponse -> Rep DescribeStateMachineForExecutionResponse x

to :: Rep DescribeStateMachineForExecutionResponse x -> DescribeStateMachineForExecutionResponse

Show DescribeStateMachineForExecutionResponse

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

showsPrec :: Int -> DescribeStateMachineForExecutionResponse -> ShowS

show :: DescribeStateMachineForExecutionResponse -> String

showList :: [DescribeStateMachineForExecutionResponse] -> ShowS

NFData DescribeStateMachineForExecutionResponse

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

rnf :: DescribeStateMachineForExecutionResponse -> ()

Eq DescribeStateMachineForExecutionResponse

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

Methods

(==) :: DescribeStateMachineForExecutionResponse -> DescribeStateMachineForExecutionResponse -> Bool

(/=) :: DescribeStateMachineForExecutionResponse -> DescribeStateMachineForExecutionResponse -> Bool

type Rep DescribeStateMachineForExecutionResponse

Defined in Amazonka.StepFunctions.DescribeStateMachineForExecution

type Rep DescribeStateMachineForExecutionResponse = D1 ('MetaData "DescribeStateMachineForExecutionResponse" "Amazonka.StepFunctions.DescribeStateMachineForExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeStateMachineForExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration))) :*: (S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)) :*: 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

Arguments

:: Int

$sel:httpStatus:DescribeStateMachineForExecutionResponse'

-> Text

DescribeStateMachineForExecutionResponse

-> Text

DescribeStateMachineForExecutionResponse

-> Text

$sel:definition:DescribeStateMachineForExecutionResponse'

-> Text

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:label:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_label - A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

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

DescribeStateMachineForExecutionResponse, describeStateMachineForExecutionResponse_mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

$sel:tracingConfiguration:DescribeStateMachineForExecutionResponse', describeStateMachineForExecutionResponse_tracingConfiguration - Selects whether X-Ray tracing is enabled.

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

DescribeStateMachineForExecutionResponse, describeStateMachineForExecutionResponse_stateMachineArn - The Amazon Resource Name (ARN) of the state machine associated with the execution.

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.

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_label :: Lens' DescribeStateMachineForExecutionResponse (Maybe Text)

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

describeStateMachineForExecutionResponse_loggingConfiguration :: Lens' DescribeStateMachineForExecutionResponse (Maybe LoggingConfiguration)

Undocumented member.

describeStateMachineForExecutionResponse_mapRunArn :: Lens' DescribeStateMachineForExecutionResponse (Maybe Text)

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

describeStateMachineForExecutionResponse_tracingConfiguration :: Lens' DescribeStateMachineForExecutionResponse (Maybe TracingConfiguration)

Selects whether X-Ray tracing is enabled.

describeStateMachineForExecutionResponse_httpStatus :: Lens' DescribeStateMachineForExecutionResponse Int

The response's http status code.

describeStateMachineForExecutionResponse_stateMachineArn :: Lens' DescribeStateMachineForExecutionResponse Text

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

describeStateMachineForExecutionResponse_name :: Lens' DescribeStateMachineForExecutionResponse Text

The name of the state machine associated with the execution.

describeStateMachineForExecutionResponse_definition :: Lens' DescribeStateMachineForExecutionResponse Text

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

describeStateMachineForExecutionResponse_roleArn :: Lens' DescribeStateMachineForExecutionResponse Text

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

describeStateMachineForExecutionResponse_updateDate :: Lens' DescribeStateMachineForExecutionResponse UTCTime

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