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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
quick_response_arn	string	The Amazon Resource Name (ARN) of the quick response.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	quick_responses	INSERT	KnowledgeBaseArn, Content, Name, region
delete_resource	quick_responses	DELETE	Identifier, region
update_resource	quick_responses	UPDATE	Identifier, PatchDocument, region
list_resources	quick_responses_list_only	SELECT	region
get_resource	quick_responses	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ quick_response_arn }}';

list (identifiers only)

Lists all quick_responses in a region.

SELECT
  region,
  quick_response_arn
FROM awscc.wisdom.quick_responses_list_only
WHERE
  region = 'us-east-1';

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
  '{{ knowledge_base_arn }}',
  '{{ 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
  '{{ content_type }}',
  '{{ knowledge_base_arn }}',
  '{{ name }}',
  '{{ channels }}',
  '{{ content }}',
  '{{ description }}',
  '{{ grouping_configuration }}',
  '{{ is_active }}',
  '{{ language }}',
  '{{ shortcut_key }}',
  '{{ 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: content_type
        value: '{{ content_type }}'
      - name: knowledge_base_arn
        value: '{{ knowledge_base_arn }}'
      - name: name
        value: '{{ name }}'
      - name: channels
        value:
          - '{{ channels[0] }}'
      - name: content
        value:
          content: '{{ content }}'
      - name: description
        value: '{{ description }}'
      - name: grouping_configuration
        value:
          criteria: '{{ criteria }}'
          values:
            - '{{ values[0] }}'
      - name: is_active
        value: '{{ is_active }}'
      - name: language
        value: '{{ language }}'
      - name: shortcut_key
        value: '{{ shortcut_key }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.wisdom.quick_responses
SET PatchDocument = string('{{ {
    "ContentType": content_type,
    "Name": name,
    "Channels": channels,
    "Content": content,
    "Description": description,
    "GroupingConfiguration": grouping_configuration,
    "IsActive": is_active,
    "Language": language,
    "ShortcutKey": shortcut_key,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ quick_response_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.wisdom.quick_responses
WHERE
  Identifier = '{{ quick_response_arn }}' 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