Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458293303.1 KB

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

post/#X-Amz-Target=TransferService.CreateAgreement

Headers

X-Amz-Target'TransferService.CreateAgreement' required

Request body

Descriptionstring

A name or short description to identify the agreement.

ServerIdstring required

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

LocalProfileIdstring required

A unique identifier for the AS2 local profile.

PartnerProfileIdstring required

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

BaseDirectorystring required
<p>The landing directory (folder) for files transferred by using the AS2 protocol.</p> <p>A <code>BaseDirectory</code> example is <code>/DOC-EXAMPLE-BUCKET/home/mydirectory</code>.</p>
AccessRolestring required

With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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 <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.

Status'ACTIVE' | 'INACTIVE'

The status of the agreement. The agreement can be either <code>ACTIVE</code> or <code>INACTIVE</code>.

Response

Success

AgreementIdstring required

The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.