lib/aws-sdk-qconnect/client.rb in aws-sdk-qconnect-1.5.0 vs lib/aws-sdk-qconnect/client.rb in aws-sdk-qconnect-1.6.0

- old
+ new

@@ -414,17 +414,18 @@ # encryption. # # 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 `kms:Decrypt`, `kms:GenerateDataKey*`, and - # `kms:DescribeKey` permissions to the `connect.amazonaws.com` service - # principal. + # 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 your instance][1]. + # Amazon Q in Connect, see [Enable Amazon Q in Connect for your + # instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html # @@ -479,12 +480,12 @@ # 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. # # @option params [required, String] :assistant_id - # 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. # # @option params [required, Types::AssistantAssociationInputData] :association # The identifier of the associated resource. # # @option params [required, String] :association_type @@ -543,11 +544,11 @@ def create_assistant_association(params = {}, options = {}) req = build_request(:create_assistant_association, params) req.send_request(options) end - # Creates Amazon Q content. Before to calling this API, use + # Creates Amazon Q in Connect content. Before to calling this API, use # [StartContentUpload][1] to upload an asset. # # # # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html @@ -565,19 +566,18 @@ # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # # @option params [required, String] :knowledge_base_id # 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. + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN. + # URLs cannot contain the ARN. # # @option params [Hash<String,String>] :metadata # 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. + # external system and Amazon Q in Connect, you can store an external + # version identifier as metadata to utilize for determining drift. # # @option params [required, String] :name # 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][1] API. @@ -713,14 +713,16 @@ # The configuration information for the customer managed key used for # encryption. # # 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. + # permissions to the IAM identity using the key to invoke Amazon Q in + # Connect. # # For more information about setting up a customer managed key for - # Amazon Q, see [Enable Amazon Q in Connect for your instance][1]. + # Amazon Q in Connect, see [Enable Amazon Q in Connect for your + # instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html # @@ -783,11 +785,11 @@ def create_knowledge_base(params = {}, options = {}) req = build_request(:create_knowledge_base, params) req.send_request(options) end - # Creates an Amazon Q quick response. + # Creates an Amazon Q in Connect quick response. # # @option params [Array<String>] :channels # The Amazon Connect channels this quick response applies to. # # @option params [String] :client_token @@ -824,14 +826,12 @@ # # @option params [Boolean] :is_active # Whether the quick response is active. # # @option params [required, String] :knowledge_base_id - # 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. # # @option params [String] :language # 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`, @@ -909,16 +909,17 @@ req = build_request(:create_quick_response, params) req.send_request(options) end # 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. + # generating recommendations. Amazon Connect creates a new Amazon Q in + # Connect session for each contact on which Amazon Q in Connect is + # enabled. # # @option params [required, String] :assistant_id - # 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. # # @option params [String] :client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, see @@ -935,10 +936,13 @@ # The description. # # @option params [required, String] :name # The name of the session. # + # @option params [Types::TagFilter] :tag_filter + # An object that can be used to specify Tag conditions. + # # @option params [Hash<String,String>] :tags # The tags used to organize, track, or control access for this resource. # # @return [Types::CreateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -949,10 +953,36 @@ # resp = client.create_session({ # assistant_id: "UuidOrArn", # required # client_token: "ClientToken", # description: "Description", # name: "Name", # required + # tag_filter: { + # and_conditions: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], + # or_conditions: [ + # { + # and_conditions: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], + # tag_condition: { + # key: "TagKey", # required + # value: "TagValue", + # }, + # }, + # ], + # tag_condition: { + # key: "TagKey", # required + # value: "TagValue", + # }, + # }, # tags: { # "TagKey" => "TagValue", # }, # }) # @@ -961,10 +991,21 @@ # resp.session.description #=> String # resp.session.integration_configuration.topic_integration_arn #=> String # resp.session.name #=> String # resp.session.session_arn #=> String # resp.session.session_id #=> String + # resp.session.tag_filter.and_conditions #=> Array + # resp.session.tag_filter.and_conditions[0].key #=> String + # resp.session.tag_filter.and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String + # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String + # resp.session.tag_filter.tag_condition.key #=> String + # resp.session.tag_filter.tag_condition.value #=> String # resp.session.tags #=> Hash # resp.session.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSession AWS API Documentation # @@ -976,12 +1017,12 @@ end # Deletes an assistant. # # @option params [required, String] :assistant_id - # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1003,12 +1044,12 @@ # @option params [required, String] :assistant_association_id # The identifier of the assistant association. Can be either the ID or # the ARN. URLs cannot contain the ARN. # # @option params [required, String] :assistant_id - # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1031,14 +1072,12 @@ # @option params [required, String] :content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # # @option params [required, String] :knowledge_base_id - # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1060,13 +1099,11 @@ # # @option params [required, String] :import_job_id # The identifier of the import job to be deleted. # # @option params [required, String] :knowledge_base_id - # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1125,13 +1162,11 @@ # Deletes a quick response. # # @option params [required, String] :knowledge_base_id # 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. + # identifier of the knowledge base. # # @option params [required, String] :quick_response_id # The identifier of the quick response to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -1153,12 +1188,12 @@ end # Retrieves information about an assistant. # # @option params [required, String] :assistant_id - # 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. # # @return [Types::GetAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetAssistantResponse#assistant #assistant} => Types::AssistantData # @@ -1196,12 +1231,12 @@ # @option params [required, String] :assistant_association_id # The identifier of the assistant association. Can be either the ID or # the ARN. URLs cannot contain the ARN. # # @option params [required, String] :assistant_id - # 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. # # @return [Types::GetAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetAssistantAssociationResponse#assistant_association #assistant_association} => Types::AssistantAssociationData # @@ -1239,13 +1274,12 @@ # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # # @option params [required, String] :knowledge_base_id # 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. + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN. + # URLs cannot contain the ARN. # # @return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetContentResponse#content #content} => Types::ContentData # @@ -1289,14 +1323,12 @@ # @option params [required, String] :content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # # @option params [required, String] :knowledge_base_id - # 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. # # @return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetContentSummaryResponse#content_summary #content_summary} => Types::ContentSummary # @@ -1379,14 +1411,12 @@ end # Retrieves information about the knowledge base. # # @option params [required, String] :knowledge_base_id - # 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. # # @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData # @@ -1475,10 +1505,16 @@ def get_quick_response(params = {}, options = {}) req = build_request(:get_quick_response, params) req.send_request(options) end + # 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][1]. This API supports long-polling # behavior with the `waitTimeSeconds` parameter. Short poll is the # default behavior and only returns recommendations already available. @@ -1489,12 +1525,12 @@ # # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html # [2]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html # # @option params [required, String] :assistant_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [required, String] :session_id @@ -1592,12 +1628,12 @@ end # Retrieves information for a specified session. # # @option params [required, String] :assistant_id - # 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. # # @option params [required, String] :session_id # The identifier of the session. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @@ -1617,10 +1653,21 @@ # resp.session.description #=> String # resp.session.integration_configuration.topic_integration_arn #=> String # resp.session.name #=> String # resp.session.session_arn #=> String # resp.session.session_id #=> String + # resp.session.tag_filter.and_conditions #=> Array + # resp.session.tag_filter.and_conditions[0].key #=> String + # resp.session.tag_filter.and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String + # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String + # resp.session.tag_filter.tag_condition.key #=> String + # resp.session.tag_filter.tag_condition.value #=> String # resp.session.tags #=> Hash # resp.session.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSession AWS API Documentation # @@ -1632,12 +1679,12 @@ end # Lists information about assistant associations. # # @option params [required, String] :assistant_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -1734,13 +1781,12 @@ # Lists the content. # # @option params [required, String] :knowledge_base_id # 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. + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN. + # URLs cannot contain the ARN. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -1791,14 +1837,12 @@ end # Lists information about import jobs. # # @option params [required, String] :knowledge_base_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -1899,14 +1943,12 @@ end # Lists information about quick response. # # @option params [required, String] :knowledge_base_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -1996,12 +2038,12 @@ # # # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html # # @option params [required, String] :assistant_id - # 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. # # @option params [required, Array<String>] :recommendation_ids # The identifiers of the recommendations. # # @option params [required, String] :session_id @@ -2040,11 +2082,11 @@ # Provides feedback against the specified assistant for the specified # target. This API only supports generative targets. # # @option params [required, String] :assistant_id - # The identifier of the Amazon Q assistant. + # The identifier of the Amazon Q in Connect assistant. # # @option params [required, Types::ContentFeedbackData] :content_feedback # Information about the feedback provided. # # @option params [required, String] :target_id @@ -2089,20 +2131,26 @@ def put_feedback(params = {}, options = {}) req = build_request(:put_feedback, params) req.send_request(options) end + # 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][1]. # # # # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html # # @option params [required, String] :assistant_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -2115,12 +2163,12 @@ # # @option params [required, String] :query_text # The text to search for. # # @option params [String] :session_id - # The identifier of the Amazon Q session. Can be either the ID or the - # ARN. URLs cannot contain the ARN. + # The identifier of the Amazon Q in Connect session. Can be either the + # ID or the ARN. URLs cannot contain the ARN. # # @return [Types::QueryAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::QueryAssistantResponse#next_token #next_token} => String # * {Types::QueryAssistantResponse#results #results} => Array&lt;Types::ResultData&gt; @@ -2209,14 +2257,12 @@ end # Removes a URI template from a knowledge base. # # @option params [required, String] :knowledge_base_id - # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2236,13 +2282,12 @@ # Searches for content in a specified knowledge base. Can be used to get # a specific content resource by its name. # # @option params [required, String] :knowledge_base_id # 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. + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN. + # URLs cannot contain the ARN. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -2302,12 +2347,12 @@ def search_content(params = {}, options = {}) req = build_request(:search_content, params) req.send_request(options) end - # 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. # # @option params [Hash<String,String>] :attributes # The [user-defined Amazon Connect contact attributes][1] to be resolved # when search results are returned. # @@ -2414,12 +2459,12 @@ end # Searches for sessions. # # @option params [required, String] :assistant_id - # 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. # # @option params [Integer] :max_results # The maximum number of results to return per page. # # @option params [String] :next_token @@ -2486,14 +2531,12 @@ # # @option params [required, String] :content_type # The type of content to upload. # # @option params [required, String] :knowledge_base_id - # 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. # # @option params [Integer] :presigned_url_time_to_live # The expected expiration time of the generated presigned URL, specified # in minutes. # @@ -2527,19 +2570,19 @@ def start_content_upload(params = {}, options = {}) req = build_request(:start_content_upload, params) req.send_request(options) end - # Start an asynchronous job to import Amazon Q resources from an - # uploaded source file. Before calling this API, use + # Start an asynchronous job to import Amazon Q in Connect resources from + # an uploaded source file. Before calling this API, use # [StartContentUpload][1] 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][2]. + # * 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][2]. # # ^ # # # @@ -2563,22 +2606,20 @@ # `QUICK_RESPONSES`. # # ^ # # @option params [required, String] :knowledge_base_id - # 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 + # * For importing Amazon Q in Connect quick responses, this should be a # `QUICK_RESPONSES` type knowledge base. # # ^ # # @option params [Hash<String,String>] :metadata - # The metadata fields of the imported Amazon Q resources. + # The metadata fields of the imported Amazon Q in Connect resources. # # @option params [required, String] :upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # @@ -2697,18 +2738,17 @@ # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # # @option params [required, String] :knowledge_base_id # 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 + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN # # @option params [Hash<String,String>] :metadata # 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. + # external system and Amazon Q in Connect, you can store an external + # version identifier as metadata to utilize for determining drift. # # @option params [String] :override_link_out_uri # The URI for the article. If the knowledge base has a templateUri, # setting this argument overrides it for this piece of content. To # remove an existing `overrideLinkOurUri`, exclude this argument and set @@ -2782,20 +2822,19 @@ req.send_request(options) end # 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 article, it has an - # `Id` value, and you can set the template URI to + # `$\{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`. # # @option params [required, String] :knowledge_base_id # 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. + # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN. + # URLs cannot contain the ARN. # # @option params [required, String] :template_uri # The template URI to update. # # @return [Types::UpdateKnowledgeBaseTemplateUriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2833,11 +2872,11 @@ def update_knowledge_base_template_uri(params = {}, options = {}) req = build_request(:update_knowledge_base_template_uri, params) req.send_request(options) end - # Updates an existing Amazon Q quick response. + # Updates an existing Amazon Q in Connect quick response. # # @option params [Array<String>] :channels # The Amazon Connect contact channels this quick response applies to. # The supported contact channel types include `Chat`. # @@ -2861,14 +2900,12 @@ # # @option params [Boolean] :is_active # Whether the quick response is active. # # @option params [required, String] :knowledge_base_id - # 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. # # @option params [String] :language # 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`, @@ -2954,10 +2991,97 @@ def update_quick_response(params = {}, options = {}) req = build_request(:update_quick_response, params) req.send_request(options) end + # 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. + # + # @option params [required, String] :assistant_id + # The identifier of the Amazon Q in Connect assistant. Can be either the + # ID or the ARN. URLs cannot contain the ARN. + # + # @option params [String] :description + # The description. + # + # @option params [required, String] :session_id + # The identifier of the session. Can be either the ID or the ARN. URLs + # cannot contain the ARN. + # + # @option params [Types::TagFilter] :tag_filter + # An object that can be used to specify Tag conditions. + # + # @return [Types::UpdateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::UpdateSessionResponse#session #session} => Types::SessionData + # + # @example Request syntax with placeholder values + # + # resp = client.update_session({ + # assistant_id: "UuidOrArn", # required + # description: "Description", + # session_id: "UuidOrArn", # required + # tag_filter: { + # and_conditions: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], + # or_conditions: [ + # { + # and_conditions: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], + # tag_condition: { + # key: "TagKey", # required + # value: "TagValue", + # }, + # }, + # ], + # tag_condition: { + # key: "TagKey", # required + # value: "TagValue", + # }, + # }, + # }) + # + # @example Response structure + # + # resp.session.description #=> String + # resp.session.integration_configuration.topic_integration_arn #=> String + # resp.session.name #=> String + # resp.session.session_arn #=> String + # resp.session.session_id #=> String + # resp.session.tag_filter.and_conditions #=> Array + # resp.session.tag_filter.and_conditions[0].key #=> String + # resp.session.tag_filter.and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array + # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String + # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String + # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String + # resp.session.tag_filter.tag_condition.key #=> String + # resp.session.tag_filter.tag_condition.value #=> String + # resp.session.tags #=> Hash + # resp.session.tags["TagKey"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSession AWS API Documentation + # + # @overload update_session(params = {}) + # @param [Hash] params ({}) + def update_session(params = {}, options = {}) + req = build_request(:update_session, params) + req.send_request(options) + end + # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) @@ -2967,10 +3091,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-qconnect' - context[:gem_version] = '1.5.0' + context[:gem_version] = '1.6.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated