DataSync / Client / update_location_object_storage

update_location_object_storage#

DataSync.Client.update_location_object_storage(**kwargs)#

Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.

See also: AWS API Documentation

Request Syntax

response = client.update_location_object_storage(
    LocationArn='string',
    ServerPort=123,
    ServerProtocol='HTTPS'|'HTTP',
    Subdirectory='string',
    AccessKey='string',
    SecretKey='string',
    AgentArns=[
        'string',
    ],
    ServerCertificate=b'bytes'
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

    Specifies the ARN of the object storage system location that you’re updating.

  • ServerPort (integer) – Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

  • ServerProtocol (string) – Specifies the protocol that your object storage server uses to communicate.

  • Subdirectory (string) – Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

  • AccessKey (string) – Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

  • SecretKey (string) – Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

  • AgentArns (list) –

    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

    • (string) –

  • ServerCertificate (bytes) –

    Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

    To use this parameter, configure ServerProtocol to HTTPS.

    Updating the certificate doesn’t interfere with tasks that you have in progress.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException