Transfer / Client / update_agreement

update_agreement#

Transfer.Client.update_agreement(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_agreement(
    AgreementId='string',
    ServerId='string',
    Description='string',
    Status='ACTIVE'|'INACTIVE',
    LocalProfileId='string',
    PartnerProfileId='string',
    BaseDirectory='string',
    AccessRole='string'
)
Parameters:

  • AgreementId (string) –

    [REQUIRED]

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

  • ServerId (string) –

    [REQUIRED]

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

  • Description (string) – To replace the existing description, provide a short description for the agreement.

  • Status (string) – You can update the status for the agreement, either activating an inactive agreement or the reverse.

  • LocalProfileId (string) –

    A unique identifier for the AS2 local profile.

    To change the local profile identifier, provide a new value here.

  • PartnerProfileId (string) – A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

  • BaseDirectory (string) – To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, ``/DOC-EXAMPLE-BUCKET/home/mydirectory ``.

  • AccessRole (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'AgreementId': 'string'
}

Response Structure

  • (dict) –

    • AgreementId (string) –

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

Exceptions