aws-sdk-connect 1.169.0 → 1.179.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32,11 +32,10 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
32
  require 'aws-sdk-core/plugins/request_compression.rb'
33
33
  require 'aws-sdk-core/plugins/defaults_mode.rb'
34
34
  require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/telemetry.rb'
35
36
  require 'aws-sdk-core/plugins/sign.rb'
36
37
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
37
38
 
38
- Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
39
-
40
39
  module Aws::Connect
41
40
  # An API client for Connect. To construct a client, you need to configure a `:region` and `:credentials`.
42
41
  #
@@ -83,6 +82,7 @@ module Aws::Connect
83
82
  add_plugin(Aws::Plugins::RequestCompression)
84
83
  add_plugin(Aws::Plugins::DefaultsMode)
85
84
  add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
86
  add_plugin(Aws::Plugins::Sign)
87
87
  add_plugin(Aws::Plugins::Protocols::RestJson)
88
88
  add_plugin(Aws::Connect::Plugins::Endpoints)
@@ -128,13 +128,15 @@ module Aws::Connect
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
132
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
+ # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
133
135
  # * `~/.aws/credentials`
134
136
  # * `~/.aws/config`
135
137
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
136
138
  # are very aggressive. Construct and pass an instance of
137
- # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
139
+ # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
138
140
  # enable retries and extended timeouts. Instance profile credential
139
141
  # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
140
142
  # to true.
@@ -153,6 +155,8 @@ module Aws::Connect
153
155
  #
154
156
  # @option options [String] :access_key_id
155
157
  #
158
+ # @option options [String] :account_id
159
+ #
156
160
  # @option options [Boolean] :active_endpoint_cache (false)
157
161
  # When set to `true`, a thread polling for endpoints will be running in
158
162
  # the background every 60 secs (default). Defaults to `false`.
@@ -330,6 +334,16 @@ module Aws::Connect
330
334
  # ** Please note ** When response stubbing is enabled, no HTTP
331
335
  # requests are made, and retries are disabled.
332
336
  #
337
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
338
+ # Allows you to provide a telemetry provider, which is used to
339
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
340
+ # will not record or emit any telemetry data. The SDK supports the
341
+ # following telemetry providers:
342
+ #
343
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
344
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
345
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
346
+ #
333
347
  # @option options [Aws::TokenProvider] :token_provider
334
348
  # A Bearer Token Provider. This can be an instance of any one of the
335
349
  # following classes:
@@ -357,7 +371,9 @@ module Aws::Connect
357
371
  # sending the request.
358
372
  #
359
373
  # @option options [Aws::Connect::EndpointProvider] :endpoint_provider
360
- # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Connect::EndpointParameters`
374
+ # The endpoint provider used to resolve endpoints. Any object that responds to
375
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
376
+ # `Aws::Connect::EndpointParameters`.
361
377
  #
362
378
  # @option options [Float] :http_continue_timeout (1)
363
379
  # The number of seconds to wait for a 100-continue response before sending the
@@ -413,6 +429,12 @@ module Aws::Connect
413
429
  # @option options [String] :ssl_ca_store
414
430
  # Sets the X509::Store to verify peer certificate.
415
431
  #
432
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
433
+ # Sets a client certificate when creating http connections.
434
+ #
435
+ # @option options [OpenSSL::PKey] :ssl_key
436
+ # Sets a client key when creating http connections.
437
+ #
416
438
  # @option options [Float] :ssl_timeout
417
439
  # Sets the SSL timeout in seconds
418
440
  #
@@ -474,9 +496,6 @@ module Aws::Connect
474
496
  req.send_request(options)
475
497
  end
476
498
 
477
- # This API is in preview release for Amazon Connect and is subject to
478
- # change.
479
- #
480
499
  # Associates the specified dataset for a Amazon Connect instance with
481
500
  # the target account. You can associate only one dataset in a single
482
501
  # call.
@@ -638,7 +657,7 @@ module Aws::Connect
638
657
  #
639
658
  # resp = client.associate_default_vocabulary({
640
659
  # instance_id: "InstanceId", # required
641
- # language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
660
+ # language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
642
661
  # vocabulary_id: "VocabularyId",
643
662
  # })
644
663
  #
@@ -1005,7 +1024,7 @@ module Aws::Connect
1005
1024
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
1006
1025
  #
1007
1026
  # @option params [required, String] :key
1008
- # A valid security key in PEM format.
1027
+ # A valid security key in PEM format as a String.
1009
1028
  #
1010
1029
  # @return [Types::AssociateSecurityKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1011
1030
  #
@@ -1107,9 +1126,6 @@ module Aws::Connect
1107
1126
  req.send_request(options)
1108
1127
  end
1109
1128
 
1110
- # This API is in preview release for Amazon Connect and is subject to
1111
- # change.
1112
- #
1113
1129
  # Associates a list of analytics datasets for a given Amazon Connect
1114
1130
  # instance to a target account. You can associate multiple datasets in a
1115
1131
  # single call.
@@ -1164,9 +1180,6 @@ module Aws::Connect
1164
1180
  req.send_request(options)
1165
1181
  end
1166
1182
 
1167
- # This API is in preview release for Amazon Connect and is subject to
1168
- # change.
1169
- #
1170
1183
  # Removes a list of analytics datasets associated with a given Amazon
1171
1184
  # Connect instance. You can disassociate multiple datasets in a single
1172
1185
  # call.
@@ -1380,11 +1393,11 @@ module Aws::Connect
1380
1393
  # contact_data_request_list: [ # required
1381
1394
  # {
1382
1395
  # system_endpoint: {
1383
- # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
1396
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
1384
1397
  # address: "EndpointAddress",
1385
1398
  # },
1386
1399
  # customer_endpoint: {
1387
- # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
1400
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
1388
1401
  # address: "EndpointAddress",
1389
1402
  # },
1390
1403
  # request_identifier: "RequestIdentifier",
@@ -2007,6 +2020,9 @@ module Aws::Connect
2007
2020
  # Service (Amazon S3) or Amazon Kinesis. It also does not allow for any
2008
2021
  # configurations on features, such as Contact Lens for Amazon Connect.
2009
2022
  #
2023
+ # For more information, see [Create an Amazon Connect instance][1] in
2024
+ # the *Amazon Connect Administrator Guide*.
2025
+ #
2010
2026
  # Amazon Connect enforces a limit on the total number of instances that
2011
2027
  # you can create or delete in 30 days. If you exceed this limit, you
2012
2028
  # will get an error message indicating there has been an excessive
@@ -2014,6 +2030,10 @@ module Aws::Connect
2014
2030
  # days before you can restart creating and deleting instances in your
2015
2031
  # account.
2016
2032
  #
2033
+ #
2034
+ #
2035
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html
2036
+ #
2017
2037
  # @option params [String] :client_token
2018
2038
  # The idempotency token.
2019
2039
  #
@@ -2339,7 +2359,14 @@ module Aws::Connect
2339
2359
  end
2340
2360
 
2341
2361
  # Creates a new predefined attribute for the specified Amazon Connect
2342
- # instance.
2362
+ # instance. *Predefined attributes* are attributes in an Amazon Connect
2363
+ # instance that can be used to route contacts to an agent or pools of
2364
+ # agents within a queue. For more information, see [Create predefined
2365
+ # attributes for routing contacts to agents][1].
2366
+ #
2367
+ #
2368
+ #
2369
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
2343
2370
  #
2344
2371
  # @option params [required, String] :instance_id
2345
2372
  # The identifier of the Amazon Connect instance. You can find the
@@ -2854,6 +2881,16 @@ module Aws::Connect
2854
2881
 
2855
2882
  # Creates a security profile.
2856
2883
  #
2884
+ # For information about security profiles, see [Security Profiles][1] in
2885
+ # the *Amazon Connect Administrator Guide*. For a mapping of the API
2886
+ # name and user interface name of the security profile permissions, see
2887
+ # [List of security profile permissions][2].
2888
+ #
2889
+ #
2890
+ #
2891
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
2892
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
2893
+ #
2857
2894
  # @option params [required, String] :security_profile_name
2858
2895
  # The name of the security profile.
2859
2896
  #
@@ -3600,7 +3637,7 @@ module Aws::Connect
3600
3637
  # client_token: "ClientToken",
3601
3638
  # instance_id: "InstanceId", # required
3602
3639
  # vocabulary_name: "VocabularyName", # required
3603
- # language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
3640
+ # language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
3604
3641
  # content: "VocabularyContent", # required
3605
3642
  # tags: {
3606
3643
  # "TagKey" => "TagValue",
@@ -3883,7 +3920,9 @@ module Aws::Connect
3883
3920
  # This API is in preview release for Amazon Connect and is subject to
3884
3921
  # change.
3885
3922
  #
3886
- # Deletes the Amazon Connect instance.
3923
+ # Deletes the Amazon Connect instance. For more information, see [Delete
3924
+ # your Amazon Connect instance][1] in the *Amazon Connect Administrator
3925
+ # Guide*.
3887
3926
  #
3888
3927
  # Amazon Connect enforces a limit on the total number of instances that
3889
3928
  # you can create or delete in 30 days. If you exceed this limit, you
@@ -3892,6 +3931,10 @@ module Aws::Connect
3892
3931
  # days before you can restart creating and deleting instances in your
3893
3932
  # account.
3894
3933
  #
3934
+ #
3935
+ #
3936
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html
3937
+ #
3895
3938
  # @option params [required, String] :instance_id
3896
3939
  # The identifier of the Amazon Connect instance. You can [find the
3897
3940
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -4009,7 +4052,8 @@ module Aws::Connect
4009
4052
  req.send_request(options)
4010
4053
  end
4011
4054
 
4012
- # Deletes a queue.
4055
+ # Deletes a queue. It isn't possible to delete a queue by using the
4056
+ # Amazon Connect admin website.
4013
4057
  #
4014
4058
  # @option params [required, String] :instance_id
4015
4059
  # The identifier of the Amazon Connect instance. You can [find the
@@ -4576,10 +4620,10 @@ module Aws::Connect
4576
4620
  #
4577
4621
  # Describes the specified contact.
4578
4622
  #
4579
- # Contact information remains available in Amazon Connect for 24 months,
4580
- # and then it is deleted.
4581
- #
4582
- # Only data from November 12, 2021, and later is returned by this API.
4623
+ # Contact information remains available in Amazon Connect for 24 months
4624
+ # from the InitiationTimestamp, and then it is deleted. Only contact
4625
+ # information that is available in Amazon Connect is returned by this
4626
+ # API
4583
4627
  #
4584
4628
  # @option params [required, String] :instance_id
4585
4629
  # The identifier of the Amazon Connect instance. You can [find the
@@ -5060,6 +5104,7 @@ module Aws::Connect
5060
5104
  # @return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5061
5105
  #
5062
5106
  # * {Types::DescribeInstanceResponse#instance #instance} => Types::Instance
5107
+ # * {Types::DescribeInstanceResponse#replication_configuration #replication_configuration} => Types::ReplicationConfiguration
5063
5108
  #
5064
5109
  # @example Request syntax with placeholder values
5065
5110
  #
@@ -5082,6 +5127,12 @@ module Aws::Connect
5082
5127
  # resp.instance.instance_access_url #=> String
5083
5128
  # resp.instance.tags #=> Hash
5084
5129
  # resp.instance.tags["TagKey"] #=> String
5130
+ # resp.replication_configuration.replication_status_summary_list #=> Array
5131
+ # resp.replication_configuration.replication_status_summary_list[0].region #=> String
5132
+ # resp.replication_configuration.replication_status_summary_list[0].replication_status #=> String, one of "INSTANCE_REPLICATION_COMPLETE", "INSTANCE_REPLICATION_IN_PROGRESS", "INSTANCE_REPLICATION_FAILED", "INSTANCE_REPLICA_DELETING", "INSTANCE_REPLICATION_DELETION_FAILED", "RESOURCE_REPLICATION_NOT_STARTED"
5133
+ # resp.replication_configuration.replication_status_summary_list[0].replication_status_reason #=> String
5134
+ # resp.replication_configuration.source_region #=> String
5135
+ # resp.replication_configuration.global_sign_in_endpoint #=> String
5085
5136
  #
5086
5137
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
5087
5138
  #
@@ -5242,7 +5293,14 @@ module Aws::Connect
5242
5293
  end
5243
5294
 
5244
5295
  # Describes a predefined attribute for the specified Amazon Connect
5245
- # instance.
5296
+ # instance. *Predefined attributes* are attributes in an Amazon Connect
5297
+ # instance that can be used to route contacts to an agent or pools of
5298
+ # agents within a queue. For more information, see [Create predefined
5299
+ # attributes for routing contacts to agents][1].
5300
+ #
5301
+ #
5302
+ #
5303
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
5246
5304
  #
5247
5305
  # @option params [required, String] :instance_id
5248
5306
  # The identifier of the Amazon Connect instance. You can find the
@@ -5559,7 +5617,17 @@ module Aws::Connect
5559
5617
  req.send_request(options)
5560
5618
  end
5561
5619
 
5562
- # Gets basic information about the security profle.
5620
+ # Gets basic information about the security profile.
5621
+ #
5622
+ # For information about security profiles, see [Security Profiles][1] in
5623
+ # the *Amazon Connect Administrator Guide*. For a mapping of the API
5624
+ # name and user interface name of the security profile permissions, see
5625
+ # [List of security profile permissions][2].
5626
+ #
5627
+ #
5628
+ #
5629
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
5630
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
5563
5631
  #
5564
5632
  # @option params [required, String] :security_profile_id
5565
5633
  # The identifier for the security profle.
@@ -5932,7 +6000,7 @@ module Aws::Connect
5932
6000
  # resp.vocabulary.name #=> String
5933
6001
  # resp.vocabulary.id #=> String
5934
6002
  # resp.vocabulary.arn #=> String
5935
- # resp.vocabulary.language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
6003
+ # resp.vocabulary.language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
5936
6004
  # resp.vocabulary.state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
5937
6005
  # resp.vocabulary.last_modified_time #=> Time
5938
6006
  # resp.vocabulary.failure_reason #=> String
@@ -5949,9 +6017,6 @@ module Aws::Connect
5949
6017
  req.send_request(options)
5950
6018
  end
5951
6019
 
5952
- # This API is in preview release for Amazon Connect and is subject to
5953
- # change.
5954
- #
5955
6020
  # Removes the dataset ID associated with a given Amazon Connect
5956
6021
  # instance.
5957
6022
  #
@@ -8165,8 +8230,8 @@ module Aws::Connect
8165
8230
  # Connect
8166
8231
  #
8167
8232
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
8168
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
8169
- # `LT` (for "Less than").
8233
+ # 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
8234
+ # (for "Less than") or `LTE` (for "Less than equal").
8170
8235
  #
8171
8236
  # UI name: [Contacts removed from queue in X seconds][51]
8172
8237
  #
@@ -8178,8 +8243,8 @@ module Aws::Connect
8178
8243
  # contact/segmentAttributes/connect:Subtype, Q in Connect
8179
8244
  #
8180
8245
  # Threshold: For `ThresholdValue` enter any whole number from 1 to
8181
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
8182
- # `LT` (for "Less than").
8246
+ # 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
8247
+ # (for "Less than") or `LTE` (for "Less than equal").
8183
8248
  #
8184
8249
  # UI name: [Contacts resolved in X][52]
8185
8250
  #
@@ -8460,8 +8525,8 @@ module Aws::Connect
8460
8525
  # Connect
8461
8526
  #
8462
8527
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
8463
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
8464
- # `LT` (for "Less than").
8528
+ # 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
8529
+ # (for "Less than") or `LTE` (for "Less than equal").
8465
8530
  #
8466
8531
  # UI name: [Service level X][72]
8467
8532
  #
@@ -8501,7 +8566,7 @@ module Aws::Connect
8501
8566
  #
8502
8567
  # </note>
8503
8568
  #
8504
- # SUM\_CONTACTS\_ABANDONED
8569
+ # CONTACTS\_ABANDONED
8505
8570
  #
8506
8571
  # : Unit: Count
8507
8572
  #
@@ -8526,8 +8591,8 @@ module Aws::Connect
8526
8591
  # contact/segmentAttributes/connect:Subtype, Q in Connect
8527
8592
  #
8528
8593
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
8529
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
8530
- # `LT` (for "Less than").
8594
+ # 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
8595
+ # (for "Less than") or `LTE` (for "Less than equal").
8531
8596
  #
8532
8597
  # UI name: [Contacts abandoned in X seconds][76]
8533
8598
  #
@@ -8539,8 +8604,8 @@ module Aws::Connect
8539
8604
  # contact/segmentAttributes/connect:Subtype, Q in Connect
8540
8605
  #
8541
8606
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
8542
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
8543
- # `LT` (for "Less than").
8607
+ # 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
8608
+ # (for "Less than") or `LTE` (for "Less than equal").
8544
8609
  #
8545
8610
  # UI name: [Contacts answered in X seconds][77]
8546
8611
  #
@@ -9149,9 +9214,6 @@ module Aws::Connect
9149
9214
  req.send_request(options)
9150
9215
  end
9151
9216
 
9152
- # This API is in preview release for Amazon Connect and is subject to
9153
- # change.
9154
- #
9155
9217
  # Lists the association status of requested dataset ID for a given
9156
9218
  # Amazon Connect instance.
9157
9219
  #
@@ -9673,7 +9735,7 @@ module Aws::Connect
9673
9735
  #
9674
9736
  # resp = client.list_default_vocabularies({
9675
9737
  # instance_id: "InstanceId", # required
9676
- # language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
9738
+ # language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
9677
9739
  # max_results: 1,
9678
9740
  # next_token: "VocabularyNextToken",
9679
9741
  # })
@@ -9682,7 +9744,7 @@ module Aws::Connect
9682
9744
  #
9683
9745
  # resp.default_vocabulary_list #=> Array
9684
9746
  # resp.default_vocabulary_list[0].instance_id #=> String
9685
- # resp.default_vocabulary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
9747
+ # resp.default_vocabulary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
9686
9748
  # resp.default_vocabulary_list[0].vocabulary_id #=> String
9687
9749
  # resp.default_vocabulary_list[0].vocabulary_name #=> String
9688
9750
  # resp.next_token #=> String
@@ -10477,6 +10539,14 @@ module Aws::Connect
10477
10539
  end
10478
10540
 
10479
10541
  # Lists predefined attributes for the specified Amazon Connect instance.
10542
+ # *Predefined attributes* are attributes in an Amazon Connect instance
10543
+ # that can be used to route contacts to an agent or pools of agents
10544
+ # within a queue. For more information, see [Create predefined
10545
+ # attributes for routing contacts to agents][1].
10546
+ #
10547
+ #
10548
+ #
10549
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
10480
10550
  #
10481
10551
  # @option params [required, String] :instance_id
10482
10552
  # The identifier of the Amazon Connect instance. You can find the
@@ -11181,6 +11251,16 @@ module Aws::Connect
11181
11251
 
11182
11252
  # Lists the permissions granted to a security profile.
11183
11253
  #
11254
+ # For information about security profiles, see [Security Profiles][1] in
11255
+ # the *Amazon Connect Administrator Guide*. For a mapping of the API
11256
+ # name and user interface name of the security profile permissions, see
11257
+ # [List of security profile permissions][2].
11258
+ #
11259
+ #
11260
+ #
11261
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
11262
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
11263
+ #
11184
11264
  # @option params [required, String] :security_profile_id
11185
11265
  # The identifier for the security profle.
11186
11266
  #
@@ -11239,11 +11319,14 @@ module Aws::Connect
11239
11319
  # specified Amazon Connect instance.
11240
11320
  #
11241
11321
  # For more information about security profiles, see [Security
11242
- # Profiles][1] in the *Amazon Connect Administrator Guide*.
11322
+ # Profiles][1] in the *Amazon Connect Administrator Guide*. For a
11323
+ # mapping of the API name and user interface name of the security
11324
+ # profile permissions, see [List of security profile permissions][2].
11243
11325
  #
11244
11326
  #
11245
11327
  #
11246
11328
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
11329
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
11247
11330
  #
11248
11331
  # @option params [required, String] :instance_id
11249
11332
  # The identifier of the Amazon Connect instance. You can [find the
@@ -12809,7 +12892,15 @@ module Aws::Connect
12809
12892
  req.send_request(options)
12810
12893
  end
12811
12894
 
12812
- # Predefined attributes that meet certain criteria.
12895
+ # Searches predefined attributes that meet certain criteria. *Predefined
12896
+ # attributes* are attributes in an Amazon Connect instance that can be
12897
+ # used to route contacts to an agent or pools of agents within a queue.
12898
+ # For more information, see [Create predefined attributes for routing
12899
+ # contacts to agents][1].
12900
+ #
12901
+ #
12902
+ #
12903
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
12813
12904
  #
12814
12905
  # @option params [required, String] :instance_id
12815
12906
  # The identifier of the Amazon Connect instance. You can find the
@@ -13414,6 +13505,16 @@ module Aws::Connect
13414
13505
  # Searches security profiles in an Amazon Connect instance, with
13415
13506
  # optional filtering.
13416
13507
  #
13508
+ # For information about security profiles, see [Security Profiles][1] in
13509
+ # the *Amazon Connect Administrator Guide*. For a mapping of the API
13510
+ # name and user interface name of the security profile permissions, see
13511
+ # [List of security profile permissions][2].
13512
+ #
13513
+ #
13514
+ #
13515
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
13516
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
13517
+ #
13417
13518
  # @option params [required, String] :instance_id
13418
13519
  # The identifier of the Amazon Connect instance. You can [find the
13419
13520
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -13888,7 +13989,7 @@ module Aws::Connect
13888
13989
  # next_token: "VocabularyNextToken",
13889
13990
  # state: "CREATION_IN_PROGRESS", # accepts CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
13890
13991
  # name_starts_with: "VocabularyName",
13891
- # language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
13992
+ # language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
13892
13993
  # })
13893
13994
  #
13894
13995
  # @example Response structure
@@ -13897,7 +13998,7 @@ module Aws::Connect
13897
13998
  # resp.vocabulary_summary_list[0].name #=> String
13898
13999
  # resp.vocabulary_summary_list[0].id #=> String
13899
14000
  # resp.vocabulary_summary_list[0].arn #=> String
13900
- # resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
14001
+ # resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
13901
14002
  # resp.vocabulary_summary_list[0].state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
13902
14003
  # resp.vocabulary_summary_list[0].last_modified_time #=> Time
13903
14004
  # resp.vocabulary_summary_list[0].failure_reason #=> String
@@ -14514,6 +14615,174 @@ module Aws::Connect
14514
14615
  req.send_request(options)
14515
14616
  end
14516
14617
 
14618
+ # Initiates a new outbound SMS contact to a customer. Response of this
14619
+ # API provides the ContactId of the outbound SMS contact created.
14620
+ #
14621
+ # **SourceEndpoint** only supports Endpoints with
14622
+ # `CONNECT_PHONENUMBER_ARN` as Type and **DestinationEndpoint** only
14623
+ # supports Endpoints with `TELEPHONE_NUMBER` as Type. **ContactFlowId**
14624
+ # initiates the flow to manage the new SMS contact created.
14625
+ #
14626
+ # This API can be used to initiate outbound SMS contacts for an agent or
14627
+ # it can also deflect an ongoing contact to an outbound SMS contact by
14628
+ # using the [StartOutboundChatContact][1] Flow Action.
14629
+ #
14630
+ # For more information about using SMS in Amazon Connect, see the
14631
+ # following topics in the *Amazon Connect Administrator Guide*:
14632
+ #
14633
+ # * [Set up SMS messaging][2]
14634
+ #
14635
+ # * [Request an SMS-enabled phone number through AWS End User Messaging
14636
+ # SMS][3]
14637
+ #
14638
+ #
14639
+ #
14640
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html
14641
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html
14642
+ # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/sms-number.html
14643
+ #
14644
+ # @option params [required, Types::Endpoint] :source_endpoint
14645
+ # Information about the endpoint.
14646
+ #
14647
+ # @option params [required, Types::Endpoint] :destination_endpoint
14648
+ # Information about the endpoint.
14649
+ #
14650
+ # @option params [required, String] :instance_id
14651
+ # The identifier of the Amazon Connect instance. You can find the
14652
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
14653
+ #
14654
+ # @option params [required, Hash<String,Types::SegmentAttributeValue>] :segment_attributes
14655
+ # A set of system defined key-value pairs stored on individual contact
14656
+ # segments using an attribute map. The attributes are standard Amazon
14657
+ # Connect attributes. They can be accessed in flows.
14658
+ #
14659
+ # * Attribute keys can include only alphanumeric, `-`, and `_`.
14660
+ #
14661
+ # * This field can be used to show channel subtype, such as
14662
+ # `connect:Guide` and `connect:SMS`.
14663
+ #
14664
+ # @option params [Hash<String,String>] :attributes
14665
+ # A custom key-value pair using an attribute map. The attributes are
14666
+ # standard Amazon Connect attributes, and can be accessed in flows just
14667
+ # like any other contact attributes.
14668
+ #
14669
+ # @option params [required, String] :contact_flow_id
14670
+ # The identifier of the flow for the call. To see the ContactFlowId in
14671
+ # the Amazon Connect console user interface, on the navigation menu go
14672
+ # to **Routing, Contact Flows**. Choose the flow. On the flow page,
14673
+ # under the name of the flow, choose **Show additional flow
14674
+ # information**. The ContactFlowId is the last part of the ARN, shown
14675
+ # here in bold:
14676
+ #
14677
+ # * arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**123ec456-a007-89c0-1234-xxxxxxxxxxxx**
14678
+ #
14679
+ # ^
14680
+ #
14681
+ # @option params [Integer] :chat_duration_in_minutes
14682
+ # The total duration of the newly started chat session. If not
14683
+ # specified, the chat session duration defaults to 25 hour. The minimum
14684
+ # configurable time is 60 minutes. The maximum configurable time is
14685
+ # 10,080 minutes (7 days).
14686
+ #
14687
+ # @option params [Types::ParticipantDetails] :participant_details
14688
+ # The customer's details.
14689
+ #
14690
+ # @option params [Types::ChatMessage] :initial_system_message
14691
+ # A chat message.
14692
+ #
14693
+ # @option params [String] :related_contact_id
14694
+ # The unique identifier for an Amazon Connect contact. This identifier
14695
+ # is related to the contact starting.
14696
+ #
14697
+ # @option params [Array<String>] :supported_messaging_content_types
14698
+ # The supported chat message content types. Supported types are:
14699
+ #
14700
+ # * `text/plain`
14701
+ #
14702
+ # * `text/markdown`
14703
+ #
14704
+ # * `application/json,
14705
+ # application/vnd.amazonaws.connect.message.interactive`
14706
+ #
14707
+ # * `application/vnd.amazonaws.connect.message.interactive.response`
14708
+ #
14709
+ # Content types must always contain `text/plain`. You can then put any
14710
+ # other supported type in the list. For example, all the following lists
14711
+ # are valid because they contain `text/plain`:
14712
+ #
14713
+ # * `[text/plain, text/markdown, application/json]`
14714
+ #
14715
+ # * `[text/markdown, text/plain]`
14716
+ #
14717
+ # * `[text/plain, application/json,
14718
+ # application/vnd.amazonaws.connect.message.interactive.response]`
14719
+ #
14720
+ # @option params [String] :client_token
14721
+ # A unique, case-sensitive identifier that you provide to ensure the
14722
+ # idempotency of the request. If not provided, the AWS SDK populates
14723
+ # this field. For more information about idempotency, see [Making
14724
+ # retries safe with idempotent APIs][1]. The token is valid for 7 days
14725
+ # after creation. If a contact is already started, the contact ID is
14726
+ # returned.
14727
+ #
14728
+ # **A suitable default value is auto-generated.** You should normally
14729
+ # not need to pass this option.**
14730
+ #
14731
+ #
14732
+ #
14733
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
14734
+ #
14735
+ # @return [Types::StartOutboundChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14736
+ #
14737
+ # * {Types::StartOutboundChatContactResponse#contact_id #contact_id} => String
14738
+ #
14739
+ # @example Request syntax with placeholder values
14740
+ #
14741
+ # resp = client.start_outbound_chat_contact({
14742
+ # source_endpoint: { # required
14743
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
14744
+ # address: "EndpointAddress",
14745
+ # },
14746
+ # destination_endpoint: { # required
14747
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
14748
+ # address: "EndpointAddress",
14749
+ # },
14750
+ # instance_id: "InstanceId", # required
14751
+ # segment_attributes: { # required
14752
+ # "SegmentAttributeName" => {
14753
+ # value_string: "SegmentAttributeValueString",
14754
+ # },
14755
+ # },
14756
+ # attributes: {
14757
+ # "AttributeName" => "AttributeValue",
14758
+ # },
14759
+ # contact_flow_id: "ContactFlowId", # required
14760
+ # chat_duration_in_minutes: 1,
14761
+ # participant_details: {
14762
+ # display_name: "DisplayName", # required
14763
+ # },
14764
+ # initial_system_message: {
14765
+ # content_type: "ChatContentType", # required
14766
+ # content: "ChatContent", # required
14767
+ # },
14768
+ # related_contact_id: "ContactId",
14769
+ # supported_messaging_content_types: ["SupportedMessagingContentType"],
14770
+ # client_token: "ClientToken",
14771
+ # })
14772
+ #
14773
+ # @example Response structure
14774
+ #
14775
+ # resp.contact_id #=> String
14776
+ #
14777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundChatContact AWS API Documentation
14778
+ #
14779
+ # @overload start_outbound_chat_contact(params = {})
14780
+ # @param [Hash] params ({})
14781
+ def start_outbound_chat_contact(params = {}, options = {})
14782
+ req = build_request(:start_outbound_chat_contact, params)
14783
+ req.send_request(options)
14784
+ end
14785
+
14517
14786
  # Places an outbound call to a contact, and then initiates the flow. It
14518
14787
  # performs the actions in the flow that's specified (in
14519
14788
  # `ContactFlowId`).
@@ -16091,6 +16360,10 @@ module Aws::Connect
16091
16360
  # other contacts in the queue by assigning them a higher priority, such
16092
16361
  # as 1 or 2.
16093
16362
  #
16363
+ # @option params [Types::RoutingCriteriaInput] :routing_criteria
16364
+ # Updates the routing criteria on the contact. These properties can be
16365
+ # used to change how a
 contact is routed within the queue.
16366
+ #
16094
16367
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
16095
16368
  #
16096
16369
  # @example Request syntax with placeholder values
@@ -16100,6 +16373,38 @@ module Aws::Connect
16100
16373
  # contact_id: "ContactId", # required
16101
16374
  # queue_time_adjustment_seconds: 1,
16102
16375
  # queue_priority: 1,
16376
+ # routing_criteria: {
16377
+ # steps: [
16378
+ # {
16379
+ # expiry: {
16380
+ # duration_in_seconds: 1,
16381
+ # },
16382
+ # expression: {
16383
+ # attribute_condition: {
16384
+ # name: "PredefinedAttributeName",
16385
+ # value: "ProficiencyValue",
16386
+ # proficiency_level: 1.0,
16387
+ # match_criteria: {
16388
+ # agents_criteria: {
16389
+ # agent_ids: ["AgentId"],
16390
+ # },
16391
+ # },
16392
+ # comparison_operator: "ComparisonOperator",
16393
+ # },
16394
+ # and_expression: [
16395
+ # {
16396
+ # # recursive Expression
16397
+ # },
16398
+ # ],
16399
+ # or_expression: [
16400
+ # {
16401
+ # # recursive Expression
16402
+ # },
16403
+ # ],
16404
+ # },
16405
+ # },
16406
+ # ],
16407
+ # },
16103
16408
  # })
16104
16409
  #
16105
16410
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingData AWS API Documentation
@@ -16666,7 +16971,14 @@ module Aws::Connect
16666
16971
  end
16667
16972
 
16668
16973
  # Updates a predefined attribute for the specified Amazon Connect
16669
- # instance.
16974
+ # instance. *Predefined attributes* are attributes in an Amazon Connect
16975
+ # instance that can be used to route contacts to an agent or pools of
16976
+ # agents within a queue. For more information, see [Create predefined
16977
+ # attributes for routing contacts to agents][1].
16978
+ #
16979
+ #
16980
+ #
16981
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
16670
16982
  #
16671
16983
  # @option params [required, String] :instance_id
16672
16984
  # The identifier of the Amazon Connect instance. You can find the
@@ -17406,6 +17718,16 @@ module Aws::Connect
17406
17718
 
17407
17719
  # Updates a security profile.
17408
17720
  #
17721
+ # For information about security profiles, see [Security Profiles][1] in
17722
+ # the *Amazon Connect Administrator Guide*. For a mapping of the API
17723
+ # name and user interface name of the security profile permissions, see
17724
+ # [List of security profile permissions][2].
17725
+ #
17726
+ #
17727
+ #
17728
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
17729
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
17730
+ #
17409
17731
  # @option params [String] :description
17410
17732
  # The description of the security profile.
17411
17733
  #
@@ -18138,14 +18460,19 @@ module Aws::Connect
18138
18460
  # @api private
18139
18461
  def build_request(operation_name, params = {})
18140
18462
  handlers = @handlers.for(operation_name)
18463
+ tracer = config.telemetry_provider.tracer_provider.tracer(
18464
+ Aws::Telemetry.module_to_tracer_name('Aws::Connect')
18465
+ )
18141
18466
  context = Seahorse::Client::RequestContext.new(
18142
18467
  operation_name: operation_name,
18143
18468
  operation: config.api.operation(operation_name),
18144
18469
  client: self,
18145
18470
  params: params,
18146
- config: config)
18471
+ config: config,
18472
+ tracer: tracer
18473
+ )
18147
18474
  context[:gem_name] = 'aws-sdk-connect'
18148
- context[:gem_version] = '1.169.0'
18475
+ context[:gem_version] = '1.179.0'
18149
18476
  Seahorse::Client::Request.new(handlers, context)
18150
18477
  end
18151
18478