WorkSpaces / Client / describe_connection_aliases

describe_connection_aliases#

WorkSpaces.Client.describe_connection_aliases(**kwargs)#

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.describe_connection_aliases(
    AliasIds=[
        'string',
    ],
    ResourceId='string',
    Limit=123,
    NextToken='string'
)
Parameters:

  • AliasIds (list) –

    The identifiers of the connection aliases to describe.

    • (string) –

  • ResourceId (string) – The identifier of the directory associated with the connection alias.

  • Limit (integer) – The maximum number of connection aliases to return.

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionAliases': [
        {
            'ConnectionString': 'string',
            'AliasId': 'string',
            'State': 'CREATING'|'CREATED'|'DELETING',
            'OwnerAccountId': 'string',
            'Associations': [
                {
                    'AssociationStatus': 'NOT_ASSOCIATED'|'ASSOCIATED_WITH_OWNER_ACCOUNT'|'ASSOCIATED_WITH_SHARED_ACCOUNT'|'PENDING_ASSOCIATION'|'PENDING_DISASSOCIATION',
                    'AssociatedAccountId': 'string',
                    'ResourceId': 'string',
                    'ConnectionIdentifier': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConnectionAliases (list) –

      Information about the specified connection aliases.

      • (dict) –

        Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

        • ConnectionString (string) –

          The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

        • AliasId (string) –

          The identifier of the connection alias.

        • State (string) –

          The current state of the connection alias.

        • OwnerAccountId (string) –

          The identifier of the Amazon Web Services account that owns the connection alias.

        • Associations (list) –

          The association status of the connection alias.

          • (dict) –

            Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

            • AssociationStatus (string) –

              The association status of the connection alias.

            • AssociatedAccountId (string) –

              The identifier of the Amazon Web Services account that associated the connection alias with a directory.

            • ResourceId (string) –

              The identifier of the directory associated with a connection alias.

            • 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.

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException