create_connection_alias

WorkSpaces.Client.create_connection_alias(**kwargs)

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.create_connection_alias(
    ConnectionString='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• ConnectionString (string) --

  [REQUIRED]

  A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com .

  Warning

  After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.

• Tags (list) --

  The tags to associate with the connection alias.

  • (dict) --

    Describes a tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) --

      The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'AliasId': 'string'
}

Response Structure

• (dict) --

  • AliasId (string) --

    The identifier of the connection alias.

Exceptions

• WorkSpaces.Client.exceptions.ResourceAlreadyExistsException
• WorkSpaces.Client.exceptions.AccessDeniedException
• WorkSpaces.Client.exceptions.InvalidParameterValuesException
• WorkSpaces.Client.exceptions.ResourceLimitExceededException
• WorkSpaces.Client.exceptions.InvalidResourceStateException
• WorkSpaces.Client.exceptions.OperationNotSupportedException