AWS SDK for .NET Documentation
GetWorkflowExecutionHistoryRequest Class
AmazonAmazon.SimpleWorkflow.ModelGetWorkflowExecutionHistoryRequest Did this page help you?   Yes   No    Tell us about it...
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.

NOTE: 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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Declaration Syntax
C#
public class GetWorkflowExecutionHistoryRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
GetWorkflowExecutionHistoryRequest()()()()
Initializes a new instance of the GetWorkflowExecutionHistoryRequest class

Domain
The name of the domain containing the workflow execution.

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Execution
Specifies the workflow execution for which to return the history.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
MaximumPageSize
Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:

Range
0 - 1000


NextPageToken
If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

Constraints:

Length
0 - 2048


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.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithDomain(String) Obsolete.
Sets the Domain property

WithExecution(WorkflowExecution) Obsolete.
Sets the Execution property

WithMaximumPageSize(Int32) Obsolete.
Sets the MaximumPageSize property

WithNextPageToken(String) Obsolete.
Sets the NextPageToken property

WithReverseOrder(Boolean) Obsolete.
Sets the ReverseOrder property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 GetWorkflowExecutionHistoryRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)