workspace_pages

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

Overview

Name	workspace_pages
Type	Resource
Id	aws.connect.workspace_pages

Fields

The following fields are returned by SELECT queries:

list_workspace_pages

Name	Datatype	Description
input_data	string	A JSON string containing input parameters passed to the view when the page is rendered.
page	string	The page identifier. System pages include HOME and AGENT_EXPERIENCE. (pattern: <code>^(?!\.$)(?!\.\.$)[\p{L}\p{Z}\p{N}\-_.:=@'|]+$</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the view associated with this page.
slug	string	The URL-friendly identifier for the page. (pattern: <code>^$|^[\p{L}\p{Z}\p{N}\-_.:=@'|]{3,}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_workspace_pages	select	instance_id, workspace_id, region	nextToken, maxResults	Lists the page configurations in a workspace, including the views assigned to each page.
create_workspace_page	insert	instance_id, workspace_id, region, ResourceArn		Associates a view with a page in a workspace, defining what users see when they navigate to that page.
update_workspace_page	update	instance_id, workspace_id, page, region		Updates the configuration of a page in a workspace, including the associated view and input data.
delete_workspace_page	delete	instance_id, workspace_id, page, region		Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

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
instance_id	string	The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
page	string	The page identifier.
region	string	AWS region (default: us-east-1)
workspace_id	string	The identifier of the workspace.
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

list_workspace_pages

Lists the page configurations in a workspace, including the views assigned to each page.

SELECT
input_data,
page,
resource_arn,
slug
FROM aws.connect.workspace_pages
WHERE instance_id = '{{ instance_id }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_workspace_page

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

INSERT INTO aws.connect.workspace_pages (
ResourceArn,
Page,
Slug,
InputData,
instance_id,
workspace_id,
region
)
SELECT 
'{{ ResourceArn }}' /* required */,
'{{ Page }}',
'{{ Slug }}',
'{{ InputData }}',
'{{ instance_id }}',
'{{ workspace_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: workspace_pages
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the workspace_pages resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_pages resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workspace_pages resource.
  - name: ResourceArn
    value: "{{ ResourceArn }}"
  - name: Page
    value: "{{ Page }}"
  - name: Slug
    value: "{{ Slug }}"
  - name: InputData
    value: "{{ InputData }}"

UPDATE examples

update_workspace_page

Updates the configuration of a page in a workspace, including the associated view and input data.

UPDATE aws.connect.workspace_pages
SET 
NewPage = '{{ NewPage }}',
ResourceArn = '{{ ResourceArn }}',
Slug = '{{ Slug }}',
InputData = '{{ InputData }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND page = '{{ page }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_workspace_page

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

DELETE FROM aws.connect.workspace_pages
WHERE instance_id = '{{ instance_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND page = '{{ page }}' --required
AND region = '{{ region }}' --required
;