CreateDomain
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
Important
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.
Request Syntax
POST /domains HTTP/1.1
Content-type: application/json
{
"name": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- name
-
The name for your Cases domain. It must be unique for your AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^.*[\S]$Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"domainArn": "string",
"domainId": "string",
"domainStatus": "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.
- domainArn
-
The Amazon Resource Name (ARN) for the Cases domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- domainId
-
The unique identifier of the Cases domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
- domainStatus
-
The status of the domain.
Type: String
Valid Values:
Active | CreationInProgress | CreationFailed
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
HTTP Status Code: 409
- InternalServerException
-
We couldn't process your request because of an issue with the server. Try again later.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
HTTP Status Code: 402
- ThrottlingException
-
The rate has been exceeded for this API. Please try again after a few minutes.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Check the syntax and try again.
HTTP Status Code: 400
Examples
Request and Response example
This example illustrates one usage of CreateDomain.
{
"name": "demo-amazon-cases-domain"
}{
"domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
"domainId": "[domain_id]",
"domainStatus": "CreationInProgress"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
