On December 7, 2023, we discontinued 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 or delete them if they aren't in use. If you need more help, contact AWS Support
DescribeLocationFsxWindows
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
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 FSx for Windows File 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}$Required: Yes
Response Syntax
{
"CreationTime": number,
"Domain": "string",
"LocationArn": "string",
"LocationUri": "string",
"SecurityGroupArns": [ "string" ],
"User": "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.
- CreationTime
-
The time that the FSx for Windows File Server location was created.
Type: Timestamp
- Domain
-
The name of the Windows domain that the FSx for Windows File Server belongs to.
Type: String
Length Constraints: Maximum length of 253.
Pattern:
^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$ - LocationArn
-
The Amazon Resource Name (ARN) of the FSx for Windows File 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}$ - LocationUri
-
The URL of the FSx for Windows File Server location that was described.
Type: String
Length Constraints: Maximum length of 4360.
Pattern:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ - SecurityGroupArns
-
The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$ - User
-
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
Type: String
Length Constraints: Maximum length of 104.
Pattern:
^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
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:
