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

Class: Aws::SFN::Types::ListExecutionsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sfn/lib/aws-sdk-sfn/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 will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

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

Returns:

  • (Integer)


938
939
940
941
942
943
944
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 938

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

#next_tokenString

If a nextToken was 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)


938
939
940
941
942
943
944
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 938

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 will be listed.

Returns:

  • (String)


938
939
940
941
942
943
944
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 938

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)


938
939
940
941
942
943
944
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 938

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