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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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: "PageToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

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) 


1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/aws-sdk-states/types.rb', line 1224

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

#next_token ⇒ String

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) 


1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/aws-sdk-states/types.rb', line 1224

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

#state_machine_arn ⇒ String

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

Returns:

  • (String) 


1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/aws-sdk-states/types.rb', line 1224

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

#status_filter ⇒ String

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

Returns:

  • (String) 


1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/aws-sdk-states/types.rb', line 1224

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