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.SWF.DescribeWorkflowExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the specified workflow execution including its type and some statistics.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Synopsis

Creating a Request

data DescribeWorkflowExecution Source #

See: newDescribeWorkflowExecution smart constructor.

Constructors

DescribeWorkflowExecution'
Fields domain :: Text The name of the domain containing the workflow execution. execution :: WorkflowExecution The workflow execution to describe.

Instances

Instances details

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

newDescribeWorkflowExecution Source #

Arguments

:: Text	`$sel:domain:DescribeWorkflowExecution'`
-> WorkflowExecution	`$sel:execution:DescribeWorkflowExecution'`
-> DescribeWorkflowExecution

Create a value of DescribeWorkflowExecution 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:domain:DescribeWorkflowExecution', describeWorkflowExecution_domain - The name of the domain containing the workflow execution.

$sel:execution:DescribeWorkflowExecution', describeWorkflowExecution_execution - The workflow execution to describe.

Request Lenses

describeWorkflowExecution_domain :: Lens' DescribeWorkflowExecution Text Source #

The name of the domain containing the workflow execution.

describeWorkflowExecution_execution :: Lens' DescribeWorkflowExecution WorkflowExecution Source #

The workflow execution to describe.

Destructuring the Response

data DescribeWorkflowExecutionResponse Source #

Contains details about a workflow execution.

See: newDescribeWorkflowExecutionResponse smart constructor.

Constructors

DescribeWorkflowExecutionResponse'

Fields

latestActivityTaskTimestamp :: Maybe POSIX
The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
latestExecutionContext :: Maybe Text
The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.
httpStatus :: Int
The response's http status code.
executionInfo :: WorkflowExecutionInfo
Information about the workflow execution.
executionConfiguration :: WorkflowExecutionConfiguration
The configuration settings for this workflow execution including timeout values, tasklist etc.
openCounts :: WorkflowExecutionOpenCounts
The number of tasks for this workflow execution. This includes open and closed tasks of all types.

Instances

Instances details

Eq DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution Methods (==) :: DescribeWorkflowExecutionResponse -> DescribeWorkflowExecutionResponse -> Bool # (/=) :: DescribeWorkflowExecutionResponse -> DescribeWorkflowExecutionResponse -> Bool #
Read DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution Methods readsPrec :: Int -> ReadS DescribeWorkflowExecutionResponse # readList :: ReadS [DescribeWorkflowExecutionResponse] # readPrec :: ReadPrec DescribeWorkflowExecutionResponse # readListPrec :: ReadPrec [DescribeWorkflowExecutionResponse] #
Show DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution Methods showsPrec :: Int -> DescribeWorkflowExecutionResponse -> ShowS # show :: DescribeWorkflowExecutionResponse -> String # showList :: [DescribeWorkflowExecutionResponse] -> ShowS #
Generic DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution Associated Types type Rep DescribeWorkflowExecutionResponse :: Type -> Type # Methods from :: DescribeWorkflowExecutionResponse -> Rep DescribeWorkflowExecutionResponse x # to :: Rep DescribeWorkflowExecutionResponse x -> DescribeWorkflowExecutionResponse #
NFData DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution Methods rnf :: DescribeWorkflowExecutionResponse -> () #
type Rep DescribeWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.DescribeWorkflowExecution type Rep DescribeWorkflowExecutionResponse = D1 ('MetaData "DescribeWorkflowExecutionResponse" "Amazonka.SWF.DescribeWorkflowExecution" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DescribeWorkflowExecutionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "latestActivityTaskTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "latestExecutionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "executionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowExecutionInfo) :: (S1 ('MetaSel ('Just "executionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowExecutionConfiguration) :*: S1 ('MetaSel ('Just "openCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowExecutionOpenCounts)))))

newDescribeWorkflowExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeWorkflowExecutionResponse'`
-> WorkflowExecutionInfo	`$sel:executionInfo:DescribeWorkflowExecutionResponse'`
-> WorkflowExecutionConfiguration	`$sel:executionConfiguration:DescribeWorkflowExecutionResponse'`
-> WorkflowExecutionOpenCounts	`$sel:openCounts:DescribeWorkflowExecutionResponse'`
-> DescribeWorkflowExecutionResponse

Create a value of DescribeWorkflowExecutionResponse 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:latestActivityTaskTimestamp:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_latestActivityTaskTimestamp - The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

$sel:latestExecutionContext:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_latestExecutionContext - The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

$sel:httpStatus:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_httpStatus - The response's http status code.

$sel:executionInfo:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_executionInfo - Information about the workflow execution.

$sel:executionConfiguration:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_executionConfiguration - The configuration settings for this workflow execution including timeout values, tasklist etc.

$sel:openCounts:DescribeWorkflowExecutionResponse', describeWorkflowExecutionResponse_openCounts - The number of tasks for this workflow execution. This includes open and closed tasks of all types.

Response Lenses

describeWorkflowExecutionResponse_latestActivityTaskTimestamp :: Lens' DescribeWorkflowExecutionResponse (Maybe UTCTime) Source #

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

describeWorkflowExecutionResponse_latestExecutionContext :: Lens' DescribeWorkflowExecutionResponse (Maybe Text) Source #

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

describeWorkflowExecutionResponse_httpStatus :: Lens' DescribeWorkflowExecutionResponse Int Source #

The response's http status code.

describeWorkflowExecutionResponse_executionInfo :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionInfo Source #

Information about the workflow execution.

describeWorkflowExecutionResponse_executionConfiguration :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionConfiguration Source #

The configuration settings for this workflow execution including timeout values, tasklist etc.

describeWorkflowExecutionResponse_openCounts :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionOpenCounts Source #

The number of tasks for this workflow execution. This includes open and closed tasks of all types.