Class: Aws::QConnect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QConnect::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb
Overview
An API client for QConnect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QConnect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Q in Connect assistant.
-
#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse
Creates an association between an Amazon Q in Connect assistant and another resource.
-
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Amazon Q in Connect content.
-
#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse
Creates an association between a content resource in a knowledge base and [step-by-step guides][1].
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
-
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates an Amazon Q in Connect quick response.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session.
-
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
-
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
-
#delete_content(params = {}) ⇒ Struct
Deletes the content.
-
#delete_content_association(params = {}) ⇒ Struct
Deletes the content association.
-
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
-
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
-
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
-
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
-
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
-
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
-
#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse
Returns the content association.
-
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
-
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
-
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
-
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
-
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
This API will be discontinued starting June 1, 2024.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
-
#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse
Lists information about assistant associations.
-
#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse
Lists information about assistants.
-
#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse
Lists the content associations.
-
#list_contents(params = {}) ⇒ Types::ListContentsResponse
Lists the content.
-
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases.
-
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
-
#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse
Provides feedback against the specified assistant for the specified target.
-
#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse
This API will be discontinued starting June 1, 2024.
-
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
-
#search_content(params = {}) ⇒ Types::SearchContentResponse
Searches for content in a specified knowledge base.
-
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
-
#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse
Searches for sessions.
-
#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse
Get a URL to upload content to a knowledge base.
-
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
-
#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse
Updates the template URI of a knowledge base.
-
#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse
Updates an existing Amazon Q in Connect quick response.
-
#update_session(params = {}) ⇒ Types::UpdateSessionResponse
Updates a session.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Q in Connect assistant.
534 535 536 537 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 534 def create_assistant(params = {}, = {}) req = build_request(:create_assistant, params) req.send_request() end |
#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse
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.
603 604 605 606 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 603 def create_assistant_association(params = {}, = {}) req = build_request(:create_assistant_association, params) req.send_request() end |
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
711 712 713 714 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 711 def create_content(params = {}, = {}) req = build_request(:create_content, params) req.send_request() end |
#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse
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.
808 809 810 811 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 808 def create_content_association(params = {}, = {}) req = build_request(:create_content_association, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
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.
941 942 943 944 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 941 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates an Amazon Q in Connect quick response.
1064 1065 1066 1067 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1064 def create_quick_response(params = {}, = {}) req = build_request(:create_quick_response, params) req.send_request() end |
#create_session(params = {}) ⇒ Types::CreateSessionResponse
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.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1170 def create_session(params = {}, = {}) req = build_request(:create_session, params) req.send_request() end |
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1193 def delete_assistant(params = {}, = {}) req = build_request(:delete_assistant, params) req.send_request() end |
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1221 def delete_assistant_association(params = {}, = {}) req = build_request(:delete_assistant_association, params) req.send_request() end |
#delete_content(params = {}) ⇒ Struct
Deletes the content.
1249 1250 1251 1252 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1249 def delete_content(params = {}, = {}) req = build_request(:delete_content, params) req.send_request() end |
#delete_content_association(params = {}) ⇒ Struct
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.
1288 1289 1290 1291 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1288 def delete_content_association(params = {}, = {}) req = build_request(:delete_content_association, params) req.send_request() end |
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1314 def delete_import_job(params = {}, = {}) req = build_request(:delete_import_job, params) req.send_request() end |
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
1353 1354 1355 1356 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1353 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
1380 1381 1382 1383 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1380 def delete_quick_response(params = {}, = {}) req = build_request(:delete_quick_response, params) req.send_request() end |
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
1419 1420 1421 1422 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1419 def get_assistant(params = {}, = {}) req = build_request(:get_assistant, params) req.send_request() end |
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1461 def get_assistant_association(params = {}, = {}) req = build_request(:get_assistant_association, params) req.send_request() end |
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1511 def get_content(params = {}, = {}) req = build_request(:get_content, params) req.send_request() end |
#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse
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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1565 def get_content_association(params = {}, = {}) req = build_request(:get_content_association, params) req.send_request() end |
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
1611 1612 1613 1614 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1611 def get_content_summary(params = {}, = {}) req = build_request(:get_content_summary, params) req.send_request() end |
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1657 def get_import_job(params = {}, = {}) req = build_request(:get_import_job, params) req.send_request() end |
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
1699 1700 1701 1702 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1699 def get_knowledge_base(params = {}, = {}) req = build_request(:get_knowledge_base, params) req.send_request() end |
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
1754 1755 1756 1757 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1754 def get_quick_response(params = {}, = {}) req = build_request(:get_quick_response, params) req.send_request() end |
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
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.
1874 1875 1876 1877 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1874 def get_recommendations(params = {}, = {}) req = build_request(:get_recommendations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
1925 1926 1927 1928 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1925 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse
Lists information about assistant associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1977 def list_assistant_associations(params = {}, = {}) req = build_request(:list_assistant_associations, params) req.send_request() end |
#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse
Lists information about assistants.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2026 def list_assistants(params = {}, = {}) req = build_request(:list_assistants, params) req.send_request() end |
#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2090 def list_content_associations(params = {}, = {}) req = build_request(:list_content_associations, params) req.send_request() end |
#list_contents(params = {}) ⇒ Types::ListContentsResponse
Lists the content.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2147 2148 2149 2150 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2147 def list_contents(params = {}, = {}) req = build_request(:list_contents, params) req.send_request() end |
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2202 def list_import_jobs(params = {}, = {}) req = build_request(:list_import_jobs, params) req.send_request() end |
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2253 2254 2255 2256 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2253 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2312 def list_quick_responses(params = {}, = {}) req = build_request(:list_quick_responses, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
2341 2342 2343 2344 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2341 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse
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.
2391 2392 2393 2394 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2391 def notify_recommendations_received(params = {}, = {}) req = build_request(:notify_recommendations_received, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2444 def put_feedback(params = {}, = {}) req = build_request(:put_feedback, params) req.send_request() end |
#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2567 def query_assistant(params = {}, = {}) req = build_request(:query_assistant, params) req.send_request() end |
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
2590 2591 2592 2593 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2590 def remove_knowledge_base_template_uri(params = {}, = {}) req = build_request(:remove_knowledge_base_template_uri, params) req.send_request() end |
#search_content(params = {}) ⇒ Types::SearchContentResponse
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2660 2661 2662 2663 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2660 def search_content(params = {}, = {}) req = build_request(:search_content, params) req.send_request() end |
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2769 2770 2771 2772 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2769 def search_quick_responses(params = {}, = {}) req = build_request(:search_quick_responses, params) req.send_request() end |
#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse
Searches for sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2828 2829 2830 2831 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2828 def search_sessions(params = {}, = {}) req = build_request(:search_sessions, params) req.send_request() end |
#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse
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.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2883 def start_content_upload(params = {}, = {}) req = build_request(:start_content_upload, params) req.send_request() end |
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
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.
^
2989 2990 2991 2992 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2989 def start_import_job(params = {}, = {}) req = build_request(:start_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3017 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
3043 3044 3045 3046 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3043 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
3133 3134 3135 3136 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3133 def update_content(params = {}, = {}) req = build_request(:update_content, params) req.send_request() end |
#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse
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
.
3185 3186 3187 3188 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3185 def update_knowledge_base_template_uri(params = {}, = {}) req = build_request(:update_knowledge_base_template_uri, params) req.send_request() end |
#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse
Updates an existing Amazon Q in Connect quick response.
3304 3305 3306 3307 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3304 def update_quick_response(params = {}, = {}) req = build_request(:update_quick_response, params) req.send_request() end |
#update_session(params = {}) ⇒ Types::UpdateSessionResponse
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.
3391 3392 3393 3394 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3391 def update_session(params = {}, = {}) req = build_request(:update_session, params) req.send_request() end |