Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. 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. -
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Request Syntax
{
"AliasId": "string",
"ConnectionAliasPermission": {
"AllowAssociation": boolean,
"SharedAccountId": "string"
}
}Request Parameters
The request accepts the following data in JSON format.
- AliasId
-
The identifier of the connection alias that you want to update permissions for.
Type: String
Length Constraints: Minimum length of 13. Maximum length of 68.
Pattern:
^wsca-[0-9a-z]{8,63}$Required: Yes
- ConnectionAliasPermission
-
Indicates whether to share or unshare the connection alias with the specified AWS account.
Type: ConnectionAliasPermission object
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
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:
