Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeConnectionAliases

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

Request Syntax


{
   "AliasIds": [ "string" ],
   "Limit": number,
   "NextToken": "string",
   "ResourceId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AliasIds

The identifiers of the connection aliases to describe.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: No

Limit

The maximum number of connection aliases to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ResourceId

The identifier of the directory associated with the connection alias.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "ConnectionAliases": [ 
      { 
         "AliasId": "string",
         "Associations": [ 
            { 
               "AssociatedAccountId": "string",
               "AssociationStatus": "string",
               "ConnectionIdentifier": "string",
               "ResourceId": "string"
            }
         ],
         "ConnectionString": "string",
         "OwnerAccountId": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectionAliases

Information about the specified connection aliases.

Type: Array of ConnectionAlias objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

message: The exception error message.
reason: The exception error reason.

HTTP Status Code: 400