v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458293303.1 KB

Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.

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

Headers

X-Amz-Target'TransferService.UpdateAgreement' required

Request body

AgreementIdstring required

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

ServerIdstring required

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

Descriptionstring

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

Status'ACTIVE' | 'INACTIVE'

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

LocalProfileIdstring
<p>A unique identifier for the AS2 local profile.</p> <p>To change the local profile identifier, provide a new value here.</p>
PartnerProfileIdstring

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

BaseDirectorystring

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

AccessRolestring

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>.

Response

Success

AgreementIdstring required

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