Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qconnect ]

create-quick-response¶

Description¶

Creates an Amazon Q in Connect quick response.

Synopsis¶

  create-quick-response
[--channels <value>]
[--client-token <value>]
--content <value>
[--content-type <value>]
[--description <value>]
[--grouping-configuration <value>]
[--is-active | --no-is-active]
--knowledge-base-id <value>
[--language <value>]
--name <value>
[--shortcut-key <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--channels (list)

The Amazon Connect channels this quick response applies to.

(string)

Syntax:

"string" "string" ...

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

--content (tagged union structure)

The content of the quick response.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: content.

content -> (string)

The content of the quick response.

Shorthand Syntax:

content=string

JSON Syntax:

{
  "content": "string"
}

--content-type (string)

The media type of the quick response content.

Use application/x.quickresponse;format=plain for a quick response written in plain text.

Use application/x.quickresponse;format=markdown for a quick response written in richtext.

--description (string)

The description of the quick response.

--grouping-configuration (structure)

The configuration information of the user groups that the quick response is accessible to.

criteria -> (string)

The criteria used for grouping Amazon Q in Connect users.

The following is the list of supported criteria values.

RoutingProfileArn : Grouping the users by their Amazon Connect routing profile ARN . User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

values -> (list)

The list of values that define different groups of Amazon Q in Connect users.

When setting criteria to RoutingProfileArn , you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

(string)

Shorthand Syntax:

criteria=string,values=string,string

JSON Syntax:

{
  "criteria": "string",
  "values": ["string", ...]
}

--is-active | --no-is-active (boolean)

Whether the quick response is active.

--knowledge-base-id (string)

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

--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

--name (string)

The name of the quick response.

--shortcut-key (string)

The shortcut key of the quick response. The value should be unique across the knowledge base.

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

quickResponse -> (structure)

The quick response.

channels -> (list)

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat .

(string)

contentType -> (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.

contents -> (structure)

The contents of the quick response.

markdown -> (tagged union structure)

The container quick response content.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: content.

content -> (string)

The content of the quick response.

plainText -> (tagged union structure)

The container quick response content.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: content.

content -> (string)

The content of the quick response.

createdTime -> (timestamp)

The timestamp when the quick response was created.

description -> (string)

The description of the quick response.

groupingConfiguration -> (structure)

The configuration information of the user groups that the quick response is accessible to.

criteria -> (string)

The criteria used for grouping Amazon Q in Connect users.

The following is the list of supported criteria values.

RoutingProfileArn : Grouping the users by their Amazon Connect routing profile ARN . User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

values -> (list)

The list of values that define different groups of Amazon Q in Connect users.

When setting criteria to RoutingProfileArn , you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

(string)

isActive -> (boolean)

Whether the quick response is active.

knowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseId -> (string)

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

lastModifiedBy -> (string)

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

lastModifiedTime -> (timestamp)

The timestamp when the quick response data was last modified.

name -> (string)

The name of the quick response.

quickResponseArn -> (string)

The Amazon Resource Name (ARN) of the quick response.

quickResponseId -> (string)

The identifier of the quick response.

shortcutKey -> (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 -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Table Of Contents

Feedback

User Guide

Note:

create-quick-response¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note

Note