Documentation

Describes the properties of an agreement.

See: newDescribedAgreement smart constructor.

Create a value of DescribedAgreement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessRole:DescribedAgreement', describedAgreement_accessRole - 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.

$sel:agreementId:DescribedAgreement', describedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

$sel:baseDirectory:DescribedAgreement', describedAgreement_baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol.

$sel:description:DescribedAgreement', describedAgreement_description - The name or short description that's used to identify the agreement.

$sel:localProfileId:DescribedAgreement', describedAgreement_localProfileId - A unique identifier for the AS2 local profile.

$sel:partnerProfileId:DescribedAgreement', describedAgreement_partnerProfileId - A unique identifier for the partner profile used in the agreement.

$sel:serverId:DescribedAgreement', describedAgreement_serverId - A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

$sel:status:DescribedAgreement', describedAgreement_status - The current status of the agreement, either ACTIVE or INACTIVE.

$sel:tags:DescribedAgreement', describedAgreement_tags - Key-value pairs that can be used to group and search for agreements.

$sel:arn:DescribedAgreement', describedAgreement_arn - The unique Amazon Resource Name (ARN) for the agreement.

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.

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

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

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

A unique identifier for the AS2 local profile.

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

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

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

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

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