DescribeConnectionAliasesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesClient, DescribeConnectionAliasesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, DescribeConnectionAliasesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // DescribeConnectionAliasesRequest
  AliasIds: [ // ConnectionAliasIdList
    "STRING_VALUE",
  ],
  ResourceId: "STRING_VALUE",
  Limit: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeConnectionAliasesCommand(input);
const response = await client.send(command);
// { // DescribeConnectionAliasesResult
//   ConnectionAliases: [ // ConnectionAliasList
//     { // ConnectionAlias
//       ConnectionString: "STRING_VALUE",
//       AliasId: "STRING_VALUE",
//       State: "CREATING" || "CREATED" || "DELETING",
//       OwnerAccountId: "STRING_VALUE",
//       Associations: [ // ConnectionAliasAssociationList
//         { // ConnectionAliasAssociation
//           AssociationStatus: "NOT_ASSOCIATED" || "ASSOCIATED_WITH_OWNER_ACCOUNT" || "ASSOCIATED_WITH_SHARED_ACCOUNT" || "PENDING_ASSOCIATION" || "PENDING_DISASSOCIATION",
//           AssociatedAccountId: "STRING_VALUE",
//           ResourceId: "STRING_VALUE",
//           ConnectionIdentifier: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeConnectionAliasesCommand Input

See DescribeConnectionAliasesCommandInput for more details

Parameter
Type
Description
AliasIds
string[] | undefined

The identifiers of the connection aliases to describe.

Limit
number | undefined

The maximum number of connection aliases to return.

NextToken
string | undefined

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

ResourceId
string | undefined

The identifier of the directory associated with the connection alias.

DescribeConnectionAliasesCommand Output

See DescribeConnectionAliasesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ConnectionAliases
ConnectionAlias[] | undefined

Information about the specified connection aliases.

NextToken
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

The user is not authorized to access a resource.

InvalidParameterValuesException
client

One or more parameter values are not valid.

OperationNotSupportedException
client

This operation is not supported.

WorkSpacesServiceException
Base exception class for all service exceptions from WorkSpaces service.