Network.AWS.SWF.GetWorkflowExecutionHistory

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.

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.

Creating a Request

getWorkflowExecutionHistory

Arguments

:: Text

gwehDomain

-> WorkflowExecution

gwehExecution

-> GetWorkflowExecutionHistory

Creates a value of GetWorkflowExecutionHistory with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gwehNextPageToken - 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.
• gwehReverseOrder - 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.
• gwehMaximumPageSize - The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
• gwehDomain - The name of the domain containing the workflow execution.
• gwehExecution - Specifies the workflow execution for which to return the history.

data GetWorkflowExecutionHistory

See: getWorkflowExecutionHistory smart constructor.

Instances

Eq GetWorkflowExecutionHistory

Methods

(==) :: GetWorkflowExecutionHistory -> GetWorkflowExecutionHistory -> Bool

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

Data GetWorkflowExecutionHistory

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetWorkflowExecutionHistory -> c GetWorkflowExecutionHistory

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetWorkflowExecutionHistory

toConstr :: GetWorkflowExecutionHistory -> Constr

dataTypeOf :: GetWorkflowExecutionHistory -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetWorkflowExecutionHistory)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetWorkflowExecutionHistory)

gmapT :: (forall b. Data b => b -> b) -> GetWorkflowExecutionHistory -> GetWorkflowExecutionHistory

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetWorkflowExecutionHistory -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetWorkflowExecutionHistory -> r

gmapQ :: (forall d. Data d => d -> u) -> GetWorkflowExecutionHistory -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetWorkflowExecutionHistory -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistory -> m GetWorkflowExecutionHistory

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistory -> m GetWorkflowExecutionHistory

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistory -> m GetWorkflowExecutionHistory

Read GetWorkflowExecutionHistory

Methods

readsPrec :: Int -> ReadS GetWorkflowExecutionHistory

readList :: ReadS [GetWorkflowExecutionHistory]

readPrec :: ReadPrec GetWorkflowExecutionHistory

readListPrec :: ReadPrec [GetWorkflowExecutionHistory]

Show GetWorkflowExecutionHistory

Methods

showsPrec :: Int -> GetWorkflowExecutionHistory -> ShowS

show :: GetWorkflowExecutionHistory -> String

showList :: [GetWorkflowExecutionHistory] -> ShowS

Generic GetWorkflowExecutionHistory

Associated Types

type Rep GetWorkflowExecutionHistory :: * -> *

Methods

from :: GetWorkflowExecutionHistory -> Rep GetWorkflowExecutionHistory x

to :: Rep GetWorkflowExecutionHistory x -> GetWorkflowExecutionHistory

Hashable GetWorkflowExecutionHistory

Methods

hashWithSalt :: Int -> GetWorkflowExecutionHistory -> Int

hash :: GetWorkflowExecutionHistory -> Int

ToJSON GetWorkflowExecutionHistory

Methods

toJSON :: GetWorkflowExecutionHistory -> Value

toEncoding :: GetWorkflowExecutionHistory -> Encoding

toJSONList :: [GetWorkflowExecutionHistory] -> Value

toEncodingList :: [GetWorkflowExecutionHistory] -> Encoding

NFData GetWorkflowExecutionHistory

Methods

rnf :: GetWorkflowExecutionHistory -> ()

AWSPager GetWorkflowExecutionHistory

Methods

page :: GetWorkflowExecutionHistory -> Rs GetWorkflowExecutionHistory -> Maybe GetWorkflowExecutionHistory

AWSRequest GetWorkflowExecutionHistory

Associated Types

type Rs GetWorkflowExecutionHistory :: *

Methods

request :: GetWorkflowExecutionHistory -> Request GetWorkflowExecutionHistory

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetWorkflowExecutionHistory -> ClientResponse -> m (Response GetWorkflowExecutionHistory)

ToHeaders GetWorkflowExecutionHistory

Methods

toHeaders :: GetWorkflowExecutionHistory -> [Header]

ToPath GetWorkflowExecutionHistory

Methods

toPath :: GetWorkflowExecutionHistory -> ByteString

ToQuery GetWorkflowExecutionHistory

Methods

toQuery :: GetWorkflowExecutionHistory -> QueryString

type Rep GetWorkflowExecutionHistory

type Rep GetWorkflowExecutionHistory = D1 * (MetaData "GetWorkflowExecutionHistory" "Network.AWS.SWF.GetWorkflowExecutionHistory" "amazonka-swf-1.6.0-Bzu8JdnZDC6G5pdcX5JdA8" False) (C1 * (MetaCons "GetWorkflowExecutionHistory'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gwehNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gwehReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gwehMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gwehDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_gwehExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * WorkflowExecution))))))

type Rs GetWorkflowExecutionHistory

type Rs GetWorkflowExecutionHistory = GetWorkflowExecutionHistoryResponse

Request Lenses

gwehNextPageToken :: Lens' GetWorkflowExecutionHistory (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.

gwehReverseOrder :: Lens' GetWorkflowExecutionHistory (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.

gwehMaximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural)

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

gwehDomain :: Lens' GetWorkflowExecutionHistory Text

The name of the domain containing the workflow execution.

gwehExecution :: Lens' GetWorkflowExecutionHistory WorkflowExecution

Specifies the workflow execution for which to return the history.

Destructuring the Response

getWorkflowExecutionHistoryResponse

Arguments

:: Int

gwehrsResponseStatus

-> GetWorkflowExecutionHistoryResponse

Creates a value of GetWorkflowExecutionHistoryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gwehrsNextPageToken - 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.
• gwehrsResponseStatus - -- | The response status code.
• gwehrsEvents - The list of history events.

data GetWorkflowExecutionHistoryResponse

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: getWorkflowExecutionHistoryResponse smart constructor.

Instances

Eq GetWorkflowExecutionHistoryResponse

Methods

(==) :: GetWorkflowExecutionHistoryResponse -> GetWorkflowExecutionHistoryResponse -> Bool

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

Data GetWorkflowExecutionHistoryResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetWorkflowExecutionHistoryResponse -> c GetWorkflowExecutionHistoryResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetWorkflowExecutionHistoryResponse

toConstr :: GetWorkflowExecutionHistoryResponse -> Constr

dataTypeOf :: GetWorkflowExecutionHistoryResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetWorkflowExecutionHistoryResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetWorkflowExecutionHistoryResponse)

gmapT :: (forall b. Data b => b -> b) -> GetWorkflowExecutionHistoryResponse -> GetWorkflowExecutionHistoryResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetWorkflowExecutionHistoryResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetWorkflowExecutionHistoryResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetWorkflowExecutionHistoryResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetWorkflowExecutionHistoryResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistoryResponse -> m GetWorkflowExecutionHistoryResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistoryResponse -> m GetWorkflowExecutionHistoryResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetWorkflowExecutionHistoryResponse -> m GetWorkflowExecutionHistoryResponse

Read GetWorkflowExecutionHistoryResponse

Methods

readsPrec :: Int -> ReadS GetWorkflowExecutionHistoryResponse

readList :: ReadS [GetWorkflowExecutionHistoryResponse]

readPrec :: ReadPrec GetWorkflowExecutionHistoryResponse

readListPrec :: ReadPrec [GetWorkflowExecutionHistoryResponse]

Show GetWorkflowExecutionHistoryResponse

Methods

showsPrec :: Int -> GetWorkflowExecutionHistoryResponse -> ShowS

show :: GetWorkflowExecutionHistoryResponse -> String

showList :: [GetWorkflowExecutionHistoryResponse] -> ShowS

Generic GetWorkflowExecutionHistoryResponse

Associated Types

type Rep GetWorkflowExecutionHistoryResponse :: * -> *

Methods

from :: GetWorkflowExecutionHistoryResponse -> Rep GetWorkflowExecutionHistoryResponse x

to :: Rep GetWorkflowExecutionHistoryResponse x -> GetWorkflowExecutionHistoryResponse

NFData GetWorkflowExecutionHistoryResponse

Methods

rnf :: GetWorkflowExecutionHistoryResponse -> ()

type Rep GetWorkflowExecutionHistoryResponse

type Rep GetWorkflowExecutionHistoryResponse = D1 * (MetaData "GetWorkflowExecutionHistoryResponse" "Network.AWS.SWF.GetWorkflowExecutionHistory" "amazonka-swf-1.6.0-Bzu8JdnZDC6G5pdcX5JdA8" False) (C1 * (MetaCons "GetWorkflowExecutionHistoryResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gwehrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gwehrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_gwehrsEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [HistoryEvent])))))

Response Lenses

gwehrsNextPageToken :: Lens' GetWorkflowExecutionHistoryResponse (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.

gwehrsResponseStatus :: Lens' GetWorkflowExecutionHistoryResponse Int

• - | The response status code.

gwehrsEvents :: Lens' GetWorkflowExecutionHistoryResponse [HistoryEvent]

The list of history events.