DescribeLocationObjectStorage
Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
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 self-managed object storage server location that was described.
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",
"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
-
Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use
AccessKey
andSecretKey
to provide the user name and password, respectively.Type: String
Length Constraints: Minimum length of 8. Maximum length of 200.
Pattern:
^.+$
- AgentArns
-
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server 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 self-managed object storage server agent was created.
Type: Timestamp
- LocationArn
-
The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.
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 source self-managed object storage server location that was described.
Type: String
Length Constraints: Maximum length of 4356.
Pattern:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9]+)://[a-zA-Z0-9.:/\-]+$
- ServerPort
-
The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65536.
- ServerProtocol
-
The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
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: