aws-sdk-qconnect 1.5.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::QConnect
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::QConnect
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -337,50 +346,65 @@ module Aws::QConnect
337
346
  # @option options [Aws::QConnect::EndpointProvider] :endpoint_provider
338
347
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::QConnect::EndpointParameters`
339
348
  #
340
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
- # requests through. Formatted like 'http://proxy.com:123'.
342
- #
343
- # @option options [Float] :http_open_timeout (15) The number of
344
- # seconds to wait when opening a HTTP session before raising a
345
- # `Timeout::Error`.
346
- #
347
- # @option options [Float] :http_read_timeout (60) The default
348
- # number of seconds to wait for response data. This value can
349
- # safely be set per-request on the session.
350
- #
351
- # @option options [Float] :http_idle_timeout (5) The number of
352
- # seconds a connection is allowed to sit idle before it is
353
- # considered stale. Stale connections are closed and removed
354
- # from the pool before making a request.
355
- #
356
- # @option options [Float] :http_continue_timeout (1) The number of
357
- # seconds to wait for a 100-continue response before sending the
358
- # request body. This option has no effect unless the request has
359
- # "Expect" header set to "100-continue". Defaults to `nil` which
360
- # disables this behaviour. This value can safely be set per
361
- # request on the session.
362
- #
363
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
- # in seconds.
365
- #
366
- # @option options [Boolean] :http_wire_trace (false) When `true`,
367
- # HTTP debug output will be sent to the `:logger`.
349
+ # @option options [Float] :http_continue_timeout (1)
350
+ # The number of seconds to wait for a 100-continue response before sending the
351
+ # request body. This option has no effect unless the request has "Expect"
352
+ # header set to "100-continue". Defaults to `nil` which disables this
353
+ # behaviour. This value can safely be set per request on the session.
354
+ #
355
+ # @option options [Float] :http_idle_timeout (5)
356
+ # The number of seconds a connection is allowed to sit idle before it
357
+ # is considered stale. Stale connections are closed and removed from the
358
+ # pool before making a request.
359
+ #
360
+ # @option options [Float] :http_open_timeout (15)
361
+ # The default number of seconds to wait for response data.
362
+ # This value can safely be set per-request on the session.
363
+ #
364
+ # @option options [URI::HTTP,String] :http_proxy
365
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
366
+ #
367
+ # @option options [Float] :http_read_timeout (60)
368
+ # The default number of seconds to wait for response data.
369
+ # This value can safely be set per-request on the session.
370
+ #
371
+ # @option options [Boolean] :http_wire_trace (false)
372
+ # When `true`, HTTP debug output will be sent to the `:logger`.
373
+ #
374
+ # @option options [Proc] :on_chunk_received
375
+ # When a Proc object is provided, it will be used as callback when each chunk
376
+ # of the response body is received. It provides three arguments: the chunk,
377
+ # the number of bytes received, and the total number of
378
+ # bytes in the response (or nil if the server did not send a `content-length`).
379
+ #
380
+ # @option options [Proc] :on_chunk_sent
381
+ # When a Proc object is provided, it will be used as callback when each chunk
382
+ # of the request body is sent. It provides three arguments: the chunk,
383
+ # the number of bytes read from the body, and the total number of
384
+ # bytes in the body.
385
+ #
386
+ # @option options [Boolean] :raise_response_errors (true)
387
+ # When `true`, response errors are raised.
388
+ #
389
+ # @option options [String] :ssl_ca_bundle
390
+ # Full path to the SSL certificate authority bundle file that should be used when
391
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
392
+ # `:ssl_ca_directory` the the system default will be used if available.
393
+ #
394
+ # @option options [String] :ssl_ca_directory
395
+ # Full path of the directory that contains the unbundled SSL certificate
396
+ # authority files for verifying peer certificates. If you do
397
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
398
+ # default will be used if available.
368
399
  #
369
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
- # SSL peer certificates are verified when establishing a
371
- # connection.
400
+ # @option options [String] :ssl_ca_store
401
+ # Sets the X509::Store to verify peer certificate.
372
402
  #
373
- # @option options [String] :ssl_ca_bundle Full path to the SSL
374
- # certificate authority bundle file that should be used when
375
- # verifying peer certificates. If you do not pass
376
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
- # will be used if available.
403
+ # @option options [Float] :ssl_timeout
404
+ # Sets the SSL timeout in seconds
378
405
  #
379
- # @option options [String] :ssl_ca_directory Full path of the
380
- # directory that contains the unbundled SSL certificate
381
- # authority files for verifying peer certificates. If you do
382
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
- # system default will be used if available.
406
+ # @option options [Boolean] :ssl_verify_peer (true)
407
+ # When `true`, SSL peer certificates are verified when establishing a connection.
384
408
  #
385
409
  def initialize(*args)
386
410
  super
@@ -416,13 +440,14 @@ module Aws::QConnect
416
440
  # The customer managed key must have a policy that allows
417
441
  # `kms:CreateGrant`, ` kms:DescribeKey`, `kms:Decrypt`, and
418
442
  # `kms:GenerateDataKey*` permissions to the IAM identity using the key
419
- # to invoke Amazon Q. To use Amazon Q with chat, the key policy must
420
- # also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and
421
- # `kms:DescribeKey` permissions to the `connect.amazonaws.com` service
422
- # principal.
443
+ # to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat,
444
+ # the key policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`,
445
+ # and `kms:DescribeKey` permissions to the `connect.amazonaws.com`
446
+ # service principal.
423
447
  #
424
448
  # For more information about setting up a customer managed key for
425
- # Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
449
+ # Amazon Q in Connect, see [Enable Amazon Q in Connect for your
450
+ # instance][1].
426
451
  #
427
452
  #
428
453
  #
@@ -481,8 +506,8 @@ module Aws::QConnect
481
506
  # knowledge base. An assistant can have only a single association.
482
507
  #
483
508
  # @option params [required, String] :assistant_id
484
- # The identifier of the Amazon Q assistant. Can be either the ID or the
485
- # ARN. URLs cannot contain the ARN.
509
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
510
+ # ID or the ARN. URLs cannot contain the ARN.
486
511
  #
487
512
  # @option params [required, Types::AssistantAssociationInputData] :association
488
513
  # The identifier of the associated resource.
@@ -545,7 +570,7 @@ module Aws::QConnect
545
570
  req.send_request(options)
546
571
  end
547
572
 
548
- # Creates Amazon Q content. Before to calling this API, use
573
+ # Creates Amazon Q in Connect content. Before to calling this API, use
549
574
  # [StartContentUpload][1] to upload an asset.
550
575
  #
551
576
  #
@@ -567,15 +592,14 @@ module Aws::QConnect
567
592
  #
568
593
  # @option params [required, String] :knowledge_base_id
569
594
  # The identifier of the knowledge base. This should not be a
570
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
571
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
572
- # contain the ARN.
595
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
596
+ # URLs cannot contain the ARN.
573
597
  #
574
598
  # @option params [Hash<String,String>] :metadata
575
599
  # A key/value map to store attributes without affecting tagging or
576
600
  # recommendations. For example, when synchronizing data between an
577
- # external system and Amazon Q, you can store an external version
578
- # identifier as metadata to utilize for determining drift.
601
+ # external system and Amazon Q in Connect, you can store an external
602
+ # version identifier as metadata to utilize for determining drift.
579
603
  #
580
604
  # @option params [required, String] :name
581
605
  # The name of the content. Each piece of content in a knowledge base
@@ -715,10 +739,12 @@ module Aws::QConnect
715
739
  #
716
740
  # This KMS key must have a policy that allows `kms:CreateGrant`,
717
741
  # `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
718
- # permissions to the IAM identity using the key to invoke Amazon Q.
742
+ # permissions to the IAM identity using the key to invoke Amazon Q in
743
+ # Connect.
719
744
  #
720
745
  # For more information about setting up a customer managed key for
721
- # Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
746
+ # Amazon Q in Connect, see [Enable Amazon Q in Connect for your
747
+ # instance][1].
722
748
  #
723
749
  #
724
750
  #
@@ -785,7 +811,7 @@ module Aws::QConnect
785
811
  req.send_request(options)
786
812
  end
787
813
 
788
- # Creates an Amazon Q quick response.
814
+ # Creates an Amazon Q in Connect quick response.
789
815
  #
790
816
  # @option params [Array<String>] :channels
791
817
  # The Amazon Connect channels this quick response applies to.
@@ -826,10 +852,8 @@ module Aws::QConnect
826
852
  # Whether the quick response is active.
827
853
  #
828
854
  # @option params [required, String] :knowledge_base_id
829
- # The identifier of the knowledge base. This should not be a
830
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
831
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
832
- # contain the ARN.
855
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
856
+ # URLs cannot contain the ARN.
833
857
  #
834
858
  # @option params [String] :language
835
859
  # The language code value for the language in which the quick response
@@ -911,12 +935,13 @@ module Aws::QConnect
911
935
  end
912
936
 
913
937
  # Creates a session. A session is a contextual container used for
914
- # generating recommendations. Amazon Connect creates a new Amazon Q
915
- # session for each contact on which Amazon Q is enabled.
938
+ # generating recommendations. Amazon Connect creates a new Amazon Q in
939
+ # Connect session for each contact on which Amazon Q in Connect is
940
+ # enabled.
916
941
  #
917
942
  # @option params [required, String] :assistant_id
918
- # The identifier of the Amazon Q assistant. Can be either the ID or the
919
- # ARN. URLs cannot contain the ARN.
943
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
944
+ # ID or the ARN. URLs cannot contain the ARN.
920
945
  #
921
946
  # @option params [String] :client_token
922
947
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -937,6 +962,9 @@ module Aws::QConnect
937
962
  # @option params [required, String] :name
938
963
  # The name of the session.
939
964
  #
965
+ # @option params [Types::TagFilter] :tag_filter
966
+ # An object that can be used to specify Tag conditions.
967
+ #
940
968
  # @option params [Hash<String,String>] :tags
941
969
  # The tags used to organize, track, or control access for this resource.
942
970
  #
@@ -951,6 +979,32 @@ module Aws::QConnect
951
979
  # client_token: "ClientToken",
952
980
  # description: "Description",
953
981
  # name: "Name", # required
982
+ # tag_filter: {
983
+ # and_conditions: [
984
+ # {
985
+ # key: "TagKey", # required
986
+ # value: "TagValue",
987
+ # },
988
+ # ],
989
+ # or_conditions: [
990
+ # {
991
+ # and_conditions: [
992
+ # {
993
+ # key: "TagKey", # required
994
+ # value: "TagValue",
995
+ # },
996
+ # ],
997
+ # tag_condition: {
998
+ # key: "TagKey", # required
999
+ # value: "TagValue",
1000
+ # },
1001
+ # },
1002
+ # ],
1003
+ # tag_condition: {
1004
+ # key: "TagKey", # required
1005
+ # value: "TagValue",
1006
+ # },
1007
+ # },
954
1008
  # tags: {
955
1009
  # "TagKey" => "TagValue",
956
1010
  # },
@@ -963,6 +1017,17 @@ module Aws::QConnect
963
1017
  # resp.session.name #=> String
964
1018
  # resp.session.session_arn #=> String
965
1019
  # resp.session.session_id #=> String
1020
+ # resp.session.tag_filter.and_conditions #=> Array
1021
+ # resp.session.tag_filter.and_conditions[0].key #=> String
1022
+ # resp.session.tag_filter.and_conditions[0].value #=> String
1023
+ # resp.session.tag_filter.or_conditions #=> Array
1024
+ # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
1025
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
1026
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
1027
+ # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
1028
+ # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
1029
+ # resp.session.tag_filter.tag_condition.key #=> String
1030
+ # resp.session.tag_filter.tag_condition.value #=> String
966
1031
  # resp.session.tags #=> Hash
967
1032
  # resp.session.tags["TagKey"] #=> String
968
1033
  #
@@ -978,8 +1043,8 @@ module Aws::QConnect
978
1043
  # Deletes an assistant.
979
1044
  #
980
1045
  # @option params [required, String] :assistant_id
981
- # The identifier of the Amazon Q assistant. Can be either the ID or the
982
- # ARN. URLs cannot contain the ARN.
1046
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1047
+ # ID or the ARN. URLs cannot contain the ARN.
983
1048
  #
984
1049
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
985
1050
  #
@@ -1005,8 +1070,8 @@ module Aws::QConnect
1005
1070
  # the ARN. URLs cannot contain the ARN.
1006
1071
  #
1007
1072
  # @option params [required, String] :assistant_id
1008
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1009
- # ARN. URLs cannot contain the ARN.
1073
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1074
+ # ID or the ARN. URLs cannot contain the ARN.
1010
1075
  #
1011
1076
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1012
1077
  #
@@ -1033,10 +1098,8 @@ module Aws::QConnect
1033
1098
  # cannot contain the ARN.
1034
1099
  #
1035
1100
  # @option params [required, String] :knowledge_base_id
1036
- # The identifier of the knowledge base. This should not be a
1037
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1038
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1039
- # contain the ARN.
1101
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
1102
+ # URLs cannot contain the ARN.
1040
1103
  #
1041
1104
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1042
1105
  #
@@ -1062,9 +1125,7 @@ module Aws::QConnect
1062
1125
  # The identifier of the import job to be deleted.
1063
1126
  #
1064
1127
  # @option params [required, String] :knowledge_base_id
1065
- # The identifier of the knowledge base. This should not be a
1066
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1067
- # Content resource to it.
1128
+ # The identifier of the knowledge base.
1068
1129
  #
1069
1130
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1070
1131
  #
@@ -1127,9 +1188,7 @@ module Aws::QConnect
1127
1188
  #
1128
1189
  # @option params [required, String] :knowledge_base_id
1129
1190
  # The knowledge base from which the quick response is deleted. The
1130
- # identifier of the knowledge base. This should not be a
1131
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1132
- # Content resource to it.
1191
+ # identifier of the knowledge base.
1133
1192
  #
1134
1193
  # @option params [required, String] :quick_response_id
1135
1194
  # The identifier of the quick response to delete.
@@ -1155,8 +1214,8 @@ module Aws::QConnect
1155
1214
  # Retrieves information about an assistant.
1156
1215
  #
1157
1216
  # @option params [required, String] :assistant_id
1158
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1159
- # ARN. URLs cannot contain the ARN.
1217
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1218
+ # ID or the ARN. URLs cannot contain the ARN.
1160
1219
  #
1161
1220
  # @return [Types::GetAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1162
1221
  #
@@ -1198,8 +1257,8 @@ module Aws::QConnect
1198
1257
  # the ARN. URLs cannot contain the ARN.
1199
1258
  #
1200
1259
  # @option params [required, String] :assistant_id
1201
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1202
- # ARN. URLs cannot contain the ARN.
1260
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1261
+ # ID or the ARN. URLs cannot contain the ARN.
1203
1262
  #
1204
1263
  # @return [Types::GetAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1205
1264
  #
@@ -1241,9 +1300,8 @@ module Aws::QConnect
1241
1300
  #
1242
1301
  # @option params [required, String] :knowledge_base_id
1243
1302
  # The identifier of the knowledge base. This should not be a
1244
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1245
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1246
- # contain the ARN.
1303
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
1304
+ # URLs cannot contain the ARN.
1247
1305
  #
1248
1306
  # @return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
1307
  #
@@ -1291,10 +1349,8 @@ module Aws::QConnect
1291
1349
  # cannot contain the ARN.
1292
1350
  #
1293
1351
  # @option params [required, String] :knowledge_base_id
1294
- # The identifier of the knowledge base. This should not be a
1295
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1296
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1297
- # contain the ARN.
1352
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
1353
+ # URLs cannot contain the ARN.
1298
1354
  #
1299
1355
  # @return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1300
1356
  #
@@ -1381,10 +1437,8 @@ module Aws::QConnect
1381
1437
  # Retrieves information about the knowledge base.
1382
1438
  #
1383
1439
  # @option params [required, String] :knowledge_base_id
1384
- # The identifier of the knowledge base. This should not be a
1385
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1386
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1387
- # contain the ARN.
1440
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
1441
+ # URLs cannot contain the ARN.
1388
1442
  #
1389
1443
  # @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1390
1444
  #
@@ -1477,6 +1531,12 @@ module Aws::QConnect
1477
1531
  req.send_request(options)
1478
1532
  end
1479
1533
 
1534
+ # This API will be discontinued starting June 1, 2024. To receive
1535
+ # generative responses after March 1, 2024, you will need to create a
1536
+ # new Assistant in the Amazon Connect console and integrate the Amazon Q
1537
+ # in Connect JavaScript library (amazon-q-connectjs) into your
1538
+ # applications.
1539
+ #
1480
1540
  # Retrieves recommendations for the specified session. To avoid
1481
1541
  # retrieving the same recommendations in subsequent calls, use
1482
1542
  # [NotifyRecommendationsReceived][1]. This API supports long-polling
@@ -1491,8 +1551,8 @@ module Aws::QConnect
1491
1551
  # [2]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html
1492
1552
  #
1493
1553
  # @option params [required, String] :assistant_id
1494
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1495
- # ARN. URLs cannot contain the ARN.
1554
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1555
+ # ID or the ARN. URLs cannot contain the ARN.
1496
1556
  #
1497
1557
  # @option params [Integer] :max_results
1498
1558
  # The maximum number of results to return per page.
@@ -1594,8 +1654,8 @@ module Aws::QConnect
1594
1654
  # Retrieves information for a specified session.
1595
1655
  #
1596
1656
  # @option params [required, String] :assistant_id
1597
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1598
- # ARN. URLs cannot contain the ARN.
1657
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1658
+ # ID or the ARN. URLs cannot contain the ARN.
1599
1659
  #
1600
1660
  # @option params [required, String] :session_id
1601
1661
  # The identifier of the session. Can be either the ID or the ARN. URLs
@@ -1619,6 +1679,17 @@ module Aws::QConnect
1619
1679
  # resp.session.name #=> String
1620
1680
  # resp.session.session_arn #=> String
1621
1681
  # resp.session.session_id #=> String
1682
+ # resp.session.tag_filter.and_conditions #=> Array
1683
+ # resp.session.tag_filter.and_conditions[0].key #=> String
1684
+ # resp.session.tag_filter.and_conditions[0].value #=> String
1685
+ # resp.session.tag_filter.or_conditions #=> Array
1686
+ # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
1687
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
1688
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
1689
+ # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
1690
+ # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
1691
+ # resp.session.tag_filter.tag_condition.key #=> String
1692
+ # resp.session.tag_filter.tag_condition.value #=> String
1622
1693
  # resp.session.tags #=> Hash
1623
1694
  # resp.session.tags["TagKey"] #=> String
1624
1695
  #
@@ -1634,8 +1705,8 @@ module Aws::QConnect
1634
1705
  # Lists information about assistant associations.
1635
1706
  #
1636
1707
  # @option params [required, String] :assistant_id
1637
- # The identifier of the Amazon Q assistant. Can be either the ID or the
1638
- # ARN. URLs cannot contain the ARN.
1708
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
1709
+ # ID or the ARN. URLs cannot contain the ARN.
1639
1710
  #
1640
1711
  # @option params [Integer] :max_results
1641
1712
  # The maximum number of results to return per page.
@@ -1736,9 +1807,8 @@ module Aws::QConnect
1736
1807
  #
1737
1808
  # @option params [required, String] :knowledge_base_id
1738
1809
  # The identifier of the knowledge base. This should not be a
1739
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1740
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1741
- # contain the ARN.
1810
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
1811
+ # URLs cannot contain the ARN.
1742
1812
  #
1743
1813
  # @option params [Integer] :max_results
1744
1814
  # The maximum number of results to return per page.
@@ -1793,10 +1863,8 @@ module Aws::QConnect
1793
1863
  # Lists information about import jobs.
1794
1864
  #
1795
1865
  # @option params [required, String] :knowledge_base_id
1796
- # The identifier of the knowledge base. This should not be a
1797
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1798
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1799
- # contain the ARN.
1866
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
1867
+ # URLs cannot contain the ARN.
1800
1868
  #
1801
1869
  # @option params [Integer] :max_results
1802
1870
  # The maximum number of results to return per page.
@@ -1901,10 +1969,8 @@ module Aws::QConnect
1901
1969
  # Lists information about quick response.
1902
1970
  #
1903
1971
  # @option params [required, String] :knowledge_base_id
1904
- # The identifier of the knowledge base. This should not be a
1905
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
1906
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
1907
- # contain the ARN.
1972
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
1973
+ # URLs cannot contain the ARN.
1908
1974
  #
1909
1975
  # @option params [Integer] :max_results
1910
1976
  # The maximum number of results to return per page.
@@ -1998,8 +2064,8 @@ module Aws::QConnect
1998
2064
  # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html
1999
2065
  #
2000
2066
  # @option params [required, String] :assistant_id
2001
- # The identifier of the Amazon Q assistant. Can be either the ID or the
2002
- # ARN. URLs cannot contain the ARN.
2067
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
2068
+ # ID or the ARN. URLs cannot contain the ARN.
2003
2069
  #
2004
2070
  # @option params [required, Array<String>] :recommendation_ids
2005
2071
  # The identifiers of the recommendations.
@@ -2042,7 +2108,7 @@ module Aws::QConnect
2042
2108
  # target. This API only supports generative targets.
2043
2109
  #
2044
2110
  # @option params [required, String] :assistant_id
2045
- # The identifier of the Amazon Q assistant.
2111
+ # The identifier of the Amazon Q in Connect assistant.
2046
2112
  #
2047
2113
  # @option params [required, Types::ContentFeedbackData] :content_feedback
2048
2114
  # Information about the feedback provided.
@@ -2091,6 +2157,12 @@ module Aws::QConnect
2091
2157
  req.send_request(options)
2092
2158
  end
2093
2159
 
2160
+ # This API will be discontinued starting June 1, 2024. To receive
2161
+ # generative responses after March 1, 2024, you will need to create a
2162
+ # new Assistant in the Amazon Connect console and integrate the Amazon Q
2163
+ # in Connect JavaScript library (amazon-q-connectjs) into your
2164
+ # applications.
2165
+ #
2094
2166
  # Performs a manual search against the specified assistant. To retrieve
2095
2167
  # recommendations for an assistant, use [GetRecommendations][1].
2096
2168
  #
@@ -2099,8 +2171,8 @@ module Aws::QConnect
2099
2171
  # [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html
2100
2172
  #
2101
2173
  # @option params [required, String] :assistant_id
2102
- # The identifier of the Amazon Q assistant. Can be either the ID or the
2103
- # ARN. URLs cannot contain the ARN.
2174
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
2175
+ # ID or the ARN. URLs cannot contain the ARN.
2104
2176
  #
2105
2177
  # @option params [Integer] :max_results
2106
2178
  # The maximum number of results to return per page.
@@ -2117,8 +2189,8 @@ module Aws::QConnect
2117
2189
  # The text to search for.
2118
2190
  #
2119
2191
  # @option params [String] :session_id
2120
- # The identifier of the Amazon Q session. Can be either the ID or the
2121
- # ARN. URLs cannot contain the ARN.
2192
+ # The identifier of the Amazon Q in Connect session. Can be either the
2193
+ # ID or the ARN. URLs cannot contain the ARN.
2122
2194
  #
2123
2195
  # @return [Types::QueryAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2124
2196
  #
@@ -2211,10 +2283,8 @@ module Aws::QConnect
2211
2283
  # Removes a URI template from a knowledge base.
2212
2284
  #
2213
2285
  # @option params [required, String] :knowledge_base_id
2214
- # The identifier of the knowledge base. This should not be a
2215
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2216
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2217
- # contain the ARN.
2286
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
2287
+ # URLs cannot contain the ARN.
2218
2288
  #
2219
2289
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2220
2290
  #
@@ -2238,9 +2308,8 @@ module Aws::QConnect
2238
2308
  #
2239
2309
  # @option params [required, String] :knowledge_base_id
2240
2310
  # The identifier of the knowledge base. This should not be a
2241
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2242
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2243
- # contain the ARN.
2311
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
2312
+ # URLs cannot contain the ARN.
2244
2313
  #
2245
2314
  # @option params [Integer] :max_results
2246
2315
  # The maximum number of results to return per page.
@@ -2304,8 +2373,8 @@ module Aws::QConnect
2304
2373
  req.send_request(options)
2305
2374
  end
2306
2375
 
2307
- # Searches existing Amazon Q quick responses in an Amazon Q knowledge
2308
- # base.
2376
+ # Searches existing Amazon Q in Connect quick responses in an Amazon Q
2377
+ # in Connect knowledge base.
2309
2378
  #
2310
2379
  # @option params [Hash<String,String>] :attributes
2311
2380
  # The [user-defined Amazon Connect contact attributes][1] to be resolved
@@ -2416,8 +2485,8 @@ module Aws::QConnect
2416
2485
  # Searches for sessions.
2417
2486
  #
2418
2487
  # @option params [required, String] :assistant_id
2419
- # The identifier of the Amazon Q assistant. Can be either the ID or the
2420
- # ARN. URLs cannot contain the ARN.
2488
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
2489
+ # ID or the ARN. URLs cannot contain the ARN.
2421
2490
  #
2422
2491
  # @option params [Integer] :max_results
2423
2492
  # The maximum number of results to return per page.
@@ -2488,10 +2557,8 @@ module Aws::QConnect
2488
2557
  # The type of content to upload.
2489
2558
  #
2490
2559
  # @option params [required, String] :knowledge_base_id
2491
- # The identifier of the knowledge base. This should not be a
2492
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2493
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2494
- # contain the ARN.
2560
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
2561
+ # URLs cannot contain the ARN.
2495
2562
  #
2496
2563
  # @option params [Integer] :presigned_url_time_to_live
2497
2564
  # The expected expiration time of the generated presigned URL, specified
@@ -2529,15 +2596,15 @@ module Aws::QConnect
2529
2596
  req.send_request(options)
2530
2597
  end
2531
2598
 
2532
- # Start an asynchronous job to import Amazon Q resources from an
2533
- # uploaded source file. Before calling this API, use
2599
+ # Start an asynchronous job to import Amazon Q in Connect resources from
2600
+ # an uploaded source file. Before calling this API, use
2534
2601
  # [StartContentUpload][1] to upload an asset that contains the resource
2535
2602
  # data.
2536
2603
  #
2537
- # * For importing Amazon Q quick responses, you need to upload a csv
2538
- # file including the quick responses. For information about how to
2539
- # format the csv file for importing quick responses, see [Import quick
2540
- # responses][2].
2604
+ # * For importing Amazon Q in Connect quick responses, you need to
2605
+ # upload a csv file including the quick responses. For information
2606
+ # about how to format the csv file for importing quick responses, see
2607
+ # [Import quick responses][2].
2541
2608
  #
2542
2609
  # ^
2543
2610
  #
@@ -2565,18 +2632,16 @@ module Aws::QConnect
2565
2632
  # ^
2566
2633
  #
2567
2634
  # @option params [required, String] :knowledge_base_id
2568
- # The identifier of the knowledge base. This should not be a
2569
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2570
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2571
- # contain the ARN.
2635
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
2636
+ # URLs cannot contain the ARN.
2572
2637
  #
2573
- # * For importing Amazon Q quick responses, this should be a
2638
+ # * For importing Amazon Q in Connect quick responses, this should be a
2574
2639
  # `QUICK_RESPONSES` type knowledge base.
2575
2640
  #
2576
2641
  # ^
2577
2642
  #
2578
2643
  # @option params [Hash<String,String>] :metadata
2579
- # The metadata fields of the imported Amazon Q resources.
2644
+ # The metadata fields of the imported Amazon Q in Connect resources.
2580
2645
  #
2581
2646
  # @option params [required, String] :upload_id
2582
2647
  # A pointer to the uploaded asset. This value is returned by
@@ -2699,14 +2764,13 @@ module Aws::QConnect
2699
2764
  #
2700
2765
  # @option params [required, String] :knowledge_base_id
2701
2766
  # The identifier of the knowledge base. This should not be a
2702
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2703
- # Content resource to it. Can be either the ID or the ARN
2767
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN
2704
2768
  #
2705
2769
  # @option params [Hash<String,String>] :metadata
2706
2770
  # A key/value map to store attributes without affecting tagging or
2707
2771
  # recommendations. For example, when synchronizing data between an
2708
- # external system and Amazon Q, you can store an external version
2709
- # identifier as metadata to utilize for determining drift.
2772
+ # external system and Amazon Q in Connect, you can store an external
2773
+ # version identifier as metadata to utilize for determining drift.
2710
2774
  #
2711
2775
  # @option params [String] :override_link_out_uri
2712
2776
  # The URI for the article. If the knowledge base has a templateUri,
@@ -2784,16 +2848,15 @@ module Aws::QConnect
2784
2848
 
2785
2849
  # Updates the template URI of a knowledge base. This is only supported
2786
2850
  # for knowledge bases of type EXTERNAL. Include a single variable in
2787
- # `$\{variable\}` format; this interpolated by Amazon Q using ingested
2788
- # content. For example, if you ingest a Salesforce article, it has an
2789
- # `Id` value, and you can set the template URI to
2851
+ # `$\{variable\}` format; this interpolated by Amazon Q in Connect using
2852
+ # ingested content. For example, if you ingest a Salesforce article, it
2853
+ # has an `Id` value, and you can set the template URI to
2790
2854
  # `https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*/view`.
2791
2855
  #
2792
2856
  # @option params [required, String] :knowledge_base_id
2793
2857
  # The identifier of the knowledge base. This should not be a
2794
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2795
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2796
- # contain the ARN.
2858
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
2859
+ # URLs cannot contain the ARN.
2797
2860
  #
2798
2861
  # @option params [required, String] :template_uri
2799
2862
  # The template URI to update.
@@ -2835,7 +2898,7 @@ module Aws::QConnect
2835
2898
  req.send_request(options)
2836
2899
  end
2837
2900
 
2838
- # Updates an existing Amazon Q quick response.
2901
+ # Updates an existing Amazon Q in Connect quick response.
2839
2902
  #
2840
2903
  # @option params [Array<String>] :channels
2841
2904
  # The Amazon Connect contact channels this quick response applies to.
@@ -2863,10 +2926,8 @@ module Aws::QConnect
2863
2926
  # Whether the quick response is active.
2864
2927
  #
2865
2928
  # @option params [required, String] :knowledge_base_id
2866
- # The identifier of the knowledge base. This should not be a
2867
- # QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
2868
- # Content resource to it. Can be either the ID or the ARN. URLs cannot
2869
- # contain the ARN.
2929
+ # The identifier of the knowledge base. Can be either the ID or the ARN.
2930
+ # URLs cannot contain the ARN.
2870
2931
  #
2871
2932
  # @option params [String] :language
2872
2933
  # The language code value for the language in which the quick response
@@ -2956,6 +3017,93 @@ module Aws::QConnect
2956
3017
  req.send_request(options)
2957
3018
  end
2958
3019
 
3020
+ # Updates a session. A session is a contextual container used for
3021
+ # generating recommendations. Amazon Connect updates the existing Amazon
3022
+ # Q in Connect session for each contact on which Amazon Q in Connect is
3023
+ # enabled.
3024
+ #
3025
+ # @option params [required, String] :assistant_id
3026
+ # The identifier of the Amazon Q in Connect assistant. Can be either the
3027
+ # ID or the ARN. URLs cannot contain the ARN.
3028
+ #
3029
+ # @option params [String] :description
3030
+ # The description.
3031
+ #
3032
+ # @option params [required, String] :session_id
3033
+ # The identifier of the session. Can be either the ID or the ARN. URLs
3034
+ # cannot contain the ARN.
3035
+ #
3036
+ # @option params [Types::TagFilter] :tag_filter
3037
+ # An object that can be used to specify Tag conditions.
3038
+ #
3039
+ # @return [Types::UpdateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3040
+ #
3041
+ # * {Types::UpdateSessionResponse#session #session} => Types::SessionData
3042
+ #
3043
+ # @example Request syntax with placeholder values
3044
+ #
3045
+ # resp = client.update_session({
3046
+ # assistant_id: "UuidOrArn", # required
3047
+ # description: "Description",
3048
+ # session_id: "UuidOrArn", # required
3049
+ # tag_filter: {
3050
+ # and_conditions: [
3051
+ # {
3052
+ # key: "TagKey", # required
3053
+ # value: "TagValue",
3054
+ # },
3055
+ # ],
3056
+ # or_conditions: [
3057
+ # {
3058
+ # and_conditions: [
3059
+ # {
3060
+ # key: "TagKey", # required
3061
+ # value: "TagValue",
3062
+ # },
3063
+ # ],
3064
+ # tag_condition: {
3065
+ # key: "TagKey", # required
3066
+ # value: "TagValue",
3067
+ # },
3068
+ # },
3069
+ # ],
3070
+ # tag_condition: {
3071
+ # key: "TagKey", # required
3072
+ # value: "TagValue",
3073
+ # },
3074
+ # },
3075
+ # })
3076
+ #
3077
+ # @example Response structure
3078
+ #
3079
+ # resp.session.description #=> String
3080
+ # resp.session.integration_configuration.topic_integration_arn #=> String
3081
+ # resp.session.name #=> String
3082
+ # resp.session.session_arn #=> String
3083
+ # resp.session.session_id #=> String
3084
+ # resp.session.tag_filter.and_conditions #=> Array
3085
+ # resp.session.tag_filter.and_conditions[0].key #=> String
3086
+ # resp.session.tag_filter.and_conditions[0].value #=> String
3087
+ # resp.session.tag_filter.or_conditions #=> Array
3088
+ # resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
3089
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
3090
+ # resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
3091
+ # resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
3092
+ # resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
3093
+ # resp.session.tag_filter.tag_condition.key #=> String
3094
+ # resp.session.tag_filter.tag_condition.value #=> String
3095
+ # resp.session.tags #=> Hash
3096
+ # resp.session.tags["TagKey"] #=> String
3097
+ #
3098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSession AWS API Documentation
3099
+ #
3100
+ # @overload update_session(params = {})
3101
+ # @param [Hash] params ({})
3102
+ def update_session(params = {}, options = {})
3103
+ req = build_request(:update_session, params)
3104
+ req.send_request(options)
3105
+ end
3106
+
2959
3107
  # @!endgroup
2960
3108
 
2961
3109
  # @param params ({})
@@ -2969,7 +3117,7 @@ module Aws::QConnect
2969
3117
  params: params,
2970
3118
  config: config)
2971
3119
  context[:gem_name] = 'aws-sdk-qconnect'
2972
- context[:gem_version] = '1.5.0'
3120
+ context[:gem_version] = '1.7.0'
2973
3121
  Seahorse::Client::Request.new(handlers, context)
2974
3122
  end
2975
3123