Class: Aws::Transfer::Types::ListExecutionsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

Specifies the maximum number of executions to return.

Returns:

  • (Integer) 


3751
3752
3753
3754
3755
3756
3757
 
# File 'lib/aws-sdk-transfer/types.rb', line 3751

class ListExecutionsRequest < Struct.new(
  :max_results,
  :next_token,
  :workflow_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

‘ListExecutions` returns the `NextToken` parameter in the output. You can then pass the `NextToken` parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the ‘max-results`:

‘aws transfer list-executions –max-results 10`

This returns details for the first 10 executions, as well as the pointer (‘NextToken`) to the eleventh execution. You can now call the API again, supplying the `NextToken` value you received:

‘aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult`

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Returns:

  • (String) 


3751
3752
3753
3754
3755
3756
3757
 
# File 'lib/aws-sdk-transfer/types.rb', line 3751

class ListExecutionsRequest < Struct.new(
  :max_results,
  :next_token,
  :workflow_id)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

A unique identifier for the workflow.

Returns:

  • (String) 


3751
3752
3753
3754
3755
3756
3757
 
# File 'lib/aws-sdk-transfer/types.rb', line 3751

class ListExecutionsRequest < Struct.new(
  :max_results,
  :next_token,
  :workflow_id)
  SENSITIVE = []
  include Aws::Structure
end