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

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::ListedAgreement

Defined in:

gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Describes the properties of an agreement.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #agreement_id ⇒ String

  A unique identifier for the agreement.

• #arn ⇒ String

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

• #description ⇒ String

  The current description for the agreement.

• #local_profile_id ⇒ String

  A unique identifier for the AS2 local profile.

• #partner_profile_id ⇒ String

  A unique identifier for the partner profile.

• #server_id ⇒ String

  The unique identifier for the agreement.

• #status ⇒ String

  The agreement can be either ACTIVE or INACTIVE.

Instance Attribute Details

#agreement_id ⇒ String

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

Returns:

• (String)

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

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

#arn ⇒ String

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

Returns:

• (String)

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

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

#description ⇒ String

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

Returns:

• (String)

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

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

#local_profile_id ⇒ String

A unique identifier for the AS2 local profile.

Returns:

• (String)

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

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

#partner_profile_id ⇒ String

A unique identifier for the partner profile.

Returns:

• (String)

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

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

#server_id ⇒ String

The unique identifier for the agreement.

Returns:

• (String)

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

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

#status ⇒ String

The agreement can be either ACTIVE or INACTIVE.

Returns:

• (String)

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

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