This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Wisdom::QuickResponse
Creates an Amazon Q in Connect quick response.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Wisdom::QuickResponse", "Properties" : { "Channels" :
[ String, ... ]
, "Content" :QuickResponseContentProvider
, "ContentType" :String
, "Description" :String
, "GroupingConfiguration" :GroupingConfiguration
, "IsActive" :Boolean
, "KnowledgeBaseArn" :String
, "Language" :String
, "Name" :String
, "ShortcutKey" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::Wisdom::QuickResponse Properties: Channels:
- String
Content:QuickResponseContentProvider
ContentType:String
Description:String
GroupingConfiguration:GroupingConfiguration
IsActive:Boolean
KnowledgeBaseArn:String
Language:String
Name:String
ShortcutKey:String
Tags:- Tag
Properties
Channels
-
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
.Required: No
Type: Array of String
Update requires: No interruption
Content
-
The content of the quick response.
Required: Yes
Type: QuickResponseContentProvider
Minimum:
1
Maximum:
1024
Update requires: No interruption
ContentType
-
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.
Required: No
Type: String
Pattern:
^(application/x\.quickresponse;format=(plain|markdown))$
Update requires: No interruption
-
Description
-
The description of the quick response.
Required: No
Type: String
Minimum:
1
Maximum:
255
Update requires: No interruption
GroupingConfiguration
-
The configuration information of the user groups that the quick response is accessible to.
Required: No
Type: GroupingConfiguration
Update requires: No interruption
IsActive
-
Whether the quick response is active.
Required: No
Type: Boolean
Update requires: No interruption
KnowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Required: Yes
Type: String
Pattern:
^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}$
Update requires: Replacement
Language
-
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
Required: No
Type: String
Minimum:
2
Maximum:
5
Update requires: No interruption
Name
-
The name of the quick response.
Required: Yes
Type: String
Minimum:
1
Maximum:
100
Update requires: No interruption
ShortcutKey
-
The shortcut key of the quick response. The value should be unique across the knowledge base.
Required: No
Type: String
Minimum:
1
Maximum:
100
Update requires: No interruption
-
The tags used to organize, track, or control access for this resource.
Required: No
Type: Array of Tag
Update requires: No interruption
Return values
Ref
Fn::GetAtt
QuickResponseArn
-
The Amazon Resource Name (ARN) of the quick response.
QuickResponseId
-
The identifier of the quick response.
Status
-
The status of the quick response data.