Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SWF.GetWorkflowExecutionHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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.

This operation returns paginated results.

Synopsis

Creating a Request

data GetWorkflowExecutionHistory Source #

See: newGetWorkflowExecutionHistory smart constructor.

Constructors

GetWorkflowExecutionHistory'

Fields

maximumPageSize :: Maybe Natural
The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
nextPageToken :: Maybe Text
If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
reverseOrder :: Maybe Bool
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
domain :: Text
The name of the domain containing the workflow execution.
execution :: WorkflowExecution
Specifies the workflow execution for which to return the history.

Instances

Instances details

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

newGetWorkflowExecutionHistory Source #

Arguments

:: Text	`$sel:domain:GetWorkflowExecutionHistory'`
-> WorkflowExecution	`GetWorkflowExecutionHistory`
-> GetWorkflowExecutionHistory

Create a value of GetWorkflowExecutionHistory 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:maximumPageSize:GetWorkflowExecutionHistory', getWorkflowExecutionHistory_maximumPageSize - The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

GetWorkflowExecutionHistory, getWorkflowExecutionHistory_nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

$sel:reverseOrder:GetWorkflowExecutionHistory', getWorkflowExecutionHistory_reverseOrder - When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

$sel:domain:GetWorkflowExecutionHistory', getWorkflowExecutionHistory_domain - The name of the domain containing the workflow execution.

GetWorkflowExecutionHistory, getWorkflowExecutionHistory_execution - Specifies the workflow execution for which to return the history.

Request Lenses

getWorkflowExecutionHistory_maximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

getWorkflowExecutionHistory_nextPageToken :: Lens' GetWorkflowExecutionHistory (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

getWorkflowExecutionHistory_reverseOrder :: Lens' GetWorkflowExecutionHistory (Maybe Bool) Source #

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

getWorkflowExecutionHistory_domain :: Lens' GetWorkflowExecutionHistory Text Source #

The name of the domain containing the workflow execution.

getWorkflowExecutionHistory_execution :: Lens' GetWorkflowExecutionHistory WorkflowExecution Source #

Specifies the workflow execution for which to return the history.

Destructuring the Response

data GetWorkflowExecutionHistoryResponse Source #

Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

See: newGetWorkflowExecutionHistoryResponse smart constructor.

Constructors

GetWorkflowExecutionHistoryResponse'

Fields

nextPageToken :: Maybe Text
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
httpStatus :: Int
The response's http status code.
events :: [HistoryEvent]
The list of history events.

Instances

Instances details

Generic GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory Associated Types type Rep GetWorkflowExecutionHistoryResponse :: Type -> Type # Methods from :: GetWorkflowExecutionHistoryResponse -> Rep GetWorkflowExecutionHistoryResponse x # to :: Rep GetWorkflowExecutionHistoryResponse x -> GetWorkflowExecutionHistoryResponse #
Read GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory Methods readsPrec :: Int -> ReadS GetWorkflowExecutionHistoryResponse # readList :: ReadS [GetWorkflowExecutionHistoryResponse] # readPrec :: ReadPrec GetWorkflowExecutionHistoryResponse # readListPrec :: ReadPrec [GetWorkflowExecutionHistoryResponse] #
Show GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory Methods showsPrec :: Int -> GetWorkflowExecutionHistoryResponse -> ShowS # show :: GetWorkflowExecutionHistoryResponse -> String # showList :: [GetWorkflowExecutionHistoryResponse] -> ShowS #
NFData GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory Methods rnf :: GetWorkflowExecutionHistoryResponse -> () #
Eq GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory Methods (==) :: GetWorkflowExecutionHistoryResponse -> GetWorkflowExecutionHistoryResponse -> Bool # (/=) :: GetWorkflowExecutionHistoryResponse -> GetWorkflowExecutionHistoryResponse -> Bool #
type Rep GetWorkflowExecutionHistoryResponse Source #
Instance details Defined in Amazonka.SWF.GetWorkflowExecutionHistory type Rep GetWorkflowExecutionHistoryResponse = D1 ('MetaData "GetWorkflowExecutionHistoryResponse" "Amazonka.SWF.GetWorkflowExecutionHistory" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "GetWorkflowExecutionHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HistoryEvent]))))

newGetWorkflowExecutionHistoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetWorkflowExecutionHistoryResponse'`
-> GetWorkflowExecutionHistoryResponse

Create a value of GetWorkflowExecutionHistoryResponse 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:

GetWorkflowExecutionHistory, getWorkflowExecutionHistoryResponse_nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

$sel:httpStatus:GetWorkflowExecutionHistoryResponse', getWorkflowExecutionHistoryResponse_httpStatus - The response's http status code.

$sel:events:GetWorkflowExecutionHistoryResponse', getWorkflowExecutionHistoryResponse_events - The list of history events.

Response Lenses

getWorkflowExecutionHistoryResponse_nextPageToken :: Lens' GetWorkflowExecutionHistoryResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

getWorkflowExecutionHistoryResponse_httpStatus :: Lens' GetWorkflowExecutionHistoryResponse Int Source #

The response's http status code.

getWorkflowExecutionHistoryResponse_events :: Lens' GetWorkflowExecutionHistoryResponse [HistoryEvent] Source #

The list of history events.