aws-elixir

View Source AWS.QConnect (aws-elixir v1.0.4)

*

Amazon Q actions

*

Amazon Q data types

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.

Link to this section Summary

Functions

activate_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

Activates a specific version of the Amazon Q in Connect message template.

create_a_i_agent(client, assistant_id, input, options \\ [])

Creates an Amazon Q in Connect AI Agent.

create_a_i_agent_version(client, ai_agent_id, assistant_id, input, options \\ [])

Creates and Amazon Q in Connect AI Agent version.

create_a_i_guardrail(client, assistant_id, input, options \\ [])

Creates an Amazon Q in Connect AI Guardrail.

create_a_i_guardrail_version(client, ai_guardrail_id, assistant_id, input, options \\ [])

Creates an Amazon Q in Connect AI Guardrail version.

create_a_iprompt(client, assistant_id, input, options \\ [])

Creates an Amazon Q in Connect AI Prompt.

create_a_iprompt_version(client, ai_prompt_id, assistant_id, input, options \\ [])

Creates an Amazon Q in Connect AI Prompt version.

create_assistant(client, input, options \\ [])

Creates an Amazon Q in Connect assistant.

create_assistant_association(client, assistant_id, input, options \\ [])

Creates an association between an Amazon Q in Connect assistant and another resource.

create_content(client, knowledge_base_id, input, options \\ [])

Creates Amazon Q in Connect content.

create_content_association(client, content_id, knowledge_base_id, input, options \\ [])

Creates an association between a content resource in a knowledge base and step-by-step guides.

create_knowledge_base(client, input, options \\ [])

Creates a knowledge base.

create_message_template(client, knowledge_base_id, input, options \\ [])

Creates an Amazon Q in Connect message template.

create_message_template_attachment(client, knowledge_base_id, message_template_id, input, options \\ [])

Uploads an attachment file to the specified Amazon Q in Connect message template.

create_message_template_version(client, knowledge_base_id, message_template_id, input, options \\ [])

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.

create_quick_response(client, knowledge_base_id, input, options \\ [])

Creates an Amazon Q in Connect quick response.

create_session(client, assistant_id, input, options \\ [])

Creates a session.

deactivate_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

Deactivates a specific version of the Amazon Q in Connect message template .

delete_a_i_agent(client, ai_agent_id, assistant_id, input, options \\ [])

Deletes an Amazon Q in Connect AI Agent.

delete_a_i_agent_version(client, ai_agent_id, assistant_id, version_number, input, options \\ [])

Deletes an Amazon Q in Connect AI Agent Version.

delete_a_i_guardrail(client, ai_guardrail_id, assistant_id, input, options \\ [])

Deletes an Amazon Q in Connect AI Guardrail.

delete_a_i_guardrail_version(client, ai_guardrail_id, assistant_id, version_number, input, options \\ [])

Delete and Amazon Q in Connect AI Guardrail version.

delete_a_iprompt(client, ai_prompt_id, assistant_id, input, options \\ [])

Deletes an Amazon Q in Connect AI Prompt.

delete_a_iprompt_version(client, ai_prompt_id, assistant_id, version_number, input, options \\ [])

Delete and Amazon Q in Connect AI Prompt version.

delete_assistant(client, assistant_id, input, options \\ [])

Deletes an assistant.

delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])

Deletes an assistant association.

delete_content(client, content_id, knowledge_base_id, input, options \\ [])

Deletes the content.

delete_content_association(client, content_association_id, content_id, knowledge_base_id, input, options \\ [])

Deletes the content association.

delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])

Deletes the quick response import job.

delete_knowledge_base(client, knowledge_base_id, input, options \\ [])

Deletes the knowledge base.

delete_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request.

delete_message_template_attachment(client, attachment_id, knowledge_base_id, message_template_id, input, options \\ [])

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier.

delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Deletes a quick response.

get_a_i_agent(client, ai_agent_id, assistant_id, options \\ [])

Gets an Amazon Q in Connect AI Agent.

get_a_i_guardrail(client, ai_guardrail_id, assistant_id, options \\ [])

Gets the Amazon Q in Connect AI Guardrail.

get_a_iprompt(client, ai_prompt_id, assistant_id, options \\ [])

Gets and Amazon Q in Connect AI Prompt.

get_assistant(client, assistant_id, options \\ [])

Retrieves information about an assistant.

get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])

Retrieves information about an assistant association.

get_content(client, content_id, knowledge_base_id, options \\ [])

Retrieves content, including a pre-signed URL to download the content.

get_content_association(client, content_association_id, content_id, knowledge_base_id, options \\ [])

Returns the content association.

get_content_summary(client, content_id, knowledge_base_id, options \\ [])

Retrieves summary information about the content.

get_import_job(client, import_job_id, knowledge_base_id, options \\ [])

Retrieves the started import job.

get_knowledge_base(client, knowledge_base_id, options \\ [])

Retrieves information about the knowledge base.

get_message_template(client, knowledge_base_id, message_template_id, options \\ [])

Retrieves the Amazon Q in Connect message template.

get_next_message(client, assistant_id, session_id, next_message_token, options \\ [])

Retrieves next message on an Amazon Q in Connect session.

get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])

Retrieves the quick response.

get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])

This API will be discontinued starting June 1, 2024.

get_session(client, assistant_id, session_id, options \\ [])

Retrieves information for a specified session.

list_a_i_agent_versions(client, ai_agent_id, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

List AI Agent versions.

list_a_i_agents(client, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

Lists AI Agents.

list_a_i_guardrail_versions(client, ai_guardrail_id, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists AI Guardrail versions.

list_a_i_guardrails(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

list_a_iprompt_versions(client, ai_prompt_id, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

Lists AI Prompt versions.

list_a_iprompts(client, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

Lists the AI Prompts available on the Amazon Q in Connect assistant.

list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistant associations.

list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about assistants.

list_content_associations(client, content_id, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the content associations.

list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the content.

list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about import jobs.

list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the knowledge bases.

list_message_template_versions(client, knowledge_base_id, message_template_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the available versions for the specified Amazon Q in Connect message template.

list_message_templates(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

list_messages(client, assistant_id, session_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists messages on an Amazon Q in Connect session.

list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists information about quick response.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

metadata()
notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])

Removes the specified recommendations from the specified assistant's queue of newly available recommendations.

put_feedback(client, assistant_id, input, options \\ [])

Provides feedback against the specified assistant for the specified target.

query_assistant(client, assistant_id, input, options \\ [])

This API will be discontinued starting June 1, 2024.

remove_assistant_a_i_agent(client, assistant_id, input, options \\ [])

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

Removes a URI template from a knowledge base.

render_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content.

search_content(client, knowledge_base_id, input, options \\ [])

Searches for content in a specified knowledge base.

search_message_templates(client, knowledge_base_id, input, options \\ [])

Searches for Amazon Q in Connect message templates in the specified knowledge base.

search_quick_responses(client, knowledge_base_id, input, options \\ [])

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

search_sessions(client, assistant_id, input, options \\ [])

Searches for sessions.

send_message(client, assistant_id, session_id, input, options \\ [])

Submits a message to the Amazon Q in Connect session.

start_content_upload(client, knowledge_base_id, input, options \\ [])

Get a URL to upload content to a knowledge base.

start_import_job(client, knowledge_base_id, input, options \\ [])

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.

tag_resource(client, resource_arn, input, options \\ [])

Adds the specified tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource.

update_a_i_agent(client, ai_agent_id, assistant_id, input, options \\ [])

Updates an AI Agent.

update_a_i_guardrail(client, ai_guardrail_id, assistant_id, input, options \\ [])

Updates an AI Guardrail.

update_a_iprompt(client, ai_prompt_id, assistant_id, input, options \\ [])

Updates an AI Prompt.

update_assistant_a_i_agent(client, assistant_id, input, options \\ [])

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

update_content(client, content_id, knowledge_base_id, input, options \\ [])

Updates information about the content.

update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

Updates the template URI of a knowledge base.

update_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

Updates the Amazon Q in Connect message template.

update_message_template_metadata(client, knowledge_base_id, message_template_id, input, options \\ [])

Updates the Amazon Q in Connect message template metadata.

update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

Updates an existing Amazon Q in Connect quick response.

update_session(client, assistant_id, session_id, input, options \\ [])

Updates a session.

update_session_data(client, assistant_id, session_id, input, options \\ [])

Updates the data stored on an Amazon Q in Connect Session.

Link to this section Functions

Link to this function

activate_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

create_a_i_agent(client, assistant_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect AI Agent.

Link to this function

create_a_i_agent_version(client, ai_agent_id, assistant_id, input, options \\ [])

View Source

Creates and Amazon Q in Connect AI Agent version.

Link to this function

create_a_i_guardrail(client, assistant_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect AI Guardrail.

Link to this function

create_a_i_guardrail_version(client, ai_guardrail_id, assistant_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect AI Guardrail version.

Link to this function

create_a_iprompt(client, assistant_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect AI Prompt.

Link to this function

create_a_iprompt_version(client, ai_prompt_id, assistant_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect AI Prompt version.

Link to this function

create_assistant(client, input, options \\ [])

View Source

Creates an Amazon Q in Connect assistant.

Link to this function

create_assistant_association(client, assistant_id, input, options \\ [])

View Source

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.

Link to this function

create_content(client, knowledge_base_id, input, options \\ [])

View Source

Creates Amazon Q in Connect content.

Before to calling this API, use StartContentUpload to upload an asset.

Link to this function

create_content_association(client, content_id, knowledge_base_id, input, options \\ [])

View Source

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.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

* You can create only one content association for each content resource in a knowledge base.

* You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Link to this function

create_knowledge_base(client, input, options \\ [])

View Source

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

Call DeleteKnowledgeBase.

Call DeleteDataIntegration.

Call CreateDataIntegration to recreate the DataIntegration or a create different one.

Call CreateKnowledgeBase.

Link to this function

create_message_template(client, knowledge_base_id, input, options \\ [])

View Source

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.

Link to this function

create_message_template_attachment(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

create_message_template_version(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

create_quick_response(client, knowledge_base_id, input, options \\ [])

View Source

Creates an Amazon Q in Connect quick response.

Link to this function

create_session(client, assistant_id, input, options \\ [])

View Source

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.

Link to this function

deactivate_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

delete_a_i_agent(client, ai_agent_id, assistant_id, input, options \\ [])

View Source

Deletes an Amazon Q in Connect AI Agent.

Link to this function

delete_a_i_agent_version(client, ai_agent_id, assistant_id, version_number, input, options \\ [])

View Source

Deletes an Amazon Q in Connect AI Agent Version.

Link to this function

delete_a_i_guardrail(client, ai_guardrail_id, assistant_id, input, options \\ [])

View Source

Deletes an Amazon Q in Connect AI Guardrail.

Link to this function

delete_a_i_guardrail_version(client, ai_guardrail_id, assistant_id, version_number, input, options \\ [])

View Source

Delete and Amazon Q in Connect AI Guardrail version.

Link to this function

delete_a_iprompt(client, ai_prompt_id, assistant_id, input, options \\ [])

View Source

Deletes an Amazon Q in Connect AI Prompt.

Link to this function

delete_a_iprompt_version(client, ai_prompt_id, assistant_id, version_number, input, options \\ [])

View Source

Delete and Amazon Q in Connect AI Prompt version.

Link to this function

delete_assistant(client, assistant_id, input, options \\ [])

View Source

Deletes an assistant.

Link to this function

delete_assistant_association(client, assistant_association_id, assistant_id, input, options \\ [])

View Source

Deletes an assistant association.

Link to this function

delete_content(client, content_id, knowledge_base_id, input, options \\ [])

View Source

Deletes the content.

Link to this function

delete_content_association(client, content_association_id, content_id, knowledge_base_id, input, options \\ [])

View Source

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Link to this function

delete_import_job(client, import_job_id, knowledge_base_id, input, options \\ [])

View Source

Deletes the quick response import job.

Link to this function

delete_knowledge_base(client, knowledge_base_id, input, options \\ [])

View Source

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Link to this function

delete_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

delete_message_template_attachment(client, attachment_id, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

delete_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

View Source

Deletes a quick response.

Link to this function

get_a_i_agent(client, ai_agent_id, assistant_id, options \\ [])

View Source

Gets an Amazon Q in Connect AI Agent.

Link to this function

get_a_i_guardrail(client, ai_guardrail_id, assistant_id, options \\ [])

View Source

Gets the Amazon Q in Connect AI Guardrail.

Link to this function

get_a_iprompt(client, ai_prompt_id, assistant_id, options \\ [])

View Source

Gets and Amazon Q in Connect AI Prompt.

Link to this function

get_assistant(client, assistant_id, options \\ [])

View Source

Retrieves information about an assistant.

Link to this function

get_assistant_association(client, assistant_association_id, assistant_id, options \\ [])

View Source

Retrieves information about an assistant association.

Link to this function

get_content(client, content_id, knowledge_base_id, options \\ [])

View Source

Retrieves content, including a pre-signed URL to download the content.

Link to this function

get_content_association(client, content_association_id, content_id, knowledge_base_id, options \\ [])

View Source

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Link to this function

get_content_summary(client, content_id, knowledge_base_id, options \\ [])

View Source

Retrieves summary information about the content.

Link to this function

get_import_job(client, import_job_id, knowledge_base_id, options \\ [])

View Source

Retrieves the started import job.

Link to this function

get_knowledge_base(client, knowledge_base_id, options \\ [])

View Source

Retrieves information about the knowledge base.

Link to this function

get_message_template(client, knowledge_base_id, message_template_id, options \\ [])

View Source

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.

Link to this function

get_next_message(client, assistant_id, session_id, next_message_token, options \\ [])

View Source

Retrieves next message on an Amazon Q in Connect session.

Link to this function

get_quick_response(client, knowledge_base_id, quick_response_id, options \\ [])

View Source

Retrieves the quick response.

Link to this function

get_recommendations(client, assistant_id, session_id, max_results \\ nil, wait_time_seconds \\ nil, options \\ [])

View Source

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.

Link to this function

get_session(client, assistant_id, session_id, options \\ [])

View Source

Retrieves information for a specified session.

Link to this function

list_a_i_agent_versions(client, ai_agent_id, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

View Source

List AI Agent versions.

Link to this function

list_a_i_agents(client, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

View Source

Lists AI Agents.

Link to this function

list_a_i_guardrail_versions(client, ai_guardrail_id, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists AI Guardrail versions.

Link to this function

list_a_i_guardrails(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

Link to this function

list_a_iprompt_versions(client, ai_prompt_id, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

View Source

Lists AI Prompt versions.

Link to this function

list_a_iprompts(client, assistant_id, max_results \\ nil, next_token \\ nil, origin \\ nil, options \\ [])

View Source

Lists the AI Prompts available on the Amazon Q in Connect assistant.

Link to this function

list_assistant_associations(client, assistant_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists information about assistant associations.

Link to this function

list_assistants(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists information about assistants.

Link to this function

list_content_associations(client, content_id, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Link to this function

list_contents(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the content.

Link to this function

list_import_jobs(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists information about import jobs.

Link to this function

list_knowledge_bases(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the knowledge bases.

Link to this function

list_message_template_versions(client, knowledge_base_id, message_template_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all the available versions for the specified Amazon Q in Connect message template.

Link to this function

list_message_templates(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

Link to this function

list_messages(client, assistant_id, session_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists messages on an Amazon Q in Connect session.

Link to this function

list_quick_responses(client, knowledge_base_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists information about quick response.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for the specified resource.

Link to this function

metadata()

View Source
Link to this function

notify_recommendations_received(client, assistant_id, session_id, input, options \\ [])

View Source

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.

Link to this function

put_feedback(client, assistant_id, input, options \\ [])

View Source

Provides feedback against the specified assistant for the specified target.

This API only supports generative targets.

Link to this function

query_assistant(client, assistant_id, input, options \\ [])

View Source

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.

Link to this function

remove_assistant_a_i_agent(client, assistant_id, input, options \\ [])

View Source

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

Link to this function

remove_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

View Source

Removes a URI template from a knowledge base.

Link to this function

render_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

search_content(client, knowledge_base_id, input, options \\ [])

View Source

Searches for content in a specified knowledge base.

Can be used to get a specific content resource by its name.

Link to this function

search_message_templates(client, knowledge_base_id, input, options \\ [])

View Source

Searches for Amazon Q in Connect message templates in the specified knowledge base.

Link to this function

search_quick_responses(client, knowledge_base_id, input, options \\ [])

View Source

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

Link to this function

search_sessions(client, assistant_id, input, options \\ [])

View Source

Searches for sessions.

Link to this function

send_message(client, assistant_id, session_id, input, options \\ [])

View Source

Submits a message to the Amazon Q in Connect session.

Link to this function

start_content_upload(client, knowledge_base_id, input, options \\ [])

View Source

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.

Link to this function

start_import_job(client, knowledge_base_id, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds the specified tags to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes the specified tags from the specified resource.

Link to this function

update_a_i_agent(client, ai_agent_id, assistant_id, input, options \\ [])

View Source

Updates an AI Agent.

Link to this function

update_a_i_guardrail(client, ai_guardrail_id, assistant_id, input, options \\ [])

View Source

Updates an AI Guardrail.

Link to this function

update_a_iprompt(client, ai_prompt_id, assistant_id, input, options \\ [])

View Source

Updates an AI Prompt.

Link to this function

update_assistant_a_i_agent(client, assistant_id, input, options \\ [])

View Source

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

Link to this function

update_content(client, content_id, knowledge_base_id, input, options \\ [])

View Source

Updates information about the content.

Link to this function

update_knowledge_base_template_uri(client, knowledge_base_id, input, options \\ [])

View Source

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.

Link to this function

update_message_template(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

update_message_template_metadata(client, knowledge_base_id, message_template_id, input, options \\ [])

View Source

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.

Link to this function

update_quick_response(client, knowledge_base_id, quick_response_id, input, options \\ [])

View Source

Updates an existing Amazon Q in Connect quick response.

Link to this function

update_session(client, assistant_id, session_id, input, options \\ [])

View Source

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.

Link to this function

update_session_data(client, assistant_id, session_id, input, options \\ [])

View Source

Updates the data stored on an Amazon Q in Connect Session.