DataSync / Client / create_location_object_storage



Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.

See also: AWS API Documentation

Request Syntax

response = client.create_location_object_storage(
            'Key': 'string',
            'Value': 'string'
  • ServerHostname (string) –


    Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.

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

  • BucketName (string) –


    Specifies the name of the object storage bucket involved in the transfer.

  • 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) –

  • Tags (list) –

    Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

    • (dict) –

      A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

      • Key (string) – [REQUIRED]

        The key for an Amazon Web Services resource tag.

      • Value (string) –

        The value for an Amazon Web Services resource tag.

  • ServerCertificate (bytes) –

    Specifies a file with the certificates that are used to sign the object storage server’s certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The file you specify must include the following:

    • The certificate of the signing certificate authority (CA)

    • Any intermediate certificates

    • base64 encoding

    • A .pem extension

    The file can be up to 32768 bytes (before base64 encoding).

    To use this parameter, configure ServerProtocol to HTTPS.

Return type:



Response Syntax

    'LocationArn': 'string'

Response Structure

  • (dict) –


    • LocationArn (string) –

      Specifies the ARN of the object storage system location that you create.


  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException