Skip to content

disassociate_file_system_aliases

disassociate_file_system_aliases(
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    file_system_id: Optional[FileSystemId] = None,
    aliases: Optional[AlternateDNSNames] = None,
) -> DisassociateFileSystemAliasesResponse

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 an HTTP status code 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.

Parameters:

  • file_system_id (Optional[FileSystemId], default: None ) –

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

  • aliases (Optional[AlternateDNSNames], default: None ) –

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

Raises:

  • BadRequest –

    A generic error indicating a failure with a client request.

  • FileSystemNotFound –

    No Amazon FSx file systems were found based upon supplied parameters.

  • InternalServerError –

    A generic error indicating a server-side failure.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_fsx/_services/f_sx.py
def disassociate_file_system_aliases(
    self,
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    client_request_token: Optional[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ] = None,
    file_system_id: Optional["capo_fsx.types.file_system_id.FileSystemId"] = None,
    aliases: Optional[
        "capo_fsx.types.alternate_dns_names.AlternateDNSNames"
    ] = None,
) -> "capo_fsx.types.disassociate_file_system_aliases_response.DisassociateFileSystemAliasesResponse":
    """<p>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 an HTTP status code 400 (Bad Request). For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html">Working with DNS Aliases</a>.</p> <p>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.</p>

    Args:
        file_system_id: <p>Specifies the file system from which to disassociate the DNS aliases.</p>
        aliases: <p>An array of one or more DNS alias names to disassociate, or remove, from the file system.</p>

    Raises:
        capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</p>
        capo_fsx.errors.file_system_not_found.FileSystemNotFound: <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
        capo_fsx.errors.internal_server_error.InternalServerError: <p>A generic error indicating a server-side failure.</p>
        capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_fsx.types.disassociate_file_system_aliases_request.DisassociateFileSystemAliasesRequest]",
    ) -> OperationResponse[
        "capo_fsx.types.disassociate_file_system_aliases_response.DisassociateFileSystemAliasesResponse"
    ]:
        import capo_fsx._operations.aws_simba_api_service_v20180301.disassociate_file_system_aliases

        output, http_response = (
            capo_fsx._operations.aws_simba_api_service_v20180301.disassociate_file_system_aliases.disassociate_file_system_aliases(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateFileSystemAliases")
    )
    input_: capo_fsx.types.disassociate_file_system_aliases_request.DisassociateFileSystemAliasesRequest = {}
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if file_system_id is not None:
        input_["file_system_id"] = file_system_id
    if aliases is not None:
        input_["aliases"] = aliases

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output