associate_connection_alias

associate_connection_alias(**kwargs)

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Note

Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED .

See also: AWS API Documentation

Request Syntax

response = client.associate_connection_alias(
    AliasId='string',
    ResourceId='string'
)
Parameters
  • AliasId (string) --

    [REQUIRED]

    The identifier of the connection alias.

  • ResourceId (string) --

    [REQUIRED]

    The identifier of the directory to associate the connection alias with.

Return type

dict

Returns

Response Syntax

{
    'ConnectionIdentifier': 'string'
}

Response Structure

  • (dict) --

    • ConnectionIdentifier (string) --

      The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

Exceptions

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