CreateConnectionAlias
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Request Syntax
{
"ConnectionString": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
The request accepts the following data in JSON format.
- ConnectionString
-
A connection string in the form of a fully qualified domain name (FQDN), such as
www.example.com.Important
After you create a connection string, it is always associated to your AWS 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[.0-9a-zA-Z\-]{1,255}$Required: Yes
- Tags
-
The tags to associate with the connection alias.
Type: Array of Tag objects
Required: No
Response Syntax
{
"AliasId": "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.
- 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}$
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
- ResourceAlreadyExistsException
-
The specified resource already exists.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
