create_domain

ConnectCases.Client.create_domain(**kwargs)

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name for your Cases domain. It must be unique for your Amazon Web Services account.

Return type

dict

Returns

Response Syntax

{
    'domainArn': 'string',
    'domainId': 'string',
    'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed'
}

Response Structure

• (dict) --
  • domainArn (string) --

    The Amazon Resource Name (ARN) for the Cases domain.

  • domainId (string) --

    The unique identifier of the Cases domain.

  • domainStatus (string) --

    The status of the domain.

Exceptions

• ConnectCases.Client.exceptions.InternalServerException
• ConnectCases.Client.exceptions.ValidationException
• ConnectCases.Client.exceptions.ThrottlingException
• ConnectCases.Client.exceptions.AccessDeniedException
• ConnectCases.Client.exceptions.ConflictException
• ConnectCases.Client.exceptions.ServiceQuotaExceededException