domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	aws.connectcases.domains

Fields

The following fields are returned by SELECT queries:

get_domain

Name	Datatype	Description
name	string	The name of the Cases domain. (pattern: <code>.*[\S]</code>)
created_time	string (date-time)	The timestamp when the Cases domain was created.
domain_arn	string	The Amazon Resource Name (ARN) for the Cases domain.
domain_id	string	The unique identifier of the Cases domain.
domain_status	string	The status of the Cases domain. (Active, CreationInProgress, CreationFailed)
tags	object	A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

list_domains

Name	Datatype	Description
domains	array	The Cases domain.
next_token	string	The token for the next set of results. This is null if there are no more results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain	select	domain_id, region		Returns information about a specific domain if it exists.
list_domains	select	region	maxResults, nextToken	Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
create_domain	insert	region, name		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. 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.
delete_domain	delete	domain_id, region		Deletes a Cases domain. After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_id	string	The unique identifier of the Cases domain.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_domain

Returns information about a specific domain if it exists.

SELECT
name,
created_time,
domain_arn,
domain_id,
domain_status,
tags
FROM aws.connectcases.domains
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
;

list_domains

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

SELECT
domains,
next_token
FROM aws.connectcases.domains
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_domain

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. 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.

INSERT INTO aws.connectcases.domains (
name,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ region }}'
RETURNING
domain_arn,
domain_id,
domain_status
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.
  - name: name
    value: "{{ name }}"

DELETE examples

delete_domain

Deletes a Cases domain. After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.

DELETE FROM aws.connectcases.domains
WHERE domain_id = '{{ domain_id }}' --required
AND region = '{{ region }}' --required
;