From 63be40d848ffd8fefc3dd1d061caa978ecab2c7d Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 10 Apr 2024 18:15:00 +0000 Subject: [PATCH] feat(client-qconnect): This release adds a new QiC public API updateSession and updates an existing QiC public API createSession --- clients/client-qconnect/README.md | 30 +- clients/client-qconnect/src/QConnect.ts | 39 +- clients/client-qconnect/src/QConnectClient.ts | 29 +- .../src/commands/CreateContentCommand.ts | 3 +- .../commands/CreateQuickResponseCommand.ts | 2 +- .../src/commands/CreateSessionCommand.ts | 47 +- .../src/commands/GetRecommendationsCommand.ts | 8 +- .../src/commands/GetSessionCommand.ts | 20 + .../src/commands/PutFeedbackCommand.ts | 3 +- .../src/commands/QueryAssistantCommand.ts | 11 +- .../commands/SearchQuickResponsesCommand.ts | 2 +- .../src/commands/StartContentUploadCommand.ts | 6 +- .../src/commands/StartImportJobCommand.ts | 7 +- .../UpdateKnowledgeBaseTemplateUriCommand.ts | 2 +- .../commands/UpdateQuickResponseCommand.ts | 2 +- .../src/commands/UpdateSessionCommand.ts | 145 +++++ clients/client-qconnect/src/commands/index.ts | 1 + clients/client-qconnect/src/index.ts | 22 +- .../client-qconnect/src/models/models_0.ts | 509 ++++++++++++------ .../src/protocols/Aws_restJson1.ts | 71 +++ codegen/sdk-codegen/aws-models/qconnect.json | 413 +++++++++----- 21 files changed, 1030 insertions(+), 342 deletions(-) create mode 100644 clients/client-qconnect/src/commands/UpdateSessionCommand.ts diff --git a/clients/client-qconnect/README.md b/clients/client-qconnect/README.md index 0f97a12b7b7e..7567d1df3f05 100644 --- a/clients/client-qconnect/README.md +++ b/clients/client-qconnect/README.md @@ -9,18 +9,18 @@ AWS SDK for JavaScript QConnect Client for Node.js, Browser and React Native.

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse -detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full -advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the -responsible use of artificial intelligence (AI).

+detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of +the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of +artificial intelligence (AI).

 -

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution -of Amazon Connect Wisdom that delivers real-time recommendations to help contact center -agents resolve customer issues quickly and accurately.

-

Amazon Q automatically detects customer intent during calls and chats using -conversational analytics and natural language understanding (NLU). It then provides agents -with immediate, real-time generative responses and suggested actions, and links to relevant -documents and articles. Agents can also query Amazon Q directly using natural language or -keywords to answer customer requests.

+

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced +evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact +center agents resolve customer issues quickly and accurately.

+

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational +analytics and natural language understanding (NLU). It then provides agents with immediate, +real-time generative responses and suggested actions, and links to relevant documents and +articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer +customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI @@ -558,3 +558,11 @@ UpdateQuickResponse [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qconnect/command/UpdateQuickResponseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateQuickResponseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateQuickResponseCommandOutput/) +

+ +UpdateSession + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qconnect/command/UpdateSessionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateSessionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateSessionCommandOutput/) + +
diff --git a/clients/client-qconnect/src/QConnect.ts b/clients/client-qconnect/src/QConnect.ts index b36049988e4b..4c510c4d1e3b 100644 --- a/clients/client-qconnect/src/QConnect.ts +++ b/clients/client-qconnect/src/QConnect.ts @@ -196,6 +196,11 @@ import { UpdateQuickResponseCommandInput, UpdateQuickResponseCommandOutput, } from "./commands/UpdateQuickResponseCommand"; +import { + UpdateSessionCommand, + UpdateSessionCommandInput, + UpdateSessionCommandOutput, +} from "./commands/UpdateSessionCommand"; import { QConnectClient, QConnectClientConfig } from "./QConnectClient"; const commands = { @@ -241,6 +246,7 @@ const commands = { UpdateContentCommand, UpdateKnowledgeBaseTemplateUriCommand, UpdateQuickResponseCommand, + UpdateSessionCommand, }; export interface QConnect { @@ -857,24 +863,35 @@ export interface QConnect { options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuickResponseCommandOutput) => void ): void; + + /** + * @see {@link UpdateSessionCommand} + */ + updateSession(args: UpdateSessionCommandInput, options?: __HttpHandlerOptions): Promise; + updateSession(args: UpdateSessionCommandInput, cb: (err: any, data?: UpdateSessionCommandOutput) => void): void; + updateSession( + args: UpdateSessionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateSessionCommandOutput) => void + ): void; } /** * *

* Powered by Amazon Bedrock: Amazon Web Services implements automated abuse - * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full - * advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the - * responsible use of artificial intelligence (AI).

+ * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of + * the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of + * artificial intelligence (AI).

* - *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution - * of Amazon Connect Wisdom that delivers real-time recommendations to help contact center - * agents resolve customer issues quickly and accurately.

- *

Amazon Q automatically detects customer intent during calls and chats using - * conversational analytics and natural language understanding (NLU). It then provides agents - * with immediate, real-time generative responses and suggested actions, and links to relevant - * documents and articles. Agents can also query Amazon Q directly using natural language or - * keywords to answer customer requests.

+ *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced + * evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact + * center agents resolve customer issues quickly and accurately.

+ *

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational + * analytics and natural language understanding (NLU). It then provides agents with immediate, + * real-time generative responses and suggested actions, and links to relevant documents and + * articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer + * customer requests.

*

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or * manage content by uploading custom files.

*

For more information, see Use Amazon Q in Connect for generative AI diff --git a/clients/client-qconnect/src/QConnectClient.ts b/clients/client-qconnect/src/QConnectClient.ts index 27d6f88778d8..fafb4bf693aa 100644 --- a/clients/client-qconnect/src/QConnectClient.ts +++ b/clients/client-qconnect/src/QConnectClient.ts @@ -137,6 +137,7 @@ import { UpdateQuickResponseCommandInput, UpdateQuickResponseCommandOutput, } from "./commands/UpdateQuickResponseCommand"; +import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "./commands/UpdateSessionCommand"; import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, @@ -193,7 +194,8 @@ export type ServiceInputTypes = | UntagResourceCommandInput | UpdateContentCommandInput | UpdateKnowledgeBaseTemplateUriCommandInput - | UpdateQuickResponseCommandInput; + | UpdateQuickResponseCommandInput + | UpdateSessionCommandInput; /** * @public @@ -240,7 +242,8 @@ export type ServiceOutputTypes = | UntagResourceCommandOutput | UpdateContentCommandOutput | UpdateKnowledgeBaseTemplateUriCommandOutput - | UpdateQuickResponseCommandOutput; + | UpdateQuickResponseCommandOutput + | UpdateSessionCommandOutput; /** * @public @@ -417,18 +420,18 @@ export interface QConnectClientResolvedConfig extends QConnectClientResolvedConf * *

* Powered by Amazon Bedrock: Amazon Web Services implements automated abuse - * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full - * advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the - * responsible use of artificial intelligence (AI).

+ * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of + * the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of + * artificial intelligence (AI).

* - *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution - * of Amazon Connect Wisdom that delivers real-time recommendations to help contact center - * agents resolve customer issues quickly and accurately.

- *

Amazon Q automatically detects customer intent during calls and chats using - * conversational analytics and natural language understanding (NLU). It then provides agents - * with immediate, real-time generative responses and suggested actions, and links to relevant - * documents and articles. Agents can also query Amazon Q directly using natural language or - * keywords to answer customer requests.

+ *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced + * evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact + * center agents resolve customer issues quickly and accurately.

+ *

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational + * analytics and natural language understanding (NLU). It then provides agents with immediate, + * real-time generative responses and suggested actions, and links to relevant documents and + * articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer + * customer requests.

*

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or * manage content by uploading custom files.

*

For more information, see Use Amazon Q in Connect for generative AI diff --git a/clients/client-qconnect/src/commands/CreateContentCommand.ts b/clients/client-qconnect/src/commands/CreateContentCommand.ts index dd205bdb46dd..3193eecfa825 100644 --- a/clients/client-qconnect/src/commands/CreateContentCommand.ts +++ b/clients/client-qconnect/src/commands/CreateContentCommand.ts @@ -31,8 +31,7 @@ export interface CreateContentCommandInput extends CreateContentRequest {} export interface CreateContentCommandOutput extends CreateContentResponse, __MetadataBearer {} /** - *

Creates Amazon Q content. Before to calling this API, use StartContentUpload to - * upload an asset.

+ *

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts b/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts index 64cc4ed9d111..ecae14929f9f 100644 --- a/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts +++ b/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts @@ -32,7 +32,7 @@ export interface CreateQuickResponseCommandInput extends CreateQuickResponseRequ export interface CreateQuickResponseCommandOutput extends CreateQuickResponseResponse, __MetadataBearer {} /** - *

Creates an Amazon Q quick response.

+ *

Creates an Amazon Q in Connect quick response.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/CreateSessionCommand.ts b/clients/client-qconnect/src/commands/CreateSessionCommand.ts index 078943a3800f..fa61372b5c9d 100644 --- a/clients/client-qconnect/src/commands/CreateSessionCommand.ts +++ b/clients/client-qconnect/src/commands/CreateSessionCommand.ts @@ -28,8 +28,8 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met /** *

Creates a session. A session is a contextual container used for generating - * recommendations. Amazon Connect creates a new Amazon Q session for each contact on which - * Amazon Q is enabled.

+ * recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which + * Amazon Q in Connect is enabled.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -44,6 +44,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met * tags: { // Tags * "": "STRING_VALUE", * }, + * tagFilter: { // TagFilter Union: only one key present + * tagCondition: { // TagCondition + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", + * }, + * andConditions: [ // AndConditions + * { + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", + * }, + * ], + * orConditions: [ // OrConditions + * { // OrCondition Union: only one key present + * andConditions: [ + * "", + * ], + * tagCondition: "", + * }, + * ], + * }, * }; * const command = new CreateSessionCommand(input); * const response = await client.send(command); @@ -59,6 +79,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met * // integrationConfiguration: { // SessionIntegrationConfiguration * // topicIntegrationArn: "STRING_VALUE", * // }, + * // tagFilter: { // TagFilter Union: only one key present + * // tagCondition: { // TagCondition + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // andConditions: [ // AndConditions + * // { + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // ], + * // orConditions: [ // OrConditions + * // { // OrCondition Union: only one key present + * // andConditions: [ + * // "", + * // ], + * // tagCondition: "", + * // }, + * // ], + * // }, * // }, * // }; * @@ -70,6 +110,9 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met * @see {@link CreateSessionCommandOutput} for command's `response` shape. * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape. * + * @throws {@link AccessDeniedException} (client fault) + *

You do not have sufficient access to perform this action.

+ * * @throws {@link ConflictException} (client fault) *

The request could not be processed because of conflict in the current state of the * resource. For example, if you're using a Create API (such as diff --git a/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts b/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts index 10ae6db8bf35..85aa9d71a051 100644 --- a/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts +++ b/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts @@ -31,7 +31,13 @@ export interface GetRecommendationsCommandInput extends GetRecommendationsReques export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {} /** - *

Retrieves recommendations for the specified session. To avoid retrieving the same + * + *

This API will be discontinued starting June 1, 2024. To receive generative responses + * after March 1, 2024, you will need to create a new Assistant in the Amazon Connect + * console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into + * your applications.

+ * + *

Retrieves recommendations for the specified session. To avoid retrieving the same * recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the * waitTimeSeconds parameter. Short poll is the default behavior and only returns * recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

diff --git a/clients/client-qconnect/src/commands/GetSessionCommand.ts b/clients/client-qconnect/src/commands/GetSessionCommand.ts index 6e0a3cf3b83b..7cf7256ba35a 100644 --- a/clients/client-qconnect/src/commands/GetSessionCommand.ts +++ b/clients/client-qconnect/src/commands/GetSessionCommand.ts @@ -52,6 +52,26 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB * // integrationConfiguration: { // SessionIntegrationConfiguration * // topicIntegrationArn: "STRING_VALUE", * // }, + * // tagFilter: { // TagFilter Union: only one key present + * // tagCondition: { // TagCondition + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // andConditions: [ // AndConditions + * // { + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // ], + * // orConditions: [ // OrConditions + * // { // OrCondition Union: only one key present + * // andConditions: [ + * // "", + * // ], + * // tagCondition: "", + * // }, + * // ], + * // }, * // }, * // }; * diff --git a/clients/client-qconnect/src/commands/PutFeedbackCommand.ts b/clients/client-qconnect/src/commands/PutFeedbackCommand.ts index b936aa943b15..cbef4305dbee 100644 --- a/clients/client-qconnect/src/commands/PutFeedbackCommand.ts +++ b/clients/client-qconnect/src/commands/PutFeedbackCommand.ts @@ -27,7 +27,8 @@ export interface PutFeedbackCommandInput extends PutFeedbackRequest {} export interface PutFeedbackCommandOutput extends PutFeedbackResponse, __MetadataBearer {} /** - *

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

+ *

Provides feedback against the specified assistant for the specified target. This API only + * supports generative targets.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/QueryAssistantCommand.ts b/clients/client-qconnect/src/commands/QueryAssistantCommand.ts index cdc5f98518aa..b042555d8486 100644 --- a/clients/client-qconnect/src/commands/QueryAssistantCommand.ts +++ b/clients/client-qconnect/src/commands/QueryAssistantCommand.ts @@ -32,9 +32,14 @@ export interface QueryAssistantCommandInput extends QueryAssistantRequest {} export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __MetadataBearer {} /** - *

Performs a manual search against the specified assistant. To retrieve recommendations for - * an assistant, use GetRecommendations. - *

+ * + *

This API will be discontinued starting June 1, 2024. To receive generative responses + * after March 1, 2024, you will need to create a new Assistant in the Amazon Connect + * console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into + * your applications.

+ * + *

Performs a manual search against the specified assistant. To retrieve recommendations for + * an assistant, use GetRecommendations.

* * @deprecated QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. * @example diff --git a/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts b/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts index e4173eace5d2..9f85f1b3a874 100644 --- a/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts +++ b/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts @@ -32,7 +32,7 @@ export interface SearchQuickResponsesCommandInput extends SearchQuickResponsesRe export interface SearchQuickResponsesCommandOutput extends SearchQuickResponsesResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/StartContentUploadCommand.ts b/clients/client-qconnect/src/commands/StartContentUploadCommand.ts index d57a5bc6111e..0047c7db2142 100644 --- a/clients/client-qconnect/src/commands/StartContentUploadCommand.ts +++ b/clients/client-qconnect/src/commands/StartContentUploadCommand.ts @@ -33,8 +33,10 @@ export interface StartContentUploadCommandOutput extends StartContentUploadRespo /** *

Get a URL to upload content to a knowledge base. To upload content, first make a PUT * request to the returned URL with your file, making sure to include the required headers. Then - * use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a - * knowledge base of type CUSTOM.

+ * use CreateContent to + * finalize the content creation process or UpdateContent to + * modify an existing resource. You can only upload content to a knowledge base of type + * CUSTOM.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/StartImportJobCommand.ts b/clients/client-qconnect/src/commands/StartImportJobCommand.ts index 094d9b53a9d1..837dc33dc4a1 100644 --- a/clients/client-qconnect/src/commands/StartImportJobCommand.ts +++ b/clients/client-qconnect/src/commands/StartImportJobCommand.ts @@ -31,11 +31,14 @@ export interface StartImportJobCommandInput extends StartImportJobRequest {} export interface StartImportJobCommandOutput extends StartImportJobResponse, __MetadataBearer {} /** - *

Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to + *

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. + * Before calling this API, use StartContentUpload to * upload an asset that contains the resource data.

*
    *
  • - *

    For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

    + *

    For importing Amazon Q in Connect quick responses, you need to upload a csv file including the + * quick responses. For information about how to format the csv file for importing quick + * responses, see Import quick responses.

    *
    • *
* @example diff --git a/clients/client-qconnect/src/commands/UpdateKnowledgeBaseTemplateUriCommand.ts b/clients/client-qconnect/src/commands/UpdateKnowledgeBaseTemplateUriCommand.ts index 7ba89a3918bf..83c1f931946b 100644 --- a/clients/client-qconnect/src/commands/UpdateKnowledgeBaseTemplateUriCommand.ts +++ b/clients/client-qconnect/src/commands/UpdateKnowledgeBaseTemplateUriCommand.ts @@ -34,7 +34,7 @@ export interface UpdateKnowledgeBaseTemplateUriCommandOutput /** *

Updates the template URI of a knowledge base. This is only supported for knowledge bases * of type EXTERNAL. Include a single variable in $\{variable\} format; this - * interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce + * interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce * article, it has an Id value, and you can set the template URI to * https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view. *

diff --git a/clients/client-qconnect/src/commands/UpdateQuickResponseCommand.ts b/clients/client-qconnect/src/commands/UpdateQuickResponseCommand.ts index 349091775289..82e031f692a5 100644 --- a/clients/client-qconnect/src/commands/UpdateQuickResponseCommand.ts +++ b/clients/client-qconnect/src/commands/UpdateQuickResponseCommand.ts @@ -32,7 +32,7 @@ export interface UpdateQuickResponseCommandInput extends UpdateQuickResponseRequ export interface UpdateQuickResponseCommandOutput extends UpdateQuickResponseResponse, __MetadataBearer {} /** - *

Updates an existing Amazon Q quick response.

+ *

Updates an existing Amazon Q in Connect quick response.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-qconnect/src/commands/UpdateSessionCommand.ts b/clients/client-qconnect/src/commands/UpdateSessionCommand.ts new file mode 100644 index 000000000000..93a13cd64093 --- /dev/null +++ b/clients/client-qconnect/src/commands/UpdateSessionCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateSessionRequest, UpdateSessionResponse } from "../models/models_0"; +import { de_UpdateSessionCommand, se_UpdateSessionCommand } from "../protocols/Aws_restJson1"; +import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateSessionCommand}. + */ +export interface UpdateSessionCommandInput extends UpdateSessionRequest {} +/** + * @public + * + * The output of {@link UpdateSessionCommand}. + */ +export interface UpdateSessionCommandOutput extends UpdateSessionResponse, __MetadataBearer {} + +/** + *

Updates a session. A session is a contextual container used for generating recommendations. + * Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect + * is enabled.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QConnectClient, UpdateSessionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import + * // const { QConnectClient, UpdateSessionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import + * const client = new QConnectClient(config); + * const input = { // UpdateSessionRequest + * assistantId: "STRING_VALUE", // required + * sessionId: "STRING_VALUE", // required + * description: "STRING_VALUE", + * tagFilter: { // TagFilter Union: only one key present + * tagCondition: { // TagCondition + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", + * }, + * andConditions: [ // AndConditions + * { + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", + * }, + * ], + * orConditions: [ // OrConditions + * { // OrCondition Union: only one key present + * andConditions: [ + * "", + * ], + * tagCondition: "", + * }, + * ], + * }, + * }; + * const command = new UpdateSessionCommand(input); + * const response = await client.send(command); + * // { // UpdateSessionResponse + * // session: { // SessionData + * // sessionArn: "STRING_VALUE", // required + * // sessionId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // tags: { // Tags + * // "": "STRING_VALUE", + * // }, + * // integrationConfiguration: { // SessionIntegrationConfiguration + * // topicIntegrationArn: "STRING_VALUE", + * // }, + * // tagFilter: { // TagFilter Union: only one key present + * // tagCondition: { // TagCondition + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // andConditions: [ // AndConditions + * // { + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", + * // }, + * // ], + * // orConditions: [ // OrConditions + * // { // OrCondition Union: only one key present + * // andConditions: [ + * // "", + * // ], + * // tagCondition: "", + * // }, + * // ], + * // }, + * // }, + * // }; + * + * ``` + * + * @param UpdateSessionCommandInput - {@link UpdateSessionCommandInput} + * @returns {@link UpdateSessionCommandOutput} + * @see {@link UpdateSessionCommandInput} for command's `input` shape. + * @see {@link UpdateSessionCommandOutput} for command's `response` shape. + * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You do not have sufficient access to perform this action.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource does not exist.

+ * + * @throws {@link ValidationException} (client fault) + *

The input fails to satisfy the constraints specified by a service.

+ * + * @throws {@link QConnectServiceException} + *

Base exception class for all service exceptions from QConnect service.

+ * + * @public + */ +export class UpdateSessionCommand extends $Command + .classBuilder< + UpdateSessionCommandInput, + UpdateSessionCommandOutput, + QConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: QConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("WisdomService", "UpdateSession", {}) + .n("QConnectClient", "UpdateSessionCommand") + .f(void 0, void 0) + .ser(se_UpdateSessionCommand) + .de(de_UpdateSessionCommand) + .build() {} diff --git a/clients/client-qconnect/src/commands/index.ts b/clients/client-qconnect/src/commands/index.ts index bfe90ad655e8..084f8c132b80 100644 --- a/clients/client-qconnect/src/commands/index.ts +++ b/clients/client-qconnect/src/commands/index.ts @@ -41,3 +41,4 @@ export * from "./UntagResourceCommand"; export * from "./UpdateContentCommand"; export * from "./UpdateKnowledgeBaseTemplateUriCommand"; export * from "./UpdateQuickResponseCommand"; +export * from "./UpdateSessionCommand"; diff --git a/clients/client-qconnect/src/index.ts b/clients/client-qconnect/src/index.ts index 9bef8052a1c0..c453a71c5f22 100644 --- a/clients/client-qconnect/src/index.ts +++ b/clients/client-qconnect/src/index.ts @@ -4,18 +4,18 @@ * *

* Powered by Amazon Bedrock: Amazon Web Services implements automated abuse - * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full - * advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the - * responsible use of artificial intelligence (AI).

+ * detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of + * the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of + * artificial intelligence (AI).

* - *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution - * of Amazon Connect Wisdom that delivers real-time recommendations to help contact center - * agents resolve customer issues quickly and accurately.

- *

Amazon Q automatically detects customer intent during calls and chats using - * conversational analytics and natural language understanding (NLU). It then provides agents - * with immediate, real-time generative responses and suggested actions, and links to relevant - * documents and articles. Agents can also query Amazon Q directly using natural language or - * keywords to answer customer requests.

+ *

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced + * evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact + * center agents resolve customer issues quickly and accurately.

+ *

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational + * analytics and natural language understanding (NLU). It then provides agents with immediate, + * real-time generative responses and suggested actions, and links to relevant documents and + * articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer + * customer requests.

*

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or * manage content by uploading custom files.

*

For more information, see Use Amazon Q in Connect for generative AI diff --git a/clients/client-qconnect/src/models/models_0.ts b/clients/client-qconnect/src/models/models_0.ts index 25e4db8861c7..c1e13e0c8226 100644 --- a/clients/client-qconnect/src/models/models_0.ts +++ b/clients/client-qconnect/src/models/models_0.ts @@ -23,6 +23,25 @@ export class AccessDeniedException extends __BaseException { } } +/** + *

A leaf node condition which can be used to specify a tag condition. + *

+ * @public + */ +export interface TagCondition { + /** + *

The tag key in the tag condition.

+ * @public + */ + key: string | undefined; + + /** + *

The tag value in the tag condition.

+ * @public + */ + value?: string; +} + /** *

Configuration information for Amazon AppIntegrations to automatically ingest content.

* @public @@ -73,7 +92,7 @@ export interface AppIntegrationsConfiguration { appIntegrationArn: string | undefined; /** - *

The fields from the source that are made available to your agents in Amazon Q. Optional if + *

The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if * ObjectConfiguration is included in the provided DataIntegration.

*
    *
  • @@ -123,7 +142,7 @@ export class ConflictException extends __BaseException { } /** - *

    The data that is input into Amazon Q as a result of the assistant association.

    + *

    The data that is input into Amazon Q in Connect as a result of the assistant association.

    * @public */ export type AssistantAssociationInputData = @@ -135,8 +154,7 @@ export type AssistantAssociationInputData = */ export namespace AssistantAssociationInputData { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    * @public */ export interface KnowledgeBaseIdMember { @@ -181,7 +199,7 @@ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationT */ export interface CreateAssistantAssociationRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -220,8 +238,7 @@ export interface CreateAssistantAssociationRequest { */ export interface KnowledgeBaseAssociationData { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId?: string; @@ -292,13 +309,13 @@ export interface AssistantAssociationData { assistantAssociationArn: string | undefined; /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -412,7 +429,7 @@ export interface DeleteAssistantAssociationRequest { assistantAssociationId: string | undefined; /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -434,7 +451,7 @@ export interface GetAssistantAssociationRequest { assistantAssociationId: string | undefined; /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -469,7 +486,7 @@ export interface ListAssistantAssociationsRequest { maxResults?: number; /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -493,13 +510,13 @@ export interface AssistantAssociationSummary { assistantAssociationArn: string | undefined; /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -547,7 +564,7 @@ export interface ListAssistantAssociationsResponse { export interface ServerSideEncryptionConfiguration { /** *

    The customer managed key used for encryption. For more information about setting up a - * customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance. + * customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * For information about valid ID values, see Key identifiers (KeyId).

    * @public */ @@ -609,11 +626,11 @@ export interface CreateAssistantRequest { *

    The customer managed key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow + * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow * kms:Decrypt, kms:GenerateDataKey*, and * kms:DescribeKey permissions to the connect.amazonaws.com service * principal.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ @@ -635,19 +652,19 @@ export const AssistantCapabilityType = { export type AssistantCapabilityType = (typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType]; /** - *

    The capability configuration for an Amazon Q assistant.

    + *

    The capability configuration for an Amazon Q in Connect assistant.

    * @public */ export interface AssistantCapabilityConfiguration { /** - *

    The type of Amazon Q assistant capability.

    + *

    The type of Amazon Q in Connect assistant capability.

    * @public */ type?: AssistantCapabilityType; } /** - *

    The configuration information for the Amazon Q assistant integration.

    + *

    The configuration information for the Amazon Q in Connect assistant integration.

    * @public */ export interface AssistantIntegrationConfiguration { @@ -682,13 +699,13 @@ export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantSta */ export interface AssistantData { /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -728,24 +745,24 @@ export interface AssistantData { *

    This KMS key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow + * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow * kms:Decrypt, kms:GenerateDataKey*, and * kms:DescribeKey permissions to the connect.amazonaws.com service * principal.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; /** - *

    The configuration information for the Amazon Q assistant integration.

    + *

    The configuration information for the Amazon Q in Connect assistant integration.

    * @public */ integrationConfiguration?: AssistantIntegrationConfiguration; /** - *

    The configuration information for the Amazon Q assistant capability.

    + *

    The configuration information for the Amazon Q in Connect assistant capability.

    * @public */ capabilityConfiguration?: AssistantCapabilityConfiguration; @@ -767,7 +784,7 @@ export interface CreateAssistantResponse { */ export interface DeleteAssistantRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -783,7 +800,7 @@ export interface DeleteAssistantResponse {} */ export interface GetAssistantRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -805,7 +822,7 @@ export interface GetAssistantResponse { */ export interface GetRecommendationsRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -993,8 +1010,7 @@ export interface ContentReference { knowledgeBaseArn?: string; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    * @public */ knowledgeBaseId?: string; @@ -1277,13 +1293,13 @@ export interface ListAssistantsRequest { */ export interface AssistantSummary { /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -1323,24 +1339,24 @@ export interface AssistantSummary { *

    This KMS key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow + * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow * kms:Decrypt, kms:GenerateDataKey*, and * kms:DescribeKey permissions to the connect.amazonaws.com service * principal.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; /** - *

    The configuration information for the Amazon Q assistant integration.

    + *

    The configuration information for the Amazon Q in Connect assistant integration.

    * @public */ integrationConfiguration?: AssistantIntegrationConfiguration; /** - *

    The configuration information for the Amazon Q assistant capability.

    + *

    The configuration information for the Amazon Q in Connect assistant capability.

    * @public */ capabilityConfiguration?: AssistantCapabilityConfiguration; @@ -1368,7 +1384,7 @@ export interface ListAssistantsResponse { */ export interface NotifyRecommendationsReceivedRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -1507,7 +1523,7 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType]; */ export interface PutFeedbackRequest { /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; @@ -1536,13 +1552,13 @@ export interface PutFeedbackRequest { */ export interface PutFeedbackResponse { /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -1660,7 +1676,7 @@ export namespace QueryCondition { */ export interface QueryAssistantRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -1685,7 +1701,7 @@ export interface QueryAssistantRequest { maxResults?: number; /** - *

    The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot + *

    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot * contain the ARN.

    * @public */ @@ -1815,7 +1831,7 @@ export interface SearchSessionsRequest { maxResults?: number; /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -1845,13 +1861,13 @@ export interface SessionSummary { sessionArn: string | undefined; /** - *

    The identifier of the Amazon Q assistant.

    + *

    The identifier of the Amazon Q in Connect assistant.

    * @public */ assistantId: string | undefined; /** - *

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    + *

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    * @public */ assistantArn: string | undefined; @@ -1874,6 +1890,130 @@ export interface SearchSessionsResponse { nextToken?: string; } +/** + *

    A list of conditions which would be applied together with an OR condition.

    + * @public + */ +export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagConditionMember | OrCondition.$UnknownMember; + +/** + * @public + */ +export namespace OrCondition { + /** + *

    A list of conditions which would be applied together with an AND condition.

    + * @public + */ + export interface AndConditionsMember { + andConditions: TagCondition[]; + tagCondition?: never; + $unknown?: never; + } + + /** + *

    A leaf node condition which can be used to specify a tag condition.

    + * @public + */ + export interface TagConditionMember { + andConditions?: never; + tagCondition: TagCondition; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + andConditions?: never; + tagCondition?: never; + $unknown: [string, any]; + } + + export interface Visitor { + andConditions: (value: TagCondition[]) => T; + tagCondition: (value: TagCondition) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: OrCondition, visitor: Visitor): T => { + if (value.andConditions !== undefined) return visitor.andConditions(value.andConditions); + if (value.tagCondition !== undefined) return visitor.tagCondition(value.tagCondition); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

    An object that can be used to specify Tag conditions.

    + * @public + */ +export type TagFilter = + | TagFilter.AndConditionsMember + | TagFilter.OrConditionsMember + | TagFilter.TagConditionMember + | TagFilter.$UnknownMember; + +/** + * @public + */ +export namespace TagFilter { + /** + *

    A leaf node condition which can be used to specify a tag condition.

    + * @public + */ + export interface TagConditionMember { + tagCondition: TagCondition; + andConditions?: never; + orConditions?: never; + $unknown?: never; + } + + /** + *

    A list of conditions which would be applied together with an AND condition.

    + * @public + */ + export interface AndConditionsMember { + tagCondition?: never; + andConditions: TagCondition[]; + orConditions?: never; + $unknown?: never; + } + + /** + *

    A list of conditions which would be applied together with an OR condition.

    + * @public + */ + export interface OrConditionsMember { + tagCondition?: never; + andConditions?: never; + orConditions: OrCondition[]; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + tagCondition?: never; + andConditions?: never; + orConditions?: never; + $unknown: [string, any]; + } + + export interface Visitor { + tagCondition: (value: TagCondition) => T; + andConditions: (value: TagCondition[]) => T; + orConditions: (value: OrCondition[]) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: TagFilter, visitor: Visitor): T => { + if (value.tagCondition !== undefined) return visitor.tagCondition(value.tagCondition); + if (value.andConditions !== undefined) return visitor.andConditions(value.andConditions); + if (value.orConditions !== undefined) return visitor.orConditions(value.orConditions); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + /** * @public */ @@ -1888,7 +2028,7 @@ export interface CreateSessionRequest { clientToken?: string; /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -1910,6 +2050,12 @@ export interface CreateSessionRequest { * @public */ tags?: Record; + + /** + *

    An object that can be used to specify Tag conditions.

    + * @public + */ + tagFilter?: TagFilter; } /** @@ -1964,6 +2110,12 @@ export interface SessionData { * @public */ integrationConfiguration?: SessionIntegrationConfiguration; + + /** + *

    An object that can be used to specify Tag conditions.

    + * @public + */ + tagFilter?: TagFilter; } /** @@ -1982,7 +2134,7 @@ export interface CreateSessionResponse { */ export interface GetSessionRequest { /** - *

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ assistantId: string | undefined; @@ -2005,6 +2157,46 @@ export interface GetSessionResponse { session?: SessionData; } +/** + * @public + */ +export interface UpdateSessionRequest { + /** + *

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + * @public + */ + assistantId: string | undefined; + + /** + *

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

    + * @public + */ + sessionId: string | undefined; + + /** + *

    The description.

    + * @public + */ + description?: string; + + /** + *

    An object that can be used to specify Tag conditions.

    + * @public + */ + tagFilter?: TagFilter; +} + +/** + * @public + */ +export interface UpdateSessionResponse { + /** + *

    Information about the session.

    + * @public + */ + session?: SessionData; +} + /** *

    The configuration information of the Amazon Connect data source.

    * @public @@ -2060,8 +2252,7 @@ export namespace Configuration { */ export interface CreateContentRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ knowledgeBaseId: string | undefined; @@ -2069,7 +2260,8 @@ export interface CreateContentRequest { /** *

    The name of the content. Each piece of content in a knowledge base must have a unique * name. You can retrieve a piece of content using only its knowledge base and its name with the - * SearchContent API.

    + * SearchContent + * API.

    * @public */ name: string | undefined; @@ -2089,7 +2281,7 @@ export interface CreateContentRequest { /** *

    A key/value map to store attributes without affecting tagging or recommendations. - * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    + * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    * @public */ metadata?: Record; @@ -2159,8 +2351,7 @@ export interface ContentData { knowledgeBaseArn: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -2197,7 +2388,7 @@ export interface ContentData { /** *

    A key/value map to store attributes without affecting tagging or recommendations. - * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    + * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    * @public */ metadata: Record | undefined; @@ -2243,8 +2434,7 @@ export interface CreateContentResponse { */ export interface DeleteContentRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -2272,8 +2462,7 @@ export interface GetContentRequest { contentId: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ knowledgeBaseId: string | undefined; @@ -2301,8 +2490,7 @@ export interface GetContentSummaryRequest { contentId: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -2332,8 +2520,7 @@ export interface ContentSummary { knowledgeBaseArn: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -2370,7 +2557,7 @@ export interface ContentSummary { /** *

    A key/value map to store attributes without affecting tagging or recommendations. - * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    + * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    * @public */ metadata: Record | undefined; @@ -2411,8 +2598,7 @@ export interface ListContentsRequest { maxResults?: number; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ knowledgeBaseId: string | undefined; @@ -2461,8 +2647,7 @@ export class PreconditionFailedException extends __BaseException { */ export interface UpdateContentRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

    * @public */ knowledgeBaseId: string | undefined; @@ -2505,15 +2690,14 @@ export interface UpdateContentRequest { /** *

    A key/value map to store attributes without affecting tagging or recommendations. For - * example, when synchronizing data between an external system and Amazon Q, you can store an + * example, when synchronizing data between an external system and Amazon Q in Connect, you can store an * external version identifier as metadata to utilize for determining drift.

    * @public */ metadata?: Record; /** - *

    A pointer to the uploaded asset. This value is returned by StartContentUpload. - *

    + *

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

    * @public */ uploadId?: string; @@ -2660,8 +2844,8 @@ export interface CreateKnowledgeBaseRequest { *

    This KMS key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + * key to invoke Amazon Q in Connect.

    + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ @@ -2704,8 +2888,7 @@ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof Know */ export interface KnowledgeBaseData { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -2758,8 +2941,8 @@ export interface KnowledgeBaseData { *

    This KMS key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + * key to invoke Amazon Q in Connect.

    + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ @@ -2830,18 +3013,18 @@ export namespace QuickResponseDataProvider { } /** - *

    The configuration information of the grouping of Amazon Q users.

    + *

    The configuration information of the grouping of Amazon Q in Connect users.

    * @public */ export interface GroupingConfiguration { /** - *

    The criteria used for grouping Amazon Q users.

    + *

    The criteria used for grouping Amazon Q in Connect users.

    *

    The following is the list of supported criteria values.

    * * @public @@ -2849,11 +3032,12 @@ export interface GroupingConfiguration { criteria?: string; /** - *

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

    + *

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

    * * @public @@ -2866,8 +3050,7 @@ export interface GroupingConfiguration { */ export interface CreateQuickResponseRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -2888,10 +3071,12 @@ export interface CreateQuickResponseRequest { *

    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=plain for a quick response written + * in plain text.

      *
      • *
    • - *

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

      + *

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

      *
      • *
    * @public @@ -2899,7 +3084,8 @@ export interface CreateQuickResponseRequest { contentType?: string; /** - *

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

    + *

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

    * @public */ groupingConfiguration?: GroupingConfiguration; @@ -2912,8 +3098,7 @@ export interface CreateQuickResponseRequest { /** *

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

    + * knowledge base.

    * @public */ shortcutKey?: string; @@ -2931,7 +3116,7 @@ export interface CreateQuickResponseRequest { channels?: 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, + *

    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 *

    @@ -3057,8 +3242,7 @@ export interface QuickResponseData { knowledgeBaseArn: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3073,10 +3257,12 @@ export interface QuickResponseData { *

    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=plain for quick response written + * in plain text.

      *
      • *
    • - *

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

      + *

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

      *
      • *
    * @public @@ -3114,7 +3300,8 @@ export interface QuickResponseData { description?: string; /** - *

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

    + *

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

    * @public */ groupingConfiguration?: GroupingConfiguration; @@ -3127,7 +3314,8 @@ export interface QuickResponseData { shortcutKey?: string; /** - *

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

    + *

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

    * @public */ lastModifiedBy?: string; @@ -3139,7 +3327,8 @@ export interface QuickResponseData { isActive?: boolean; /** - *

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

    + *

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

    * @public */ channels?: string[]; @@ -3173,8 +3362,7 @@ export interface CreateQuickResponseResponse { */ export interface DeleteImportJobRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3212,8 +3400,7 @@ export interface DeleteKnowledgeBaseResponse {} */ export interface DeleteQuickResponseRequest { /** - *

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3321,8 +3508,7 @@ export interface ImportJobData { importJobId: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3382,7 +3568,7 @@ export interface ImportJobData { lastModifiedTime: Date | undefined; /** - *

    The metadata fields of the imported Amazon Q resources.

    + *

    The metadata fields of the imported Amazon Q in Connect resources.

    * @public */ metadata?: Record; @@ -3410,8 +3596,7 @@ export interface GetImportJobResponse { */ export interface GetKnowledgeBaseRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3468,8 +3653,7 @@ export interface ImportJobSummary { importJobId: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3511,13 +3695,14 @@ export interface ImportJobSummary { lastModifiedTime: Date | undefined; /** - *

    The metadata fields of the imported Amazon Q resources.

    + *

    The metadata fields of the imported Amazon Q in Connect resources.

    * @public */ metadata?: Record; /** - *

    The configuration information of the external source that the resource data are imported from.

    + *

    The configuration information of the external source that the resource data are imported + * from.

    * @public */ externalSourceConfiguration?: ExternalSourceConfiguration; @@ -3541,8 +3726,7 @@ export interface ListImportJobsRequest { maxResults?: number; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3590,8 +3774,7 @@ export interface ListKnowledgeBasesRequest { */ export interface KnowledgeBaseSummary { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3637,8 +3820,8 @@ export interface KnowledgeBaseSummary { *

    This KMS key must have a policy that allows kms:CreateGrant, * kms:DescribeKey, kms:Decrypt, and * kms:GenerateDataKey* permissions to the IAM identity using the - * key to invoke Amazon Q.

    - *

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for + * key to invoke Amazon Q in Connect.

    + *

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for * your instance.

    * @public */ @@ -3692,8 +3875,7 @@ export interface ListQuickResponsesRequest { maxResults?: number; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3723,8 +3905,7 @@ export interface QuickResponseSummary { knowledgeBaseArn: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it.

    + *

    The identifier of the knowledge base.

    * @public */ knowledgeBaseId: string | undefined; @@ -3739,10 +3920,12 @@ export interface QuickResponseSummary { *

    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=plain for quick response written + * in plain text.

      *
      • *
    • - *

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

      + *

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

      *
      • *
    * @public @@ -3774,7 +3957,8 @@ export interface QuickResponseSummary { description?: string; /** - *

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

    + *

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

    * @public */ lastModifiedBy?: string; @@ -3786,7 +3970,8 @@ export interface QuickResponseSummary { isActive?: boolean; /** - *

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

    + *

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

    * @public */ channels?: string[]; @@ -3821,8 +4006,7 @@ export interface ListQuickResponsesResponse { */ export interface UpdateQuickResponseRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3849,10 +4033,12 @@ export interface UpdateQuickResponseRequest { *

    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=plain for quick response written + * in plain text.

      *
      • *
    • - *

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

      + *

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

      *
      • *
    * @public @@ -3903,7 +4089,8 @@ export interface UpdateQuickResponseRequest { isActive?: boolean; /** - *

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

    + *

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

    * @public */ channels?: string[]; @@ -3934,8 +4121,7 @@ export interface UpdateQuickResponseResponse { */ export interface RemoveKnowledgeBaseTemplateUriRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -3964,8 +4150,7 @@ export interface SearchContentRequest { maxResults?: number; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ knowledgeBaseId: string | undefined; @@ -4217,14 +4402,15 @@ export interface QuickResponseQueryField { operator: QuickResponseQueryOperator | undefined; /** - *

    Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

    + *

    Whether the query expects only exact matches on the attribute field values. The results of + * the query will only include exact matches if this parameter is set to false.

    * @public */ allowFuzziness?: boolean; /** - *

    The importance of the attribute field when calculating query result relevancy scores. - * The value set for this parameter affects the ordering of search results.

    + *

    The importance of the attribute field when calculating query result relevancy scores. The + * value set for this parameter affects the ordering of search results.

    * @public */ priority?: Priority; @@ -4284,7 +4470,8 @@ export interface SearchQuickResponsesRequest { maxResults?: number; /** - *

    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

    + *

    The user-defined Amazon Connect contact attributes to be resolved when search + * results are returned.

    * @public */ attributes?: Record; @@ -4314,8 +4501,7 @@ export interface QuickResponseSearchResultData { knowledgeBaseArn: string | undefined; /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -4330,10 +4516,12 @@ export interface QuickResponseSearchResultData { *

    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=plain for quick response written + * in plain text.

      *
      • *
    • - *

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

      + *

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

      *
      • *
    * @public @@ -4377,7 +4565,8 @@ export interface QuickResponseSearchResultData { description?: string; /** - *

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

    + *

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

    * @public */ groupingConfiguration?: GroupingConfiguration; @@ -4390,13 +4579,15 @@ export interface QuickResponseSearchResultData { shortcutKey?: string; /** - *

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

    + *

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

    * @public */ lastModifiedBy?: string; /** - *

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

    + *

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

    * @public */ channels?: string[]; @@ -4408,13 +4599,15 @@ export interface QuickResponseSearchResultData { language?: string; /** - *

    The user defined contact attributes that are not resolved when the search result is returned.

    + *

    The user defined contact attributes that are not resolved when the search result is + * returned.

    * @public */ attributesNotInterpolated?: string[]; /** - *

    The user defined contact attributes that are resolved when the search result is returned.

    + *

    The user defined contact attributes that are resolved when the search result is + * returned.

    * @public */ attributesInterpolated?: string[]; @@ -4449,8 +4642,7 @@ export interface SearchQuickResponsesResponse { */ export interface StartContentUploadRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    * @public */ knowledgeBaseId: string | undefined; @@ -4502,11 +4694,11 @@ export interface StartContentUploadResponse { */ export interface StartImportJobRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

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

    *
      *
    • - *

      For importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.

      + *

      For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES + * type knowledge base.

      *
      • *
    * @public @@ -4517,7 +4709,8 @@ export interface StartImportJobRequest { *

    The type of the import job.

    *
      *
    • - *

      For importing quick response resource, set the value to QUICK_RESPONSES.

      + *

      For importing quick response resource, set the value to + * QUICK_RESPONSES.

      *
      • *
    * @public @@ -4537,13 +4730,14 @@ export interface StartImportJobRequest { clientToken?: string; /** - *

    The metadata fields of the imported Amazon Q resources.

    + *

    The metadata fields of the imported Amazon Q in Connect resources.

    * @public */ metadata?: Record; /** - *

    The configuration information of the external source that the resource data are imported from.

    + *

    The configuration information of the external source that the resource data are imported + * from.

    * @public */ externalSourceConfiguration?: ExternalSourceConfiguration; @@ -4565,8 +4759,7 @@ export interface StartImportJobResponse { */ export interface UpdateKnowledgeBaseTemplateUriRequest { /** - *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge - * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    + *

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    * @public */ knowledgeBaseId: string | undefined; diff --git a/clients/client-qconnect/src/protocols/Aws_restJson1.ts b/clients/client-qconnect/src/protocols/Aws_restJson1.ts index 14d62b2d34a4..6677fc8f06b0 100644 --- a/clients/client-qconnect/src/protocols/Aws_restJson1.ts +++ b/clients/client-qconnect/src/protocols/Aws_restJson1.ts @@ -115,6 +115,7 @@ import { UpdateQuickResponseCommandInput, UpdateQuickResponseCommandOutput, } from "../commands/UpdateQuickResponseCommand"; +import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "../commands/UpdateSessionCommand"; import { AccessDeniedException, AppIntegrationsConfiguration, @@ -135,6 +136,7 @@ import { ImportJobData, ImportJobSummary, KnowledgeBaseData, + OrCondition, PreconditionFailedException, QueryCondition, QueryConditionItem, @@ -157,6 +159,8 @@ import { ServiceQuotaExceededException, SourceConfiguration, SourceContentDataDetails, + TagCondition, + TagFilter, TooManyTagsException, ValidationException, } from "../models/models_0"; @@ -325,6 +329,7 @@ export const se_CreateSessionCommand = async ( clientToken: [true, (_) => _ ?? generateIdempotencyToken()], description: [], name: [], + tagFilter: (_) => _json(_), tags: (_) => _json(_), }) ); @@ -1078,6 +1083,31 @@ export const se_UpdateQuickResponseCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1UpdateSessionCommand + */ +export const se_UpdateSessionCommand = async ( + input: UpdateSessionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/assistants/{assistantId}/sessions/{sessionId}"); + b.p("assistantId", () => input.assistantId!, "{assistantId}", false); + b.p("sessionId", () => input.sessionId!, "{sessionId}", false); + let body: any; + body = JSON.stringify( + take(input, { + description: [], + tagFilter: (_) => _json(_), + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * deserializeAws_restJson1CreateAssistantCommand */ @@ -1943,6 +1973,27 @@ export const de_UpdateQuickResponseCommand = async ( return contents; }; +/** + * deserializeAws_restJson1UpdateSessionCommand + */ +export const de_UpdateSessionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + session: _json, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserialize_Aws_restJson1CommandError */ @@ -2144,6 +2195,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont return __decorateServiceException(exception, parsedOutput.body); }; +// se_AndConditions omitted. + // se_AppIntegrationsConfiguration omitted. // se_AssistantAssociationInputData omitted. @@ -2174,6 +2227,10 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_ObjectFieldsList omitted. +// se_OrCondition omitted. + +// se_OrConditions omitted. + // se_QueryCondition omitted. // se_QueryConditionExpression omitted. @@ -2208,8 +2265,14 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_SourceConfiguration omitted. +// se_TagCondition omitted. + +// se_TagFilter omitted. + // se_Tags omitted. +// de_AndConditions omitted. + // de_AppIntegrationsConfiguration omitted. // de_AssistantAssociationData omitted. @@ -2439,6 +2502,10 @@ const de_KnowledgeBaseData = (output: any, context: __SerdeContext): KnowledgeBa // de_ObjectFieldsList omitted. +// de_OrCondition omitted. + +// de_OrConditions omitted. + // de_QueryRecommendationTriggerData omitted. /** @@ -2640,6 +2707,10 @@ const de_SourceContentDataDetails = (output: any, context: __SerdeContext): Sour }) as any; }; +// de_TagCondition omitted. + +// de_TagFilter omitted. + // de_Tags omitted. // de_TextData omitted. diff --git a/codegen/sdk-codegen/aws-models/qconnect.json b/codegen/sdk-codegen/aws-models/qconnect.json index cb282f736abd..fd2e320c0839 100644 --- a/codegen/sdk-codegen/aws-models/qconnect.json +++ b/codegen/sdk-codegen/aws-models/qconnect.json @@ -14,6 +14,12 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.qconnect#AndConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#TagCondition" + } + }, "com.amazonaws.qconnect#AppIntegrationsConfiguration": { "type": "structure", "members": { @@ -27,7 +33,7 @@ "objectFields": { "target": "com.amazonaws.qconnect#ObjectFieldsList", "traits": { - "smithy.api#documentation": "

    The fields from the source that are made available to your agents in Amazon Q. Optional if\n ObjectConfiguration is included in the provided DataIntegration.

    \n
      \n
    • \n

      For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.

      \n
      • \n
    • \n

      For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.

      \n
      • \n
    • \n

      For \n Zendesk, you must include at least id, title,\n updated_at, and draft.

      \n
      • \n
    \n

    Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

    " + "smithy.api#documentation": "

    The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.

    \n
      \n
    • \n

      For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.

      \n
      • \n
    • \n

      For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.

      \n
      • \n
    • \n

      For \n Zendesk, you must include at least id, title,\n updated_at, and draft.

      \n
      • \n
    \n

    Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

    " } } }, @@ -143,14 +149,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, @@ -190,12 +196,12 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    " + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    " } } }, "traits": { - "smithy.api#documentation": "

    The data that is input into Amazon Q as a result of the assistant association.

    " + "smithy.api#documentation": "

    The data that is input into Amazon Q in Connect as a result of the assistant association.

    " } }, "com.amazonaws.qconnect#AssistantAssociationOutputData": { @@ -232,14 +238,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, @@ -285,12 +291,12 @@ "type": { "target": "com.amazonaws.qconnect#AssistantCapabilityType", "traits": { - "smithy.api#documentation": "

    The type of Amazon Q assistant capability.

    " + "smithy.api#documentation": "

    The type of Amazon Q in Connect assistant capability.

    " } } }, "traits": { - "smithy.api#documentation": "

    The capability configuration for an Amazon Q assistant.

    " + "smithy.api#documentation": "

    The capability configuration for an Amazon Q in Connect assistant.

    " } }, "com.amazonaws.qconnect#AssistantCapabilityType": { @@ -314,14 +320,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, @@ -361,19 +367,19 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } }, "integrationConfiguration": { "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the Amazon Q assistant integration.

    " + "smithy.api#documentation": "

    The configuration information for the Amazon Q in Connect assistant integration.

    " } }, "capabilityConfiguration": { "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the Amazon Q assistant capability.

    " + "smithy.api#documentation": "

    The configuration information for the Amazon Q in Connect assistant capability.

    " } } }, @@ -392,7 +398,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The configuration information for the Amazon Q assistant integration.

    " + "smithy.api#documentation": "

    The configuration information for the Amazon Q in Connect assistant integration.

    " } }, "com.amazonaws.qconnect#AssistantList": { @@ -438,14 +444,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, @@ -485,19 +491,19 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } }, "integrationConfiguration": { "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the Amazon Q assistant integration.

    " + "smithy.api#documentation": "

    The configuration information for the Amazon Q in Connect assistant integration.

    " } }, "capabilityConfiguration": { "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the Amazon Q assistant capability.

    " + "smithy.api#documentation": "

    The configuration information for the Amazon Q in Connect assistant capability.

    " } } }, @@ -688,7 +694,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -730,7 +736,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    ", + "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    ", "smithy.api#required": {} } }, @@ -837,7 +843,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    " + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    " } }, "contentArn": { @@ -919,7 +925,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

    ", "smithy.api#required": {} } }, @@ -961,7 +967,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    ", + "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    ", "smithy.api#required": {} } }, @@ -1076,7 +1082,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1160,7 +1166,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    The customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    The customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } } } @@ -1202,7 +1208,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates Amazon Q content. Before to calling this API, use StartContentUpload to\n upload an asset.

    ", + "smithy.api#documentation": "

    Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents", "method": "POST" @@ -1216,7 +1222,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1224,7 +1230,7 @@ "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

    The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent API.

    ", + "smithy.api#documentation": "

    The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent\n API.

    ", "smithy.api#required": {} } }, @@ -1243,7 +1249,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.

    " + "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

    " } }, "uploadId": { @@ -1349,7 +1355,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } }, "description": { @@ -1403,7 +1409,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an Amazon Q quick response.

    ", + "smithy.api#documentation": "

    Creates an Amazon Q in Connect quick response.

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", "method": "POST" @@ -1417,7 +1423,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1439,13 +1445,13 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    " + "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    " } }, "groupingConfiguration": { "target": "com.amazonaws.qconnect#GroupingConfiguration", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "description": { @@ -1457,7 +1463,7 @@ "shortcutKey": { "target": "com.amazonaws.qconnect#ShortCutKey", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "isActive": { @@ -1475,7 +1481,7 @@ "language": { "target": "com.amazonaws.qconnect#LanguageCode", "traits": { - "smithy.api#documentation": "

    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,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

    " + "smithy.api#documentation": "

    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,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n

    " } }, "clientToken": { @@ -1519,6 +1525,9 @@ "target": "com.amazonaws.qconnect#CreateSessionResponse" }, "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, { "target": "com.amazonaws.qconnect#ConflictException" }, @@ -1530,7 +1539,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Amazon Q session for each contact on which\n Amazon Q is enabled.

    ", + "smithy.api#documentation": "

    Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which\n Amazon Q in Connect is enabled.

    ", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions", "method": "POST" @@ -1551,7 +1560,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1574,6 +1583,12 @@ "traits": { "smithy.api#documentation": "

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

    " } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "

    An object that can be used to specify Tag conditions.

    " + } } } }, @@ -1731,7 +1746,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1748,7 +1763,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1794,7 +1809,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1851,7 +1866,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1960,7 +1975,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2276,7 +2291,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2300,7 +2315,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2360,7 +2375,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2420,7 +2435,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2538,7 +2553,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2645,7 +2660,7 @@ "smithy.api#deprecated": { "message": "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, - "smithy.api#documentation": "

    Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

    ", + "smithy.api#documentation": "\n

    This API will be discontinued starting June 1, 2024. To receive generative responses\n after March 1, 2024, you will need to create a new Assistant in the Amazon Connect\n console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into\n your applications.

    \n     \n

    Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

    ", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations", "method": "GET" @@ -2659,7 +2674,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2741,7 +2756,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2773,18 +2788,18 @@ "criteria": { "target": "com.amazonaws.qconnect#GroupingCriteria", "traits": { - "smithy.api#documentation": "

    The criteria used for grouping Amazon Q users.

    \n

    The following is the list of supported criteria values.

    \n " + "smithy.api#documentation": "

    The criteria used for grouping Amazon Q in Connect users.

    \n

    The following is the list of supported criteria values.

    \n " } }, "values": { "target": "com.amazonaws.qconnect#GroupingValues", "traits": { - "smithy.api#documentation": "

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

    \n
      \n
    • \n

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

      \n
      • \n
    " + "smithy.api#documentation": "

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

    \n " } } }, "traits": { - "smithy.api#documentation": "

    The configuration information of the grouping of Amazon Q users.

    " + "smithy.api#documentation": "

    The configuration information of the grouping of Amazon Q in Connect users.

    " } }, "com.amazonaws.qconnect#GroupingCriteria": { @@ -2872,7 +2887,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -2944,7 +2959,7 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q resources.

    " + "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q in Connect resources.

    " } }, "externalSourceConfiguration": { @@ -3005,7 +3020,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -3056,13 +3071,13 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q resources.

    " + "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q in Connect resources.

    " } }, "externalSourceConfiguration": { "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information of the external source that the resource data are imported from.

    " + "smithy.api#documentation": "

    The configuration information of the external source that the resource data are imported\n from.

    " } } }, @@ -3151,7 +3166,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    " + "smithy.api#documentation": "

    The identifier of the knowledge base.

    " } }, "knowledgeBaseArn": { @@ -3171,7 +3186,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -3225,7 +3240,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } }, "description": { @@ -3293,7 +3308,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -3340,7 +3355,7 @@ "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q.

    \n

    For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for\n your instance.

    " + "smithy.api#documentation": "

    The configuration information for the customer managed key used for encryption.

    \n

    This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.

    \n

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

    " } }, "description": { @@ -3447,7 +3462,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3594,7 +3609,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3670,7 +3685,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3823,7 +3838,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4009,7 +4024,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4060,6 +4075,32 @@ } } }, + "com.amazonaws.qconnect#OrCondition": { + "type": "union", + "members": { + "andConditions": { + "target": "com.amazonaws.qconnect#AndConditions", + "traits": { + "smithy.api#documentation": "

    A list of conditions which would be applied together with an AND condition.

    " + } + }, + "tagCondition": { + "target": "com.amazonaws.qconnect#TagCondition", + "traits": { + "smithy.api#documentation": "

    A leaf node condition which can be used to specify a tag condition.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A list of conditions which would be applied together with an OR condition.

    " + } + }, + "com.amazonaws.qconnect#OrConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#OrCondition" + } + }, "com.amazonaws.qconnect#Order": { "type": "string", "traits": { @@ -4127,7 +4168,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

    ", + "smithy.api#documentation": "

    Provides feedback against the specified assistant for the specified target. This API only\n supports generative targets.

    ", "smithy.api#http": { "uri": "/assistants/{assistantId}/feedback", "method": "PUT" @@ -4141,7 +4182,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4178,14 +4219,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, @@ -4241,7 +4282,7 @@ "smithy.api#deprecated": { "message": "QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, - "smithy.api#documentation": "

    Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n

    ", + "smithy.api#documentation": "\n

    This API will be discontinued starting June 1, 2024. To receive generative responses\n after March 1, 2024, you will need to create a new Assistant in the Amazon Connect\n console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into\n your applications.

    \n     \n

    Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.

    ", "smithy.api#http": { "uri": "/assistants/{assistantId}/query", "method": "POST" @@ -4262,7 +4303,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4289,7 +4330,7 @@ "sessionId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot\n contain the ARN.

    " + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot\n contain the ARN.

    " } }, "queryCondition": { @@ -4536,7 +4577,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#required": {} } }, @@ -4550,7 +4591,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", + "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -4592,7 +4633,7 @@ "groupingConfiguration": { "target": "com.amazonaws.qconnect#GroupingConfiguration", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "shortcutKey": { @@ -4604,7 +4645,7 @@ "lastModifiedBy": { "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "isActive": { @@ -4616,7 +4657,7 @@ "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "language": { @@ -4807,13 +4848,13 @@ "allowFuzziness": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

    Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

    " + "smithy.api#documentation": "

    Whether the query expects only exact matches on the attribute field values. The results of\n the query will only include exact matches if this parameter is set to false.

    " } }, "priority": { "target": "com.amazonaws.qconnect#Priority", "traits": { - "smithy.api#documentation": "

    The importance of the attribute field when calculating query result relevancy scores.\n The value set for this parameter affects the ordering of search results.

    " + "smithy.api#documentation": "

    The importance of the attribute field when calculating query result relevancy scores. The\n value set for this parameter affects the ordering of search results.

    " } } }, @@ -4923,7 +4964,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#required": {} } }, @@ -4937,7 +4978,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", + "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -4987,7 +5028,7 @@ "groupingConfiguration": { "target": "com.amazonaws.qconnect#GroupingConfiguration", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "shortcutKey": { @@ -4999,13 +5040,13 @@ "lastModifiedBy": { "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "language": { @@ -5017,13 +5058,13 @@ "attributesNotInterpolated": { "target": "com.amazonaws.qconnect#ContactAttributeKeys", "traits": { - "smithy.api#documentation": "

    The user defined contact attributes that are not resolved when the search result is returned.

    " + "smithy.api#documentation": "

    The user defined contact attributes that are not resolved when the search result is\n returned.

    " } }, "attributesInterpolated": { "target": "com.amazonaws.qconnect#ContactAttributeKeys", "traits": { - "smithy.api#documentation": "

    The user defined contact attributes that are resolved when the search result is returned.

    " + "smithy.api#documentation": "

    The user defined contact attributes that are resolved when the search result is\n returned.

    " } }, "tags": { @@ -5117,7 +5158,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base.

    ", "smithy.api#required": {} } }, @@ -5131,7 +5172,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", + "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -5167,7 +5208,7 @@ "lastModifiedBy": { "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "isActive": { @@ -5179,7 +5220,7 @@ "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "tags": { @@ -5500,7 +5541,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5652,7 +5693,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5722,7 +5763,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses", "method": "POST" @@ -5771,7 +5812,7 @@ "attributes": { "target": "com.amazonaws.qconnect#ContactAttributes", "traits": { - "smithy.api#documentation": "

    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

    " + "smithy.api#documentation": "

    The user-defined Amazon Connect contact attributes to be resolved when search\n results are returned.

    " } } }, @@ -5854,7 +5895,7 @@ "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5898,7 +5939,7 @@ "kmsKeyId": { "target": "com.amazonaws.qconnect#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The customer managed key used for encryption. For more information about setting up a\n customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.\n For information about valid ID values, see Key identifiers (KeyId).

    " + "smithy.api#documentation": "

    The customer managed key used for encryption. For more information about setting up a\n customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.\n For information about valid ID values, see Key identifiers (KeyId).

    " } } }, @@ -5935,6 +5976,9 @@ "read": { "target": "com.amazonaws.qconnect#GetSession" }, + "update": { + "target": "com.amazonaws.qconnect#UpdateSession" + }, "traits": { "aws.api#arn": { "template": "session/{assistantId}/{sessionId}" @@ -5983,6 +6027,12 @@ "traits": { "smithy.api#documentation": "

    The configuration information for the session integration.

    " } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "

    An object that can be used to specify Tag conditions.

    " + } } }, "traits": { @@ -6029,14 +6079,14 @@ "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q assistant.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    ", "smithy.api#required": {} } } @@ -6135,7 +6185,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.

    ", + "smithy.api#documentation": "

    Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to\n finalize the content creation process or UpdateContent to\n modify an existing resource. You can only upload content to a knowledge base of type\n CUSTOM.

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/upload", "method": "POST" @@ -6148,7 +6198,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6228,7 +6278,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.

    \n
      \n
    • \n

      For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.\n Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.

    \n
      \n
    • \n

      For importing Amazon Q in Connect quick responses, you need to upload a csv file including the\n quick responses. For information about how to format the csv file for importing quick\n responses, see Import quick responses.

      \n
      • \n
    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", "method": "POST" @@ -6242,7 +6292,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    \n
      \n
    • \n

      For importing Amazon Q quick responses, this should be a QUICK_RESPONSES type knowledge base.

      \n
      • \n
    ", + "smithy.api#documentation": "

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

    \n
      \n
    • \n

      For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES\n type knowledge base.

      \n
      • \n
    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6250,7 +6300,7 @@ "importJobType": { "target": "com.amazonaws.qconnect#ImportJobType", "traits": { - "smithy.api#documentation": "

    The type of the import job.

    \n
      \n
    • \n

      For importing quick response resource, set the value to QUICK_RESPONSES.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The type of the import job.

    \n
      \n
    • \n

      For importing quick response resource, set the value to\n QUICK_RESPONSES.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -6271,13 +6321,13 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q resources.

    " + "smithy.api#documentation": "

    The metadata fields of the imported Amazon Q in Connect resources.

    " } }, "externalSourceConfiguration": { "target": "com.amazonaws.qconnect#ExternalSourceConfiguration", "traits": { - "smithy.api#documentation": "

    The configuration information of the external source that the resource data are imported from.

    " + "smithy.api#documentation": "

    The configuration information of the external source that the resource data are imported\n from.

    " } } }, @@ -6299,6 +6349,53 @@ "smithy.api#output": {} } }, + "com.amazonaws.qconnect#TagCondition": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qconnect#TagKey", + "traits": { + "smithy.api#documentation": "

    The tag key in the tag condition.

    ", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.qconnect#TagValue", + "traits": { + "smithy.api#documentation": "

    The tag value in the tag condition.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A leaf node condition which can be used to specify a tag condition.\n

    " + } + }, + "com.amazonaws.qconnect#TagFilter": { + "type": "union", + "members": { + "tagCondition": { + "target": "com.amazonaws.qconnect#TagCondition", + "traits": { + "smithy.api#documentation": "

    A leaf node condition which can be used to specify a tag condition.

    " + } + }, + "andConditions": { + "target": "com.amazonaws.qconnect#AndConditions", + "traits": { + "smithy.api#documentation": "

    A list of conditions which would be applied together with an AND condition.

    " + } + }, + "orConditions": { + "target": "com.amazonaws.qconnect#OrConditions", + "traits": { + "smithy.api#documentation": "

    A list of conditions which would be applied together with an OR condition.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object that can be used to specify Tag conditions.

    " + } + }, "com.amazonaws.qconnect#TagKey": { "type": "string", "traits": { @@ -6529,7 +6626,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6569,13 +6666,13 @@ "metadata": { "target": "com.amazonaws.qconnect#ContentMetadata", "traits": { - "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Amazon Q, you can store an\n external version identifier as metadata to utilize for determining drift.

    " + "smithy.api#documentation": "

    A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Amazon Q in Connect, you can store an\n external version identifier as metadata to utilize for determining drift.

    " } }, "uploadId": { "target": "com.amazonaws.qconnect#UploadId", "traits": { - "smithy.api#documentation": "

    A pointer to the uploaded asset. This value is returned by StartContentUpload.\n

    " + "smithy.api#documentation": "

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

    " } } } @@ -6611,7 +6708,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n

    ", + "smithy.api#documentation": "

    Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", "method": "POST" @@ -6624,7 +6721,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6675,7 +6772,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing Amazon Q quick response.

    ", + "smithy.api#documentation": "

    Updates an existing Amazon Q in Connect quick response.

    ", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "method": "POST" @@ -6688,7 +6785,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#documentation": "

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

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6716,7 +6813,7 @@ "contentType": { "target": "com.amazonaws.qconnect#QuickResponseType", "traits": { - "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    " + "smithy.api#documentation": "

    The media type of the quick response content.

    \n
      \n
    • \n

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

      \n
      • \n
    • \n

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

      \n
      • \n
    " } }, "groupingConfiguration": { @@ -6764,7 +6861,7 @@ "channels": { "target": "com.amazonaws.qconnect#Channels", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "language": { @@ -6792,6 +6889,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.qconnect#UpdateSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateSessionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates a session. A session is a contextual container used for generating recommendations.\n Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect\n is enabled.

    ", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#UpdateSessionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

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

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

    The description.

    " + } + }, + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "

    An object that can be used to specify Tag conditions.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#UploadId": { "type": "string", "traits": { @@ -6888,7 +7059,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "\n

    \n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full\n advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the\n responsible use of artificial intelligence (AI).

    \n     \n

    Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution\n of Amazon Connect Wisdom that delivers real-time recommendations to help contact center\n agents resolve customer issues quickly and accurately.

    \n

    Amazon Q automatically detects customer intent during calls and chats using\n conversational analytics and natural language understanding (NLU). It then provides agents\n with immediate, real-time generative responses and suggested actions, and links to relevant\n documents and articles. Agents can also query Amazon Q directly using natural language or\n keywords to answer customer requests.

    \n

    Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.

    \n

    For more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.

    ", + "smithy.api#documentation": "\n

    \n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).

    \n     \n

    Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.

    \n

    Amazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.

    \n

    Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.

    \n

    For more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.

    ", "smithy.api#title": "Amazon Q Connect", "smithy.rules#endpointRuleSet": { "version": "1.0",