workspaces

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

Overview

Name	workspaces
Type	Resource
Id	aws.connect.workspaces

Fields

The following fields are returned by SELECT queries:

describe_workspace

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the workspace.
description	string	The description of the workspace. (pattern: <code>^[\P{C}\r\n\t]*$</code>)
id	string	The unique identifier of the workspace.
last_modified_region	string	The Amazon Web Services Region where the workspace was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when the workspace was last modified.
name	string	The name of the workspace. (pattern: <code>.\S.</code>)
tags	object	The tags used to organize, track, or control access for the workspace.
theme	object	Contains theme configuration for a workspace, supporting both light and dark modes.
title	string	The title displayed for the workspace. (pattern: <code>^[\P{C}]*$</code>)
visibility	string	Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible). (ALL, ASSIGNED, NONE)

list_workspaces

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the workspace.
id	string	The unique identifier of the workspace.
last_modified_region	string	The Amazon Web Services Region where the workspace was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when the workspace was last modified.
name	string	The name of the workspace. (pattern: <code>.\S.</code>)

search_workspaces

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the workspace.
created_at	string (date-time)	The timestamp when the workspace was created.
description	string	The description of the workspace. (pattern: <code>^[\P{C}\r\n\t]*$</code>)
id	string	The unique identifier of the workspace.
name	string	The name of the workspace. (pattern: <code>.\S.</code>)
tags	object	The tags associated with the workspace.
title	string	The title displayed for the workspace. (pattern: <code>^[\P{C}]*$</code>)
visibility	string	The visibility setting of the workspace. (ALL, ASSIGNED, NONE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_workspace	select	instance_id, workspace_id, region		Retrieves details about a workspace, including its configuration and metadata.
list_workspaces	select	instance_id, region	nextToken, maxResults	Lists the workspaces in an Amazon Connect instance.
search_workspaces	select	region		Searches workspaces based on name, description, visibility, or tags.
create_workspace	insert	instance_id, region		Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
associate_workspace	update	instance_id, workspace_id, region, ResourceArns		Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
update_workspace_metadata	update	instance_id, workspace_id, region		Updates the metadata of a workspace, such as its name and description.
delete_workspace	delete	instance_id, workspace_id, region		Deletes a workspace and removes all associated view and resource assignments.
import_workspace_media	exec	instance_id, workspace_id, region, MediaType, MediaSource		Imports a media asset (such as a logo) for use in a workspace.
disassociate_workspace	exec	instance_id, workspace_id, region, ResourceArns		Removes the association between a workspace and one or more users or routing profiles.
update_workspace_theme	exec	instance_id, workspace_id, region		Updates the theme configuration for a workspace, including colors and styling.
update_workspace_visibility	exec	instance_id, workspace_id, region		Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.

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

describe_workspace

Retrieves details about a workspace, including its configuration and metadata.

SELECT
arn,
description,
id,
last_modified_region,
last_modified_time,
name,
tags,
theme,
title,
visibility
FROM aws.connect.workspaces
WHERE instance_id = '{{ instance_id }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
;

list_workspaces

Lists the workspaces in an Amazon Connect instance.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.workspaces
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_workspaces

Searches workspaces based on name, description, visibility, or tags.

SELECT
arn,
created_at,
description,
id,
name,
tags,
title,
visibility
FROM aws.connect.workspaces
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_workspace

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

INSERT INTO aws.connect.workspaces (
Name,
Description,
Theme,
Title,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Theme }}',
'{{ Title }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
workspace_arn,
workspace_id
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the workspaces resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workspaces resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Theme
    description: |
      Contains theme configuration for a workspace, supporting both light and dark modes.
    value:
      Light:
        Palette:
          Header:
            Background: "{{ Background }}"
            Text: "{{ Text }}"
            TextHover: "{{ TextHover }}"
            InvertActionsColors: {{ InvertActionsColors }}
          Navigation:
            Background: "{{ Background }}"
            TextBackgroundHover: "{{ TextBackgroundHover }}"
            TextBackgroundActive: "{{ TextBackgroundActive }}"
            Text: "{{ Text }}"
            TextHover: "{{ TextHover }}"
            TextActive: "{{ TextActive }}"
            InvertActionsColors: {{ InvertActionsColors }}
          Canvas:
            ContainerBackground: "{{ ContainerBackground }}"
            PageBackground: "{{ PageBackground }}"
            ActiveBackground: "{{ ActiveBackground }}"
          Primary:
            Default: "{{ Default }}"
            Active: "{{ Active }}"
            ContrastText: "{{ ContrastText }}"
        Images:
          Logo:
            Default: "{{ Default }}"
            Favicon: "{{ Favicon }}"
        Typography:
          FontFamily:
            Default: "{{ Default }}"
      Dark:
        Palette:
          Header:
            Background: "{{ Background }}"
            Text: "{{ Text }}"
            TextHover: "{{ TextHover }}"
            InvertActionsColors: {{ InvertActionsColors }}
          Navigation:
            Background: "{{ Background }}"
            TextBackgroundHover: "{{ TextBackgroundHover }}"
            TextBackgroundActive: "{{ TextBackgroundActive }}"
            Text: "{{ Text }}"
            TextHover: "{{ TextHover }}"
            TextActive: "{{ TextActive }}"
            InvertActionsColors: {{ InvertActionsColors }}
          Canvas:
            ContainerBackground: "{{ ContainerBackground }}"
            PageBackground: "{{ PageBackground }}"
            ActiveBackground: "{{ ActiveBackground }}"
          Primary:
            Default: "{{ Default }}"
            Active: "{{ Active }}"
            ContrastText: "{{ ContrastText }}"
        Images:
          Logo:
            Default: "{{ Default }}"
            Favicon: "{{ Favicon }}"
        Typography:
          FontFamily:
            Default: "{{ Default }}"
  - name: Title
    value: "{{ Title }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

associate_workspace

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

UPDATE aws.connect.workspaces
SET 
ResourceArns = '{{ ResourceArns }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND region = '{{ region }}' --required
AND ResourceArns = '{{ ResourceArns }}' --required
RETURNING
failed_list,
successful_list;

update_workspace_metadata

Updates the metadata of a workspace, such as its name and description.

UPDATE aws.connect.workspaces
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Title = '{{ Title }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_workspace

Deletes a workspace and removes all associated view and resource assignments.

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

Lifecycle Methods

import_workspace_media

Imports a media asset (such as a logo) for use in a workspace.

EXEC aws.connect.workspaces.import_workspace_media 
@instance_id='{{ instance_id }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"MediaType": "{{ MediaType }}", 
"MediaSource": "{{ MediaSource }}"
}'
;

disassociate_workspace

Removes the association between a workspace and one or more users or routing profiles.

EXEC aws.connect.workspaces.disassociate_workspace 
@instance_id='{{ instance_id }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ResourceArns": "{{ ResourceArns }}"
}'
;

update_workspace_theme

Updates the theme configuration for a workspace, including colors and styling.

EXEC aws.connect.workspaces.update_workspace_theme 
@instance_id='{{ instance_id }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Theme": "{{ Theme }}"
}'
;

update_workspace_visibility

Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.

EXEC aws.connect.workspaces.update_workspace_visibility 
@instance_id='{{ instance_id }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Visibility": "{{ Visibility }}"
}'
;