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

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

Overview

Note:

When making an API call, you may pass ListExecutionsRequest data as a hash:

{
  max_results: 1,
  next_token: "NextToken",
  workflow_id: "WorkflowId", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Specifies the aximum number of executions to return.

Returns:

  • (Integer)


2400
2401
2402
2403
2404
2405
2406
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2400

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

#next_tokenString

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, callthe API by specifing 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, suppling 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)


2400
2401
2402
2403
2404
2405
2406
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2400

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

#workflow_idString

A unique identifier for the workflow.

Returns:

  • (String)


2400
2401
2402
2403
2404
2405
2406
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2400

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