WorkSpaces / Client / delete_connection_alias

delete_connection_alias#

WorkSpaces.Client.delete_connection_alias(**kwargs)#

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Warning

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

Note

To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Request Syntax

response = client.delete_connection_alias(
    AliasId='string'
)

Parameters:

AliasId (string) –

[REQUIRED]

The identifier of the connection alias to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.ResourceAssociatedException
WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.InvalidResourceStateException
WorkSpaces.Client.exceptions.OperationNotSupportedException