amazonka-swf-1.3.1: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.GetWorkflowExecutionHistory

Contents

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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: AWS API Reference for GetWorkflowExecutionHistory.

This operation returns paginated results.

Synopsis

Creating a Request

getWorkflowExecutionHistory Source

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:

Request Lenses

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

gwehReverseOrder :: 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.

gwehMaximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural) Source

The maximum number of results that will be 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 Source

The name of the domain containing the workflow execution.

gwehExecution :: Lens' GetWorkflowExecutionHistory WorkflowExecution Source

Specifies the workflow execution for which to return the history.

Destructuring the Response

getWorkflowExecutionHistoryResponse Source

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:

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

Response Lenses

gwehrsNextPageToken :: 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.