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

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::ListExecutionsInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #map_run_arn ⇒ String

  The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.

• #max_results ⇒ Integer

  The maximum number of results that are returned per call.

• #next_token ⇒ String

  If ‘nextToken` is returned, there are more results available.

• #redrive_filter ⇒ String

  Sets a filter to list executions based on whether or not they have been redriven.

• #state_machine_arn ⇒ 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.

Instance Attribute Details

#map_run_arn ⇒ String

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the ‘mapRunArn` field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see [Examining Map Run] in the *Step Functions Developer Guide*.

You can specify either a ‘mapRunArn` or a `stateMachineArn`, but not both.

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 2358

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

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

# File 'lib/aws-sdk-states/types.rb', line 2358

class ListExecutionsInput < Struct.new(
  :state_machine_arn,
  :status_filter,
  :max_results,
  :next_token,
  :map_run_arn,
  :redrive_filter)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-states/types.rb', line 2358

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

#redrive_filter ⇒ String

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, ‘redriveFilter` sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a ‘redriveFilter`, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in ‘redriveFilter`, the API returns a validation exception.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 2358

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

#state_machine_arn ⇒ String

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

You can specify either a ‘mapRunArn` or a `stateMachineArn`, but not both.

You can also return a list of executions associated with a specific

alias][1

or [version], by specifying an alias ARN or a version

ARN in the ‘stateMachineArn` parameter.

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 2358

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

#status_filter ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 2358

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