AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Container for the parameters to the GetWorkflowExecutionHistory operation. 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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleWorkflow.AmazonSimpleWorkflowRequest
      Amazon.SimpleWorkflow.Model.GetWorkflowExecutionHistoryRequest

Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class GetWorkflowExecutionHistoryRequest : AmazonSimpleWorkflowRequest
         IRequestEvents

The GetWorkflowExecutionHistoryRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Domain System.String Gets and sets the property Domain.

The name of the domain containing the workflow execution.

Public Property Execution Amazon.SimpleWorkflow.Model.WorkflowExecution Gets and sets the property Execution.

Specifies the workflow execution for which to return the history.

Public Property MaximumPageSize System.Int32 Gets and sets the property MaximumPageSize.

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.

Public Property NextPageToken System.String Gets and sets the property 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.

Public Property ReverseOrder System.Boolean Gets and sets the property 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8