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.

Class: Aws::States::Types::ListExecutionsInput

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

Overview

Note:

When making an API call, you may pass ListExecutionsInput data as a hash:

{
  state_machine_arn: "Arn", # required
  status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED
  max_results: 1,
  next_token: "ListExecutionsPageToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

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

Returns:

  • (Integer)


1747
1748
1749
1750
1751
1752
1753
1754
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1747

class ListExecutionsInput < Struct.new(
  :state_machine_arn,
  :status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error.

Returns:

  • (String)


1747
1748
1749
1750
1751
1752
1753
1754
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1747

class ListExecutionsInput < Struct.new(
  :state_machine_arn,
  :status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#state_machine_arnString

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Returns:

  • (String)


1747
1748
1749
1750
1751
1752
1753
1754
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1747

class ListExecutionsInput < Struct.new(
  :state_machine_arn,
  :status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#status_filterString

If specified, only list the executions whose current execution status matches the given filter.

Returns:

  • (String)


1747
1748
1749
1750
1751
1752
1753
1754
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1747

class ListExecutionsInput < Struct.new(
  :state_machine_arn,
  :status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end