AssociateConnectionAlias
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.
Request Syntax
{
"AliasId": "string",
"ResourceId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- AliasId
-
The identifier of the connection alias.
Type: String
Length Constraints: Minimum length of 13. Maximum length of 68.
Pattern:
^wsca-[0-9a-z]{8,63}$Required: Yes
- ResourceId
-
The identifier of the directory to associate the connection alias with.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
Response Syntax
{
"ConnectionIdentifier": "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.
- ConnectionIdentifier
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
^[a-zA-Z0-9]+$
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.
HTTP Status Code: 400
- InvalidResourceStateException
-
The state of the resource is not valid for this operation.
HTTP Status Code: 400
- OperationNotSupportedException
-
This operation is not supported.
HTTP Status Code: 400
- ResourceAssociatedException
-
The resource is associated with a directory.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
