quick_responses

Creates, updates, deletes or gets a quick_response resource or lists quick_responses in a region

Overview

Name	quick_responses
Type	Resource
Description	Definition of AWS::Wisdom::QuickResponse Resource Type.
Id	awscc.wisdom.quick_responses

Fields

Name	Datatype	Description
content_type	string	The media type of the quick response content.<br />- Use application/x.quickresponse;format=plain for quick response written in plain text.<br />- Use application/x.quickresponse;format=markdown for quick response written in richtext.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base.
name	string	The name of the quick response.
quick_response_arn	string	The Amazon Resource Name (ARN) of the quick response.
quick_response_id	string	The identifier of the quick response.
channels	array	The Amazon Connect contact channels this quick response applies to.
▶content	object	The container of quick response content.
contents	object	The content of the quick response stored in different media types.
description	string	The description of the quick response.
▶grouping_configuration	object	The configuration information of the user groups that the quick response is accessible to.
is_active	boolean	Whether the quick response is active.
language	string	The language code value for the language in which the quick response is written. The supported language codes include de&#95;DE, en&#95;US, es&#95;ES, fr&#95;FR, id&#95;ID, it&#95;IT, ja&#95;JP, ko&#95;KR, pt&#95;BR, zh&#95;CN, zh&#95;TW
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.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::Wisdom::QuickResponse.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	KnowledgeBaseArn, Content, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual quick_response.

SELECT
region,
content_type,
knowledge_base_arn,
name,
quick_response_arn,
quick_response_id,
channels,
content,
contents,
description,
grouping_configuration,
is_active,
language,
shortcut_key,
status,
tags
FROM awscc.wisdom.quick_responses
WHERE region = 'us-east-1' AND data__Identifier = '<QuickResponseArn>';

INSERT example

Use the following StackQL query and manifest file to create a new quick_response resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.wisdom.quick_responses (
 KnowledgeBaseArn,
 Name,
 Content,
 region
)
SELECT 
'{{ KnowledgeBaseArn }}',
 '{{ Name }}',
 '{{ Content }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.wisdom.quick_responses (
 ContentType,
 KnowledgeBaseArn,
 Name,
 Channels,
 Content,
 Description,
 GroupingConfiguration,
 IsActive,
 Language,
 ShortcutKey,
 Tags,
 region
)
SELECT 
 '{{ ContentType }}',
 '{{ KnowledgeBaseArn }}',
 '{{ Name }}',
 '{{ Channels }}',
 '{{ Content }}',
 '{{ Description }}',
 '{{ GroupingConfiguration }}',
 '{{ IsActive }}',
 '{{ Language }}',
 '{{ ShortcutKey }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: quick_response
    props:
      - name: ContentType
        value: '{{ ContentType }}'
      - name: KnowledgeBaseArn
        value: '{{ KnowledgeBaseArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Channels
        value:
          - '{{ Channels[0] }}'
      - name: Content
        value:
          Content: '{{ Content }}'
      - name: Description
        value: '{{ Description }}'
      - name: GroupingConfiguration
        value:
          Criteria: '{{ Criteria }}'
          Values:
            - '{{ Values[0] }}'
      - name: IsActive
        value: '{{ IsActive }}'
      - name: Language
        value: '{{ Language }}'
      - name: ShortcutKey
        value: '{{ ShortcutKey }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.wisdom.quick_responses
WHERE data__Identifier = '<QuickResponseArn>'
AND region = 'us-east-1';

Permissions

To operate on the quick_responses resource, the following permissions are required:

Create

wisdom:CreateQuickResponse,
wisdom:GetQuickResponse,
wisdom:TagResource,
connect:SearchRoutingProfiles,
connect:DescribeRoutingProfile

Update

wisdom:UpdateQuickResponse,
wisdom:GetQuickResponse,
wisdom:TagResource,
wisdom:UntagResource,
connect:SearchRoutingProfiles,
connect:DescribeRoutingProfile

Delete

wisdom:DeleteQuickResponse,
wisdom:UntagResource

List

wisdom:ListQuickResponses

Read

wisdom:GetQuickResponse