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

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: "PageToken",
}

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 100. 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)


1178
1179
1180
1181
1182
1183
1184
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1178

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

#next_tokenString

If a nextToken is 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 nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

Returns:

  • (String)


1178
1179
1180
1181
1182
1183
1184
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1178

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

#state_machine_arnString

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

Returns:

  • (String)


1178
1179
1180
1181
1182
1183
1184
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1178

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

#status_filterString

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

Returns:

  • (String)


1178
1179
1180
1181
1182
1183
1184
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1178

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