DataSync / Client / describe_location_fsx_windows

describe_location_fsx_windows#

DataSync.Client.describe_location_fsx_windows(**kwargs)#

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

Request Syntax

response = client.describe_location_fsx_windows(
    LocationArn='string'
)

Parameters:

LocationArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'SecurityGroupArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1),
    'User': 'string',
    'Domain': 'string'
}

Response Structure

(dict) –
- LocationArn (string) –
  
  The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.
- LocationUri (string) –
  
  The URL of the FSx for Windows File Server location that was described.
- SecurityGroupArns (list) –
  
  The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.
  - (string) –
- CreationTime (datetime) –
  
  The time that the FSx for Windows File Server location was created.
- User (string) –
  
  The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
- Domain (string) –
  
  The name of the Windows domain that the FSx for Windows File Server belongs to.

Exceptions

DataSync.Client.exceptions.InvalidRequestException
DataSync.Client.exceptions.InternalException