Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the Agents page on the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact AWS Support
CreateLocationObjectStorage
Creates an endpoint for an object storage system that AWS DataSync can access for a transfer. For more information, see Creating a location for object storage.
Request Syntax
{
"AccessKey": "string
",
"AgentArns": [ "string
" ],
"BucketName": "string
",
"SecretKey": "string
",
"ServerCertificate": blob
,
"ServerHostname": "string
",
"ServerPort": number
,
"ServerProtocol": "string
",
"Subdirectory": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccessKey
-
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^.+$
Required: No
- AgentArns
-
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$
Required: Yes
- BucketName
-
Specifies the name of the object storage bucket involved in the transfer.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
Required: Yes
- SecretKey
-
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Pattern:
^.*$
Required: No
- ServerCertificate
-
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
toHTTPS
.Type: Base64-encoded binary data object
Length Constraints: Maximum length of 32768.
Required: No
-
- ServerHostname
-
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.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
Required: Yes
- ServerPort
-
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65536.
Required: No
- ServerProtocol
-
Specifies the protocol that your object storage server uses to communicate.
Type: String
Valid Values:
HTTPS | HTTP
Required: No
- Subdirectory
-
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.
Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$
Required: No
- Tags
-
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.
Type: Array of TagListEntry objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"LocationArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LocationArn
-
Specifies the ARN of the object storage system location that you create.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: