Class: Aws::Transfer::Types::ListAgreementsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of agreements to return.

Returns:

  • (Integer)


3121
3122
3123
3124
3125
3126
3127
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3121

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

#next_tokenString

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

Returns:

  • (String)


3121
3122
3123
3124
3125
3126
3127
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3121

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

#server_idString

The identifier of the server for which you want a list of agreements.

Returns:

  • (String)


3121
3122
3123
3124
3125
3126
3127
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3121

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