domain_layouts

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

Overview

Name	domain_layouts
Type	Resource
Id	aws.customer_profiles.domain_layouts

Fields

The following fields are returned by SELECT queries:

get_domain_layout

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the layout was created.
description	string	The description of the layout
display_name	string	The display name of the layout (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-\s]*$</code>)
is_default	boolean	If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.
last_updated_at	string (date-time)	The timestamp of when the layout was most recently updated.
layout	string	A customizable layout that can be used to view data under a Customer Profiles domain.
layout_definition_name	string	The unique name of the layout. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
layout_type	string	The type of layout that can be used to view data under a Customer Profiles domain. (PROFILE_EXPLORER)
tags	object	The tags used to organize, track, or control access for this resource.
version	string	The version used to create layout.

list_domain_layouts

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the layout was created.
description	string	The description of the layout
display_name	string	The display name of the layout (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-\s]*$</code>)
is_default	boolean	If set to true for a layout, this layout will be used by default to view data. If set to false, then layout will not be used by default but it can be used to view data by explicit selection on UI.
last_updated_at	string (date-time)	The timestamp of when the layout was most recently updated.
layout_definition_name	string	The unique name of the layout. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
layout_type	string	The type of layout that can be used to view data under customer profiles domain. (PROFILE_EXPLORER)
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_layout	select	domain_name, layout_definition_name, region		Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.
list_domain_layouts	select	domain_name, region	next-token, max-results	Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.
create_domain_layout	insert	domain_name, layout_definition_name, region, DisplayName, LayoutType		Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.
update_domain_layout	update	domain_name, layout_definition_name, region		Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.
delete_domain_layout	delete	domain_name, layout_definition_name, region		Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

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_name	string	The unique name of the domain.
layout_definition_name	string	The unique name of the layout.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of objects returned per page.
next-token	string	Identifies the next page of results to return.

SELECT examples

get_domain_layout

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

SELECT
created_at,
description,
display_name,
is_default,
last_updated_at,
layout,
layout_definition_name,
layout_type,
tags,
version
FROM aws.customer_profiles.domain_layouts
WHERE domain_name = '{{ domain_name }}' -- required
AND layout_definition_name = '{{ layout_definition_name }}' -- required
AND region = '{{ region }}' -- required
;

list_domain_layouts

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

SELECT
created_at,
description,
display_name,
is_default,
last_updated_at,
layout_definition_name,
layout_type,
tags
FROM aws.customer_profiles.domain_layouts
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_domain_layout

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

INSERT INTO aws.customer_profiles.domain_layouts (
Description,
DisplayName,
IsDefault,
LayoutType,
Layout,
Tags,
domain_name,
layout_definition_name,
region
)
SELECT 
'{{ Description }}',
'{{ DisplayName }}' /* required */,
{{ IsDefault }},
'{{ LayoutType }}' /* required */,
'{{ Layout }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ layout_definition_name }}',
'{{ region }}'
RETURNING
created_at,
description,
display_name,
is_default,
last_updated_at,
layout,
layout_definition_name,
layout_type,
tags,
version
;

Manifest

# Description fields are for documentation purposes
- name: domain_layouts
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domain_layouts resource.
  - name: layout_definition_name
    value: "{{ layout_definition_name }}"
    description: Required parameter for the domain_layouts resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domain_layouts resource.
  - name: Description
    value: "{{ Description }}"
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: IsDefault
    value: {{ IsDefault }}
  - name: LayoutType
    value: "{{ LayoutType }}"
    valid_values: ['PROFILE_EXPLORER']
  - name: Layout
    value: "{{ Layout }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_domain_layout

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

UPDATE aws.customer_profiles.domain_layouts
SET 
Description = '{{ Description }}',
DisplayName = '{{ DisplayName }}',
IsDefault = {{ IsDefault }},
LayoutType = '{{ LayoutType }}',
Layout = '{{ Layout }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND layout_definition_name = '{{ layout_definition_name }}' --required
AND region = '{{ region }}' --required
RETURNING
created_at,
description,
display_name,
is_default,
last_updated_at,
layout,
layout_definition_name,
layout_type,
tags,
version;

DELETE examples

delete_domain_layout

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

DELETE FROM aws.customer_profiles.domain_layouts
WHERE domain_name = '{{ domain_name }}' --required
AND layout_definition_name = '{{ layout_definition_name }}' --required
AND region = '{{ region }}' --required
;