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

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::ListAgreementsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of agreements to return.

• #next_token ⇒ String

  When you can get additional results from the ‘ListAgreements` call, a `NextToken` parameter is returned in the output.

• #server_id ⇒ String

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

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of agreements to return.

Returns:

• (Integer)

# File 'lib/aws-sdk-transfer/types.rb', line 3613

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

#next_token ⇒ String

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)

# File 'lib/aws-sdk-transfer/types.rb', line 3613

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

#server_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3613

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