sessions

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

Overview

Name	sessions
Type	Resource
Id	aws.qconnect.sessions

Fields

The following fields are returned by SELECT queries:

get_session

Name	Datatype	Description
name	string	The name of the session. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
ai_agent_configuration	object	The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
description	string	The description of the session. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
integration_configuration	object	The configuration information for the session integration.
orchestrator_configuration_list	array	The list of orchestrator configurations for the session.
origin	string	The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API. (SYSTEM, CUSTOMER)
session_arn	string	The Amazon Resource Name (ARN) of the session. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
session_id	string	The identifier of the session. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
tag_filter	object	An object that can be used to specify Tag conditions.
tags	object	The tags used to organize, track, or control access for this resource.

search_sessions

Name	Datatype	Description
assistant_arn	string	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_id	string	The identifier of the Amazon Q in Connect assistant. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
session_arn	string	The Amazon Resource Name (ARN) of the session. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
session_id	string	The identifier of the session. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_session	select	assistant_id, session_id, region		Retrieves information for a specified session.
search_sessions	select	assistant_id, region	nextToken, maxResults	Searches for sessions.
create_session	insert	assistant_id, region, name		Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
update_session_data	update	assistant_id, session_id, region, data		Updates the data stored on an Amazon Q in Connect Session.
update_session	update	assistant_id, session_id, region		Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

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
assistant_id	string	The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
region	string	AWS region (default: us-east-1)
session_id	string	The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
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_session

Retrieves information for a specified session.

SELECT
name,
ai_agent_configuration,
description,
integration_configuration,
orchestrator_configuration_list,
origin,
session_arn,
session_id,
tag_filter,
tags
FROM aws.qconnect.sessions
WHERE assistant_id = '{{ assistant_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND region = '{{ region }}' -- required
;

search_sessions

Searches for sessions.

SELECT
assistant_arn,
assistant_id,
session_arn,
session_id
FROM aws.qconnect.sessions
WHERE assistant_id = '{{ assistant_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_session

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

INSERT INTO aws.qconnect.sessions (
clientToken,
name,
description,
tags,
tagFilter,
aiAgentConfiguration,
contactArn,
orchestratorConfigurationList,
removeOrchestratorConfigurationList,
assistant_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ tagFilter }}',
'{{ aiAgentConfiguration }}',
'{{ contactArn }}',
'{{ orchestratorConfigurationList }}',
{{ removeOrchestratorConfigurationList }},
'{{ assistant_id }}',
'{{ region }}'
RETURNING
session
;

Manifest

# Description fields are for documentation purposes
- name: sessions
props:
  - name: assistant_id
    value: "{{ assistant_id }}"
    description: Required parameter for the sessions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sessions resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: tagFilter
    description: |
      An object that can be used to specify Tag conditions.
    value:
      tagCondition:
        key: "{{ key }}"
        value: "{{ value }}"
      andConditions:
        - key: "{{ key }}"
          value: "{{ value }}"
      orConditions:
        - andConditions: "{{ andConditions }}"
          tagCondition:
            key: "{{ key }}"
            value: "{{ value }}"
  - name: aiAgentConfiguration
    value: "{{ aiAgentConfiguration }}"
  - name: contactArn
    value: "{{ contactArn }}"
  - name: orchestratorConfigurationList
    value:
      - aiAgentId: "{{ aiAgentId }}"
        orchestratorUseCase: "{{ orchestratorUseCase }}"
  - name: removeOrchestratorConfigurationList
    value: {{ removeOrchestratorConfigurationList }}

UPDATE examples

update_session_data

Updates the data stored on an Amazon Q in Connect Session.

UPDATE aws.qconnect.sessions
SET 
namespace = '{{ namespace }}',
data = '{{ data }}'
WHERE 
assistant_id = '{{ assistant_id }}' --required
AND session_id = '{{ session_id }}' --required
AND region = '{{ region }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
namespace,
session_arn,
session_id;

update_session

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

UPDATE aws.qconnect.sessions
SET 
description = '{{ description }}',
tagFilter = '{{ tagFilter }}',
aiAgentConfiguration = '{{ aiAgentConfiguration }}',
orchestratorConfigurationList = '{{ orchestratorConfigurationList }}',
removeOrchestratorConfigurationList = {{ removeOrchestratorConfigurationList }}
WHERE 
assistant_id = '{{ assistant_id }}' --required
AND session_id = '{{ session_id }}' --required
AND region = '{{ region }}' --required
RETURNING
session;