Class: Aws::Transfer::Types::UpdateAgreementRequest

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

#access_roleString

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#agreement_idString

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

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#base_directoryString

To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#descriptionString

To replace the existing description, provide a short description for the agreement.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#local_profile_idString

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#partner_profile_idString

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#server_idString

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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

#statusString

You can update the status for the agreement, either activating an inactive agreement or the reverse.

Returns:

  • (String)


4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4967

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