Class: Aws::SWF::Types::PollForDecisionTaskInput

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

The name of the domain containing the task lists to poll.

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  SENSITIVE = []
  include Aws::Structure
end

#identityString

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  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.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:

  • (Integer)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  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 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.

<note markdown=“1”> The ‘nextPageToken` returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the `nextPageToken`) to retrieve the next page of history records. Calling PollForDecisionTask with a `nextPageToken` doesn’t return a new decision task.

</note>

Returns:

  • (String)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  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)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  SENSITIVE = []
  include Aws::Structure
end

#start_at_previous_started_eventBoolean

When set to ‘true`, returns the events with `eventTimestamp` greater than or equal to `eventTimestamp` of the most recent `DecisionTaskStarted` event. By default, this parameter is set to `false`.

Returns:

  • (Boolean)


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  SENSITIVE = []
  include Aws::Structure
end

#task_listTypes::TaskList

Specifies the task list to poll for decision tasks.

The specified string must not contain a ‘:` (colon), `/` (slash), `|` (vertical bar), or any control characters (`u0000-u001f` | `u007f-u009f`). Also, it must not be the literal string `arn`.

Returns:



3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/aws-sdk-swf/types.rb', line 3452

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order,
  :start_at_previous_started_event)
  SENSITIVE = []
  include Aws::Structure
end