FSx / Client / disassociate_file_system_aliases

disassociate_file_system_aliases#

FSx.Client.disassociate_file_system_aliases(**kwargs)#

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_file_system_aliases(
    ClientRequestToken='string',
    FileSystemId='string',
    Aliases=[
        'string',
    ]
)
Parameters:

  • ClientRequestToken (string) –

    (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

    This field is autopopulated if not provided.

  • FileSystemId (string) –

    [REQUIRED]

    Specifies the file system from which to disassociate the DNS aliases.

  • Aliases (list) –

    [REQUIRED]

    An array of one or more DNS alias names to disassociate, or remove, from the file system.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Aliases': [
        {
            'Name': 'string',
            'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
        },
    ]
}

Response Structure

  • (dict) –

    The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.

    • Aliases (list) –

      An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.

      • (dict) –

        A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

        • Name (string) –

          The name of the DNS alias. The alias name has to meet the following requirements:

          • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

          • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

          • Cannot start or end with a hyphen.

          • Can start with a numeric.

          For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

        • Lifecycle (string) –

          Describes the state of the DNS alias.

          • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

          • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

          • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

          • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

          • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

Exceptions

  • FSx.Client.exceptions.BadRequest

  • FSx.Client.exceptions.FileSystemNotFound

  • FSx.Client.exceptions.InternalServerError