Class: Aws::Transfer::Types::DescribedAgreement
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::DescribedAgreement
- 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
-
#access_role ⇒ String
With AS2, you can send files by calling
StartFileTransfer
and specifying the file paths in the request parameter,SendFilePaths
. -
#agreement_id ⇒ String
A unique identifier for the agreement.
-
#arn ⇒ String
The unique Amazon Resource Name (ARN) for the agreement.
-
#base_directory ⇒ String
The landing directory (folder) for files that are transferred by using the AS2 protocol.
-
#description ⇒ String
The name or short description that's used to identify 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 used in the agreement.
-
#server_id ⇒ String
A system-assigned unique identifier for a server instance.
-
#status ⇒ String
The current status of the agreement, either
ACTIVE
orINACTIVE
. -
#tags ⇒ Array<Types::Tag>
Key-value pairs that can be used to group and search for agreements.
Instance Attribute Details
#access_role ⇒ String
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
.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#agreement_id ⇒ String
A unique identifier for the agreement. This identifier is returned when you create an agreement.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The unique Amazon Resource Name (ARN) for the agreement.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#base_directory ⇒ String
The landing directory (folder) for files that are transferred by using the AS2 protocol.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The name or short description that's used to identify the agreement.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#local_profile_id ⇒ String
A unique identifier for the AS2 local profile.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#partner_profile_id ⇒ String
A unique identifier for the partner profile used in the agreement.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#server_id ⇒ String
A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the agreement, either ACTIVE
or INACTIVE
.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Key-value pairs that can be used to group and search for agreements.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1776 class DescribedAgreement < Struct.new( :arn, :agreement_id, :description, :status, :server_id, :local_profile_id, :partner_profile_id, :base_directory, :access_role, :tags) SENSITIVE = [] include Aws::Structure end |