Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444219188.6 KB

Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>.

post/#X-Amz-Target=FmrsService.CreateLocationObjectStorage

Headers

X-Amz-Target'FmrsService.CreateLocationObjectStorage' required

Request body

ServerHostnamestring required

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.

ServerPortinteger

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

ServerProtocol'HTTPS' | 'HTTP'

Specifies the protocol that your object storage server uses to communicate.

Subdirectorystring

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.

BucketNamestring required

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

AccessKeystring

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

SecretKeystring password

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

AgentArnsAgentArn[] required

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

ServerCertificatestring
<p>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 <code>.pem</code> file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The certificate can be up to 32768 bytes (before Base64 encoding).</p> <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>

Response

Success

LocationArnstring

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