AWS SDK Version 3 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.

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

Inheritance Hierarchy

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

Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z

Syntax

C#
public class GetWorkflowExecutionHistoryRequest : AmazonSimpleWorkflowRequest
         IAmazonWebServiceRequest

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 are returned per call. Use nextPageToken to obtain further pages of results.

Public Property NextPageToken System.String

Gets and sets the property NextPageToken.

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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