UpdateDomain
Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.
Request Syntax
{
"Description": "string",
"DomainId": "string",
"Name": "string",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
A brief description about this domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)Required: No
- DomainId
-
The identifier of the domain to be updated.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
[a-zA-Z0-9]{22}Required: Yes
- Name
-
The name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: Yes
- ServerSideEncryptionConfiguration
-
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's
ServerSideEncryptionUpdateDetailscontains the details for this process.Type: ServerSideEncryptionConfiguration object
Required: Yes
Response Syntax
{
"Domain": {
"Arn": "string",
"CreatedAt": number,
"Description": "string",
"DomainId": "string",
"DomainStatus": "string",
"Name": "string",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "string"
},
"ServerSideEncryptionUpdateDetails": {
"Message": "string",
"OldKmsKeyId": "string",
"UpdateStatus": "string"
},
"UpdatedAt": number,
"WatchlistDetails": {
"DefaultWatchlistId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action. Check the error message and try again.
HTTP Status Code: 400
- ConflictException
-
The request failed due to a conflict. Check the
ConflictTypeand error message for more details.HTTP Status Code: 400
- InternalServerException
-
The request failed due to an unknown error on the server side.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found. Check the
ResourceTypeand error message for more details.HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
HTTP Status Code: 400
- ValidationException
-
The request failed one or more validations; check the error message for more details.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
