Amazonka.StepFunctions.DescribeExecution

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.

Creating a Request

data DescribeExecution

See: newDescribeExecution smart constructor.

Constructors

DescribeExecution'

Fields

• executionArn :: Text

  The Amazon Resource Name (ARN) of the execution to describe.

Instances

ToJSON DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

toJSON :: DescribeExecution -> Value

toEncoding :: DescribeExecution -> Encoding

toJSONList :: [DescribeExecution] -> Value

toEncodingList :: [DescribeExecution] -> Encoding

ToHeaders DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

toHeaders :: DescribeExecution -> [Header]

ToPath DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

toPath :: DescribeExecution -> ByteString

ToQuery DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

toQuery :: DescribeExecution -> QueryString

AWSRequest DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Associated Types

type AWSResponse DescribeExecution

Methods

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

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

Generic DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Associated Types

type Rep DescribeExecution :: Type -> Type

Methods

from :: DescribeExecution -> Rep DescribeExecution x

to :: Rep DescribeExecution x -> DescribeExecution

Read DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

readsPrec :: Int -> ReadS DescribeExecution

readList :: ReadS [DescribeExecution]

readPrec :: ReadPrec DescribeExecution

readListPrec :: ReadPrec [DescribeExecution]

Show DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

showsPrec :: Int -> DescribeExecution -> ShowS

show :: DescribeExecution -> String

showList :: [DescribeExecution] -> ShowS

NFData DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

rnf :: DescribeExecution -> ()

Eq DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

(==) :: DescribeExecution -> DescribeExecution -> Bool

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

Hashable DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

hashWithSalt :: Int -> DescribeExecution -> Int

hash :: DescribeExecution -> Int

type AWSResponse DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

type AWSResponse DescribeExecution = DescribeExecutionResponse

type Rep DescribeExecution

Defined in Amazonka.StepFunctions.DescribeExecution

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

newDescribeExecution

Arguments

:: Text

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:

DescribeExecution, describeExecution_executionArn - The Amazon Resource Name (ARN) of the execution to describe.

Request Lenses

describeExecution_executionArn :: Lens' DescribeExecution Text

The Amazon Resource Name (ARN) of the execution to describe.

Destructuring the Response

data DescribeExecutionResponse

See: newDescribeExecutionResponse smart constructor.

Constructors

DescribeExecutionResponse'

Fields

• cause :: Maybe (Sensitive Text)

  The cause string if the state machine execution failed.

• error :: Maybe (Sensitive Text)

  The error string if the state machine execution failed.

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

• inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
• mapRunArn :: Maybe Text

  The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

• 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
• stopDate :: Maybe POSIX

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

• traceHeader :: Maybe Text

  The 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

Generic DescribeExecutionResponse

Defined in Amazonka.StepFunctions.DescribeExecution

Associated Types

type Rep DescribeExecutionResponse :: Type -> Type

Methods

from :: DescribeExecutionResponse -> Rep DescribeExecutionResponse x

to :: Rep DescribeExecutionResponse x -> DescribeExecutionResponse

Show DescribeExecutionResponse

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

showsPrec :: Int -> DescribeExecutionResponse -> ShowS

show :: DescribeExecutionResponse -> String

showList :: [DescribeExecutionResponse] -> ShowS

NFData DescribeExecutionResponse

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

rnf :: DescribeExecutionResponse -> ()

Eq DescribeExecutionResponse

Defined in Amazonka.StepFunctions.DescribeExecution

Methods

(==) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool

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

type Rep DescribeExecutionResponse

Defined in Amazonka.StepFunctions.DescribeExecution

type Rep DescribeExecutionResponse = D1 ('MetaData "DescribeExecutionResponse" "Amazonka.StepFunctions.DescribeExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DescribeExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "inputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails)) :*: S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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 "stopDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (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

Arguments

:: Int

$sel:httpStatus:DescribeExecutionResponse'

-> Text

DescribeExecution

-> Text

DescribeExecutionResponse

-> ExecutionStatus

DescribeExecutionResponse

-> UTCTime

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:

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)

The cause string if the state machine execution failed.

describeExecutionResponse_error :: Lens' DescribeExecutionResponse (Maybe Text)

The error string if the state machine execution failed.

describeExecutionResponse_input :: Lens' DescribeExecutionResponse (Maybe 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.

describeExecutionResponse_inputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)

Undocumented member.

describeExecutionResponse_mapRunArn :: Lens' DescribeExecutionResponse (Maybe Text)

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

describeExecutionResponse_name :: Lens' DescribeExecutionResponse (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 _.

describeExecutionResponse_output :: Lens' DescribeExecutionResponse (Maybe 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.

describeExecutionResponse_outputDetails :: Lens' DescribeExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)

Undocumented member.

describeExecutionResponse_stopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime)

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

describeExecutionResponse_traceHeader :: Lens' DescribeExecutionResponse (Maybe Text)

The X-Ray trace header that was passed to the execution.

describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int

The response's http status code.

describeExecutionResponse_executionArn :: Lens' DescribeExecutionResponse Text

The Amazon Resource Name (ARN) that identifies the execution.

describeExecutionResponse_stateMachineArn :: Lens' DescribeExecutionResponse Text

The Amazon Resource Name (ARN) of the executed stated machine.

describeExecutionResponse_status :: Lens' DescribeExecutionResponse ExecutionStatus

The current status of the execution.

describeExecutionResponse_startDate :: Lens' DescribeExecutionResponse UTCTime

The date the execution is started.