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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

The name of the domain containing the workflow execution.

Returns:

  • (String)


2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2487

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

#executionTypes::WorkflowExecution

Specifies the workflow execution for which to return the history.



2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2487

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

#maximum_page_sizeInteger

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Returns:

  • (Integer)


2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2487

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

#next_page_tokenString

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.

Returns:

  • (String)


2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2487

class GetWorkflowExecutionHistoryInput < Struct.new(
  :domain,
  :execution,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  SENSITIVE = []
  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)


2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 2487

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