You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SWF::Types::GetWorkflowExecutionHistoryInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::GetWorkflowExecutionHistoryInput
- Defined in:
- (unknown)
Overview
When passing GetWorkflowExecutionHistoryInput as input to an Aws::Client method, you can use a vanilla Hash:
{
domain: "DomainName", # required
execution: { # required
workflow_id: "WorkflowId", # required
run_id: "WorkflowRunId", # required
},
next_page_token: "PageToken",
maximum_page_size: 1,
reverse_order: false,
}
Instance Attribute Summary collapse
-
#domain ⇒ String
The name of the domain containing the workflow execution.
-
#execution ⇒ Types::WorkflowExecution
Specifies the workflow execution for which to return the history.
-
#maximum_page_size ⇒ Integer
The maximum number of results that are returned per call.
-
#next_page_token ⇒ String
If
NextPageToken
is returned there are more results available. -
#reverse_order ⇒ Boolean
When set to
true
, returns the events in reverse order.
Instance Attribute Details
#domain ⇒ String
The name of the domain containing the workflow execution.
#execution ⇒ Types::WorkflowExecution
Specifies the workflow execution for which to return the history.
#maximum_page_size ⇒ Integer
The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.
#next_page_token ⇒ String
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
60 seconds. 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.
#reverse_order ⇒ Boolean
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.