You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SWF::Types::GetWorkflowExecutionHistoryInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass GetWorkflowExecutionHistoryInput data as a 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

Instance Attribute Details

#domainString

The name of the domain containing the workflow execution.

Returns:

  • (String)


2376
2377
2378
2379
2380
2381
2382
2383
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2376

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#executionTypes::WorkflowExecution

Specifies the workflow execution for which to return the history.



2376
2377
2378
2379
2380
2381
2382
2383
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2376

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#maximum_page_sizeInteger

The maximum number of results that are 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.

Returns:

  • (Integer)


2376
2377
2378
2379
2380
2381
2382
2383
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2376

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#next_page_tokenString

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.

Returns:

  • (String)


2376
2377
2378
2379
2380
2381
2382
2383
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2376

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#reverse_orderBoolean

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.

Returns:

  • (Boolean)


2376
2377
2378
2379
2380
2381
2382
2383
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2376

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end