quick_responses

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

Overview

Name	quick_responses
Type	Resource
Id	aws.qconnect.quick_responses

Fields

The following fields are returned by SELECT queries:

get_quick_response

Name	Datatype	Description
name	string	The name of the quick response.
channels	array	The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
content_type	string	The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext. (pattern: <code>(application/x.quickresponse;format=(plain|markdown))</code>)
contents	object	The contents of the quick response.
created_time	string (date-time)	The timestamp when the quick response was created.
description	string	The description of the quick response.
grouping_configuration	object	The configuration information of the grouping of Amazon Q in Connect users.
is_active	boolean	Whether the quick response is active.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (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>)
knowledge_base_id	string	The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
language	string	The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last updated the quick response data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the quick response data was last modified.
quick_response_arn	string	The Amazon Resource Name (ARN) of the quick response. (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>)
quick_response_id	string	The identifier of the quick response. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
shortcut_key	string	The shortcut key of the quick response. The value should be unique across the knowledge base.
status	string	The status of the quick response data. (CREATE_IN_PROGRESS, CREATE_FAILED, CREATED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED, UPDATE_IN_PROGRESS, UPDATE_FAILED)
tags	object	The tags used to organize, track, or control access for this resource.

search_quick_responses

Name	Datatype	Description
name	string	The name of the quick response.
attributes_interpolated	array	The user defined contact attributes that are resolved when the search result is returned.
attributes_not_interpolated	array	The user defined contact attributes that are not resolved when the search result is returned.
channels	array	The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
content_type	string	The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext. (pattern: <code>(application/x.quickresponse;format=(plain|markdown))</code>)
contents	object	The contents of the quick response.
created_time	string (date-time)	The timestamp when the quick response was created.
description	string	The description of the quick response.
grouping_configuration	object	The configuration information of the grouping of Amazon Q in Connect users.
is_active	boolean	Whether the quick response is active.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (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>)
knowledge_base_id	string	The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
language	string	The language code value for the language in which the quick response is written.
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last updated the quick response search result data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the quick response search result data was last modified.
quick_response_arn	string	The Amazon Resource Name (ARN) of the quick response. (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>)
quick_response_id	string	The identifier of the quick response. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
shortcut_key	string	The shortcut key of the quick response. The value should be unique across the knowledge base.
status	string	The resource status of the quick response. (CREATE_IN_PROGRESS, CREATE_FAILED, CREATED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED, UPDATE_IN_PROGRESS, UPDATE_FAILED)
tags	object	The tags used to organize, track, or control access for this resource.

list_quick_responses

Name	Datatype	Description
name	string	The name of the quick response.
channels	array	The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
content_type	string	The media type of the quick response content. Use application/x.quickresponse;format=plain for quick response written in plain text. Use application/x.quickresponse;format=markdown for quick response written in richtext. (pattern: <code>(application/x.quickresponse;format=(plain|markdown))</code>)
created_time	string (date-time)	The timestamp when the quick response was created.
description	string	The description of the quick response.
is_active	boolean	Whether the quick response is active.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (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>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last updated the quick response data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the quick response summary was last modified.
quick_response_arn	string	The Amazon Resource Name (ARN) of the quick response. (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>)
quick_response_id	string	The identifier of the quick response. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
status	string	The resource status of the quick response. (CREATE_IN_PROGRESS, CREATE_FAILED, CREATED, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED, UPDATE_IN_PROGRESS, UPDATE_FAILED)
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_quick_response	select	quick_response_id, knowledge_base_id, region		Retrieves the quick response.
search_quick_responses	select	knowledge_base_id, region	nextToken, maxResults	Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
list_quick_responses	select	knowledge_base_id, region	nextToken, maxResults	Lists information about quick response.
create_quick_response	insert	knowledge_base_id, region, name, content		Creates an Amazon Q in Connect quick response.
update_quick_response	update	knowledge_base_id, quick_response_id, region		Updates an existing Amazon Q in Connect quick response.
delete_quick_response	delete	knowledge_base_id, quick_response_id, region		Deletes a quick response.

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
knowledge_base_id	string	The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
quick_response_id	string	The identifier of the quick response to delete.
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_quick_response

Retrieves the quick response.

SELECT
name,
channels,
content_type,
contents,
created_time,
description,
grouping_configuration,
is_active,
knowledge_base_arn,
knowledge_base_id,
language,
last_modified_by,
last_modified_time,
quick_response_arn,
quick_response_id,
shortcut_key,
status,
tags
FROM aws.qconnect.quick_responses
WHERE quick_response_id = '{{ quick_response_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;

search_quick_responses

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

SELECT
name,
attributes_interpolated,
attributes_not_interpolated,
channels,
content_type,
contents,
created_time,
description,
grouping_configuration,
is_active,
knowledge_base_arn,
knowledge_base_id,
language,
last_modified_by,
last_modified_time,
quick_response_arn,
quick_response_id,
shortcut_key,
status,
tags
FROM aws.qconnect.quick_responses
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

list_quick_responses

Lists information about quick response.

SELECT
name,
channels,
content_type,
created_time,
description,
is_active,
knowledge_base_arn,
knowledge_base_id,
last_modified_by,
last_modified_time,
quick_response_arn,
quick_response_id,
status,
tags
FROM aws.qconnect.quick_responses
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_quick_response

Creates an Amazon Q in Connect quick response.

INSERT INTO aws.qconnect.quick_responses (
name,
content,
contentType,
groupingConfiguration,
description,
shortcutKey,
isActive,
channels,
language,
clientToken,
tags,
knowledge_base_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ content }}' /* required */,
'{{ contentType }}',
'{{ groupingConfiguration }}',
'{{ description }}',
'{{ shortcutKey }}',
{{ isActive }},
'{{ channels }}',
'{{ language }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ knowledge_base_id }}',
'{{ region }}'
RETURNING
quick_response
;

Manifest

# Description fields are for documentation purposes
- name: quick_responses
props:
  - name: knowledge_base_id
    value: "{{ knowledge_base_id }}"
    description: Required parameter for the quick_responses resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the quick_responses resource.
  - name: name
    value: "{{ name }}"
  - name: content
    description: |
      The container of quick response data.
    value:
      content: "{{ content }}"
  - name: contentType
    value: "{{ contentType }}"
  - name: groupingConfiguration
    description: |
      The configuration information of the grouping of Amazon Q in Connect users.
    value:
      criteria: "{{ criteria }}"
      values:
        - "{{ values }}"
  - name: description
    value: "{{ description }}"
  - name: shortcutKey
    value: "{{ shortcutKey }}"
  - name: isActive
    value: {{ isActive }}
  - name: channels
    value:
      - "{{ channels }}"
  - name: language
    value: "{{ language }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_quick_response

Updates an existing Amazon Q in Connect quick response.

UPDATE aws.qconnect.quick_responses
SET 
name = '{{ name }}',
content = '{{ content }}',
contentType = '{{ contentType }}',
groupingConfiguration = '{{ groupingConfiguration }}',
removeGroupingConfiguration = {{ removeGroupingConfiguration }},
description = '{{ description }}',
removeDescription = {{ removeDescription }},
shortcutKey = '{{ shortcutKey }}',
removeShortcutKey = {{ removeShortcutKey }},
isActive = {{ isActive }},
channels = '{{ channels }}',
language = '{{ language }}'
WHERE 
knowledge_base_id = '{{ knowledge_base_id }}' --required
AND quick_response_id = '{{ quick_response_id }}' --required
AND region = '{{ region }}' --required
RETURNING
quick_response;

DELETE examples

delete_quick_response

Deletes a quick response.

DELETE FROM aws.qconnect.quick_responses
WHERE knowledge_base_id = '{{ knowledge_base_id }}' --required
AND quick_response_id = '{{ quick_response_id }}' --required
AND region = '{{ region }}' --required
;