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.

See also: AWS API Documentation

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',
    'ManagedSecretConfig': {
        'SecretArn': 'string'
    },
    'CmkSecretConfig': {
        'SecretArn': 'string',
        'KmsKeyArn': 'string'
    },
    'CustomSecretConfig': {
        'SecretArn': 'string',
        'SecretAccessRoleArn': '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.

    • ManagedSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

    • CmkSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.

      • KmsKeyArn (string) –

        Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.

    • CustomSecretConfig (dict) –

      Describes configuration information for a customer-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

      • SecretAccessRoleArn (string) –

        Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

Exceptions