DataSync / Client / describe_location_fsx_windows

describe_location_fsx_windows#

DataSync.Client.describe_location_fsx_windows(**kwargs)#

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

Request Syntax

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

Parameters:

LocationArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

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 ARN of the FSx for Windows File Server location.
- LocationUri (string) –
  
  The uniform resource identifier (URI) of the FSx for Windows File Server location.
- SecurityGroupArns (list) –
  
  The ARNs of the Amazon EC2 security groups that provide access to your file system’s preferred subnet.
  
  For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide.
  - (string) –
- CreationTime (datetime) –
  
  The time that the FSx for Windows File Server location was created.
- User (string) –
  
  The user with the permissions to mount and access the FSx for Windows File Server file system.
- Domain (string) –
  
  The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

Exceptions

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