/AWS1/CL_TRNDESCRIBEDAGREEMENT

Describes the properties of an agreement.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/TRNARN /AWS1/TRNARN

The unique Amazon Resource Name (ARN) for the agreement.

Optional arguments:

iv_agreementid TYPE /AWS1/TRNAGREEMENTID /AWS1/TRNAGREEMENTID

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

iv_description TYPE /AWS1/TRNDESCRIPTION /AWS1/TRNDESCRIPTION

The name or short description that's used to identify the agreement.

iv_status TYPE /AWS1/TRNAGREEMENTSTATUSTYPE /AWS1/TRNAGREEMENTSTATUSTYPE

The current status of the agreement, either ACTIVE or INACTIVE.

iv_serverid TYPE /AWS1/TRNSERVERID /AWS1/TRNSERVERID

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

iv_localprofileid TYPE /AWS1/TRNPROFILEID /AWS1/TRNPROFILEID

A unique identifier for the AS2 local profile.

iv_partnerprofileid TYPE /AWS1/TRNPROFILEID /AWS1/TRNPROFILEID

A unique identifier for the partner profile used in the agreement.

iv_basedirectory TYPE /AWS1/TRNHOMEDIRECTORY /AWS1/TRNHOMEDIRECTORY

The landing directory (folder) for files that are transferred by using the AS2 protocol.

iv_accessrole TYPE /AWS1/TRNROLE /AWS1/TRNROLE

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

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.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

it_tags TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS

Key-value pairs that can be used to group and search for agreements.

iv_preservefilename TYPE /AWS1/TRNPRESERVEFILENAMETYPE /AWS1/TRNPRESERVEFILENAMETYPE

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED: the filename provided by your trading parter is preserved when the file is saved.

• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

iv_enforcemessagesigning TYPE /AWS1/TRNENFORCEMSGSIGNINGTYPE /AWS1/TRNENFORCEMSGSIGNINGTYPE

Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED: Transfer Family rejects unsigned messages from your trading partner.

• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

io_customdirectories TYPE REF TO /AWS1/CL_TRNCUSTDIRECTORIEST00 /AWS1/CL_TRNCUSTDIRECTORIEST00

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files

• MDN files

• Payload files

• Status files

• Temporary files

---

Queryable Attributes

Arn

The unique Amazon Resource Name (ARN) for the agreement.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

AgreementId

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

Accessible with the following methods

Method	Description
GET_AGREEMENTID()	Getter for AGREEMENTID, with configurable default
ASK_AGREEMENTID()	Getter for AGREEMENTID w/ exceptions if field has no value
HAS_AGREEMENTID()	Determine if AGREEMENTID has a value

Description

The name or short description that's used to identify the agreement.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Status

The current status of the agreement, either ACTIVE or INACTIVE.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

ServerId

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

Accessible with the following methods

Method	Description
GET_SERVERID()	Getter for SERVERID, with configurable default
ASK_SERVERID()	Getter for SERVERID w/ exceptions if field has no value
HAS_SERVERID()	Determine if SERVERID has a value

LocalProfileId

A unique identifier for the AS2 local profile.

Accessible with the following methods

Method	Description
GET_LOCALPROFILEID()	Getter for LOCALPROFILEID, with configurable default
ASK_LOCALPROFILEID()	Getter for LOCALPROFILEID w/ exceptions if field has no valu
HAS_LOCALPROFILEID()	Determine if LOCALPROFILEID has a value

PartnerProfileId

A unique identifier for the partner profile used in the agreement.

Accessible with the following methods

Method	Description
GET_PARTNERPROFILEID()	Getter for PARTNERPROFILEID, with configurable default
ASK_PARTNERPROFILEID()	Getter for PARTNERPROFILEID w/ exceptions if field has no va
HAS_PARTNERPROFILEID()	Determine if PARTNERPROFILEID has a value

BaseDirectory

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Accessible with the following methods

Method	Description
GET_BASEDIRECTORY()	Getter for BASEDIRECTORY, with configurable default
ASK_BASEDIRECTORY()	Getter for BASEDIRECTORY w/ exceptions if field has no value
HAS_BASEDIRECTORY()	Determine if BASEDIRECTORY has a value

AccessRole

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

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.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

Accessible with the following methods

Method	Description
GET_ACCESSROLE()	Getter for ACCESSROLE, with configurable default
ASK_ACCESSROLE()	Getter for ACCESSROLE w/ exceptions if field has no value
HAS_ACCESSROLE()	Determine if ACCESSROLE has a value

Tags

Key-value pairs that can be used to group and search for agreements.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

PreserveFilename

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED: the filename provided by your trading parter is preserved when the file is saved.

• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

Accessible with the following methods

Method	Description
GET_PRESERVEFILENAME()	Getter for PRESERVEFILENAME, with configurable default
ASK_PRESERVEFILENAME()	Getter for PRESERVEFILENAME w/ exceptions if field has no va
HAS_PRESERVEFILENAME()	Determine if PRESERVEFILENAME has a value

EnforceMessageSigning

Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED: Transfer Family rejects unsigned messages from your trading partner.

• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

Accessible with the following methods

Method	Description
GET_ENFORCEMESSAGESIGNING()	Getter for ENFORCEMESSAGESIGNING, with configurable default
ASK_ENFORCEMESSAGESIGNING()	Getter for ENFORCEMESSAGESIGNING w/ exceptions if field has
HAS_ENFORCEMESSAGESIGNING()	Determine if ENFORCEMESSAGESIGNING has a value

CustomDirectories

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files

• MDN files

• Payload files

• Status files

• Temporary files

Accessible with the following methods

Method	Description
GET_CUSTOMDIRECTORIES()	Getter for CUSTOMDIRECTORIES