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.

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.

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
• gwehReverseOrder
• gwehMaximumPageSize
• gwehDomain
• gwehExecution

data GetWorkflowExecutionHistory

See: getWorkflowExecutionHistory smart constructor.

Instances

Eq GetWorkflowExecutionHistory

Data GetWorkflowExecutionHistory

Read GetWorkflowExecutionHistory

Show GetWorkflowExecutionHistory

Generic GetWorkflowExecutionHistory

ToJSON GetWorkflowExecutionHistory

AWSPager GetWorkflowExecutionHistory

AWSRequest GetWorkflowExecutionHistory

ToPath GetWorkflowExecutionHistory

ToHeaders GetWorkflowExecutionHistory

ToQuery GetWorkflowExecutionHistory

Typeable * GetWorkflowExecutionHistory

type Rep 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 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

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

gwehrsStatus

-> 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
• gwehrsStatus
• gwehrsEvents

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

Data GetWorkflowExecutionHistoryResponse

Read GetWorkflowExecutionHistoryResponse

Show GetWorkflowExecutionHistoryResponse

Generic GetWorkflowExecutionHistoryResponse

Typeable * GetWorkflowExecutionHistoryResponse

type Rep GetWorkflowExecutionHistoryResponse

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.

gwehrsStatus :: Lens' GetWorkflowExecutionHistoryResponse Int

The response status code.

gwehrsEvents :: Lens' GetWorkflowExecutionHistoryResponse [HistoryEvent]

The list of history events.