Class: Aws::Transfer::Types::ListedAgreement

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

Overview

Describes the properties of an agreement.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agreement_idString

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the specified agreement.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#local_profile_idString

A unique identifier for the AS2 local profile.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#partner_profile_idString

A unique identifier for the partner profile.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#server_idString

The unique identifier for the agreement.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The agreement can be either ACTIVE or INACTIVE.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3722

class ListedAgreement < Struct.new(
  :arn,
  :agreement_id,
  :description,
  :status,
  :server_id,
  :local_profile_id,
  :partner_profile_id)
  SENSITIVE = []
  include Aws::Structure
end