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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListExecutionsInput as input to an Aws::Client method, you can use a vanilla Hash:

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

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) —

    The maximum number of results that are returned per call.

#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) —

    If nextToken is returned, there are more results available.

#state_machine_arn ⇒ String

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

Returns:

  • (String) —

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

#status_filter ⇒ String

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

Possible values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • ABORTED

Returns:

  • (String) —

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