DescribeLocationObjectStorage
Returns metadata about your AWS DataSync location for an object storage system.
Request Syntax
{
"LocationArn": "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.
- LocationArn
-
The Amazon Resource Name (ARN) of the object storage system location that you want information about.
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}$Required: Yes
Response Syntax
{
"AccessKey": "string",
"AgentArns": [ "string" ],
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"ServerCertificate": blob,
"ServerPort": number,
"ServerProtocol": "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.
- AccessKey
-
The access key (for example, a user name) required to authenticate with the object storage system.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^.+$ - AgentArns
-
The 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}$ - CreationTime
-
The time that the location was created.
Type: Timestamp
- LocationArn
-
The ARN of the object storage system location.
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}$ - LocationUri
-
The URL of the object storage system location.
Type: String
Length Constraints: Maximum length of 4360.
Pattern:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ - ServerCertificate
-
The self-signed certificate that DataSync uses to securely authenticate with your object storage system.
Type: Base64-encoded binary data object
Length Constraints: Maximum length of 32768.
- ServerPort
-
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.
- ServerProtocol
-
The protocol that your object storage system uses to communicate.
Type: String
Valid Values:
HTTPS | HTTP
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:
