QConnectClient
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).
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 powered agent assistance in real-time in the Amazon Connect Administrator Guide.
Functions
Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.
Creates an Amazon Q in Connect AI Agent.
Creates and Amazon Q in Connect AI Agent version.
Creates an Amazon Q in Connect AI Guardrail.
Creates an Amazon Q in Connect AI Guardrail version.
Creates an Amazon Q in Connect AI Prompt.
Creates an Amazon Q in Connect AI Prompt version.
Creates an Amazon Q in Connect assistant.
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
Creates a knowledge base.
Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
Creates an Amazon Q in Connect quick response.
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.
Deletes an Amazon Q in Connect AI Agent.
Deletes an Amazon Q in Connect AI Agent Version.
Deletes an Amazon Q in Connect AI Guardrail.
Delete and Amazon Q in Connect AI Guardrail version.
Deletes an Amazon Q in Connect AI Prompt.
Delete and Amazon Q in Connect AI Prompt version.
Deletes an assistant.
Deletes an assistant association.
Deletes the content.
Deletes the content association.
Deletes the quick response import job.
Deletes the knowledge base.
Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
Deletes a quick response.
Gets an Amazon Q in Connect AI Agent.
Gets the Amazon Q in Connect AI Guardrail.
Gets and Amazon Q in Connect AI Prompt.
Retrieves information about an assistant.
Retrieves information about an assistant association.
Retrieves content, including a pre-signed URL to download the content.
Returns the content association.
Retrieves summary information about the content.
Retrieves the started import job.
Retrieves information about the knowledge base.
Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
Retrieves next message on an Amazon Q in Connect session.
Retrieves the quick response.
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 information for a specified session.
Lists AI Agents.
List AI Agent versions.
Lists the AI Guardrails available on the Amazon Q in Connect assistant.
Lists AI Guardrail versions.
Lists the AI Prompts available on the Amazon Q in Connect assistant.
Lists AI Prompt versions.
Lists information about assistant associations.
Lists information about assistants.
Lists the content associations.
Lists the content.
Lists information about import jobs.
Lists the knowledge bases.
Lists messages on an Amazon Q in Connect session.
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
Lists all the available versions for the specified Amazon Q in Connect message template.
Lists information about quick response.
Lists the tags for the specified resource.
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
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.
Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Removes a URI template from a knowledge base.
Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
Searches for Amazon Q in Connect message templates in the specified knowledge base.
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
Searches for sessions.
Submits a message to the Amazon Q in Connect session.
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.
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.
Adds the specified tags to the specified resource.
Removes the specified tags from the specified resource.
Updates an AI Agent.
Updates an AI Guardrail.
Updates an AI Prompt.
Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Updates information about the content.
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 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.
Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
Updates an existing Amazon Q in Connect quick response.
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.
Updates the data stored on an Amazon Q in Connect Session.
Inherited functions
Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.
Creates an Amazon Q in Connect AI Agent.
Creates and Amazon Q in Connect AI Agent version.
Creates an Amazon Q in Connect AI Guardrail.
Creates an Amazon Q in Connect AI Guardrail version.
Creates an Amazon Q in Connect AI Prompt.
Creates an Amazon Q in Connect AI Prompt version.
Creates an Amazon Q in Connect assistant.
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
Creates a knowledge base.
Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
Creates an Amazon Q in Connect quick response.
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.
Deletes an Amazon Q in Connect AI Agent.
Deletes an Amazon Q in Connect AI Agent Version.
Deletes an Amazon Q in Connect AI Guardrail.
Delete and Amazon Q in Connect AI Guardrail version.
Deletes an Amazon Q in Connect AI Prompt.
Delete and Amazon Q in Connect AI Prompt version.
Deletes an assistant.
Deletes an assistant association.
Deletes the content.
Deletes the content association.
Deletes the quick response import job.
Deletes the knowledge base.
Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
Deletes a quick response.
Gets an Amazon Q in Connect AI Agent.
Gets the Amazon Q in Connect AI Guardrail.
Gets and Amazon Q in Connect AI Prompt.
Retrieves information about an assistant.
Retrieves information about an assistant association.
Retrieves content, including a pre-signed URL to download the content.
Returns the content association.
Retrieves summary information about the content.
Retrieves the started import job.
Retrieves information about the knowledge base.
Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
Retrieves next message on an Amazon Q in Connect session.
Retrieves the quick response.
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 information for a specified session.
Lists AI Agents.
Paginate over ListAiAgentsResponse results.
List AI Agent versions.
Paginate over ListAiAgentVersionsResponse results.
Lists the AI Guardrails available on the Amazon Q in Connect assistant.
Paginate over ListAiGuardrailsResponse results.
Lists AI Guardrail versions.
Paginate over ListAiGuardrailVersionsResponse results.
Lists the AI Prompts available on the Amazon Q in Connect assistant.
Paginate over ListAiPromptsResponse results.
Lists AI Prompt versions.
Paginate over ListAiPromptVersionsResponse results.
Lists information about assistant associations.
Paginate over ListAssistantAssociationsResponse results.
Lists information about assistants.
Paginate over ListAssistantsResponse results.
Lists the content associations.
Paginate over ListContentAssociationsResponse results.
Lists the content.
Paginate over ListContentsResponse results.
Lists information about import jobs.
Paginate over ListImportJobsResponse results.
Lists the knowledge bases.
Paginate over ListKnowledgeBasesResponse results.
Lists messages on an Amazon Q in Connect session.
Paginate over ListMessagesResponse results.
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
Paginate over ListMessageTemplatesResponse results.
Lists all the available versions for the specified Amazon Q in Connect message template.
Paginate over ListMessageTemplateVersionsResponse results.
Lists information about quick response.
Paginate over ListQuickResponsesResponse results.
Lists the tags for the specified resource.
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
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.
Paginate over QueryAssistantResponse results.
Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Removes a URI template from a knowledge base.
Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
Paginate over SearchContentResponse results.
Searches for Amazon Q in Connect message templates in the specified knowledge base.
Paginate over SearchMessageTemplatesResponse results.
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
Paginate over SearchQuickResponsesResponse results.
Searches for sessions.
Paginate over SearchSessionsResponse results.
Submits a message to the Amazon Q in Connect session.
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.
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.
Adds the specified tags to the specified resource.
Removes the specified tags from the specified resource.
Updates an AI Agent.
Updates an AI Guardrail.
Updates an AI Prompt.
Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Updates information about the content.
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 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.
Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
Updates an existing Amazon Q in Connect quick response.
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.
Updates the data stored on an Amazon Q in Connect Session.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.