aws-sdk-connect 1.181.0 → 1.183.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +69 -16
- data/lib/aws-sdk-connect/client_api.rb +25 -0
- data/lib/aws-sdk-connect/types.rb +119 -41
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +15 -2
- data/sig/types.rbs +11 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3df0682bc9160b6dd7be40e6a0588febde8d493b973090c53b078dd7d34939c8
|
4
|
+
data.tar.gz: 0ccf80ee956a5dfe1fa1facd363fd3583624321b122a8fe044310fa49bc6744a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 85b87b09f9ffd0f4263ec34294497b74f703356ba43f633739576e7007f16ff4b1aaa14358bba80c12fa37151104884292487fed6e4e44c0334807d42ff00d68
|
7
|
+
data.tar.gz: 56ad1fce44e1df38fed5673e84632bc12f2cc076864878087796681a5119a2535d9a10fe2bf8dd3ae3f4eb95c1103a326c145ca193c3b96945c3ae08f1fcafc1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.183.0 (2024-10-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Updated the public documentation for the UserIdentityInfo object to accurately reflect the character limits for the FirstName and LastName fields, which were previously listed as 1-100 characters.
|
8
|
+
|
9
|
+
1.182.0 (2024-10-23)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Connect Service Feature: Add support to start screen sharing for a web calling contact.
|
13
|
+
|
4
14
|
1.181.0 (2024-10-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.183.0
|
@@ -1050,13 +1050,13 @@ module Aws::Connect
|
|
1050
1050
|
req.send_request(options)
|
1051
1051
|
end
|
1052
1052
|
|
1053
|
-
# Associates an agent with a traffic distribution group.
|
1053
|
+
# Associates an agent with a traffic distribution group. This API can be
|
1054
|
+
# called only in the Region where the traffic distribution group is
|
1055
|
+
# created.
|
1054
1056
|
#
|
1055
1057
|
# @option params [required, String] :traffic_distribution_group_id
|
1056
1058
|
# The identifier of the traffic distribution group. This can be the ID
|
1057
|
-
# or the ARN
|
1058
|
-
# distribution group was created. The ARN must be provided if the call
|
1059
|
-
# is from the replicated Region.
|
1059
|
+
# or the ARN of the traffic distribution group.
|
1060
1060
|
#
|
1061
1061
|
# @option params [required, String] :user_id
|
1062
1062
|
# The identifier of the user account. This can be the ID or the ARN of
|
@@ -4270,9 +4270,7 @@ module Aws::Connect
|
|
4270
4270
|
#
|
4271
4271
|
# @option params [required, String] :traffic_distribution_group_id
|
4272
4272
|
# The identifier of the traffic distribution group. This can be the ID
|
4273
|
-
# or the ARN
|
4274
|
-
# distribution group was created. The ARN must be provided if the call
|
4275
|
-
# is from the replicated Region.
|
4273
|
+
# or the ARN of the traffic distribution group.
|
4276
4274
|
#
|
4277
4275
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4278
4276
|
#
|
@@ -4671,6 +4669,7 @@ module Aws::Connect
|
|
4671
4669
|
# resp.contact.agent_info.device_info.platform_version #=> String
|
4672
4670
|
# resp.contact.agent_info.device_info.operating_system #=> String
|
4673
4671
|
# resp.contact.agent_info.capabilities.video #=> String, one of "SEND"
|
4672
|
+
# resp.contact.agent_info.capabilities.screen_share #=> String, one of "SEND"
|
4674
4673
|
# resp.contact.initiation_timestamp #=> Time
|
4675
4674
|
# resp.contact.disconnect_timestamp #=> Time
|
4676
4675
|
# resp.contact.last_update_timestamp #=> Time
|
@@ -4706,6 +4705,7 @@ module Aws::Connect
|
|
4706
4705
|
# resp.contact.customer.device_info.platform_version #=> String
|
4707
4706
|
# resp.contact.customer.device_info.operating_system #=> String
|
4708
4707
|
# resp.contact.customer.capabilities.video #=> String, one of "SEND"
|
4708
|
+
# resp.contact.customer.capabilities.screen_share #=> String, one of "SEND"
|
4709
4709
|
# resp.contact.campaign.campaign_id #=> String
|
4710
4710
|
# resp.contact.answering_machine_detection_status #=> String, one of "ANSWERED", "UNDETECTED", "ERROR", "HUMAN_ANSWERED", "SIT_TONE_DETECTED", "SIT_TONE_BUSY", "SIT_TONE_INVALID_NUMBER", "FAX_MACHINE_DETECTED", "VOICEMAIL_BEEP", "VOICEMAIL_NO_BEEP", "AMD_UNRESOLVED", "AMD_UNANSWERED", "AMD_ERROR", "AMD_NOT_APPLICABLE"
|
4711
4711
|
# resp.contact.customer_voice_activity.greeting_start_timestamp #=> Time
|
@@ -6441,13 +6441,13 @@ module Aws::Connect
|
|
6441
6441
|
req.send_request(options)
|
6442
6442
|
end
|
6443
6443
|
|
6444
|
-
# Disassociates an agent from a traffic distribution group.
|
6444
|
+
# Disassociates an agent from a traffic distribution group. This API can
|
6445
|
+
# be called only in the Region where the traffic distribution group is
|
6446
|
+
# created.
|
6445
6447
|
#
|
6446
6448
|
# @option params [required, String] :traffic_distribution_group_id
|
6447
6449
|
# The identifier of the traffic distribution group. This can be the ID
|
6448
|
-
# or the ARN
|
6449
|
-
# distribution group was created. The ARN must be provided if the call
|
6450
|
-
# is from the replicated Region.
|
6450
|
+
# or the ARN of the traffic distribution group.
|
6451
6451
|
#
|
6452
6452
|
# @option params [required, String] :user_id
|
6453
6453
|
# The identifier for the user. This can be the ID or the ARN of the
|
@@ -7470,7 +7470,7 @@ module Aws::Connect
|
|
7470
7470
|
# a metric level, and offers the ability to filter and group data by
|
7471
7471
|
# channels, queues, routing profiles, agents, and agent hierarchy
|
7472
7472
|
# levels. It can retrieve historical data for the last 3 months, at
|
7473
|
-
# varying intervals.
|
7473
|
+
# varying intervals. It does not support agent queues.
|
7474
7474
|
#
|
7475
7475
|
# For a description of the historical metrics that are supported by
|
7476
7476
|
# `GetMetricDataV2` and `GetMetricData`, see [Historical metrics
|
@@ -7784,7 +7784,7 @@ module Aws::Connect
|
|
7784
7784
|
#
|
7785
7785
|
# UI name: [Average agent API connecting time][15]
|
7786
7786
|
#
|
7787
|
-
# <note markdown="1"> The `Negate` key in
|
7787
|
+
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for this
|
7788
7788
|
# metric.
|
7789
7789
|
#
|
7790
7790
|
# </note>
|
@@ -8242,7 +8242,7 @@ module Aws::Connect
|
|
8242
8242
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8243
8243
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8244
8244
|
#
|
8245
|
-
# Threshold: For `ThresholdValue
|
8245
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8246
8246
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8247
8247
|
# (for "Less than") or `LTE` (for "Less than equal").
|
8248
8248
|
#
|
@@ -8561,7 +8561,7 @@ module Aws::Connect
|
|
8561
8561
|
#
|
8562
8562
|
# UI name: [Agent API connecting time][74]
|
8563
8563
|
#
|
8564
|
-
# <note markdown="1"> The `Negate` key in
|
8564
|
+
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for this
|
8565
8565
|
# metric.
|
8566
8566
|
#
|
8567
8567
|
# </note>
|
@@ -14951,6 +14951,57 @@ module Aws::Connect
|
|
14951
14951
|
req.send_request(options)
|
14952
14952
|
end
|
14953
14953
|
|
14954
|
+
# Starts screen sharing for a contact. For more information about screen
|
14955
|
+
# sharing, see [Set up in-app, web, video calling, and screen sharing
|
14956
|
+
# capabilities][1] in the *Amazon Connect Administrator Guide*.
|
14957
|
+
#
|
14958
|
+
#
|
14959
|
+
#
|
14960
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
|
14961
|
+
#
|
14962
|
+
# @option params [String] :client_token
|
14963
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
14964
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
14965
|
+
# SDK populates this field. For more information about idempotency, see
|
14966
|
+
# [Making retries safe with idempotent APIs][1].
|
14967
|
+
#
|
14968
|
+
# **A suitable default value is auto-generated.** You should normally
|
14969
|
+
# not need to pass this option.**
|
14970
|
+
#
|
14971
|
+
#
|
14972
|
+
#
|
14973
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
14974
|
+
#
|
14975
|
+
# @option params [required, String] :instance_id
|
14976
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
14977
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
14978
|
+
#
|
14979
|
+
#
|
14980
|
+
#
|
14981
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
14982
|
+
#
|
14983
|
+
# @option params [required, String] :contact_id
|
14984
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
14985
|
+
#
|
14986
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
14987
|
+
#
|
14988
|
+
# @example Request syntax with placeholder values
|
14989
|
+
#
|
14990
|
+
# resp = client.start_screen_sharing({
|
14991
|
+
# client_token: "ClientToken",
|
14992
|
+
# instance_id: "InstanceId", # required
|
14993
|
+
# contact_id: "ContactId", # required
|
14994
|
+
# })
|
14995
|
+
#
|
14996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartScreenSharing AWS API Documentation
|
14997
|
+
#
|
14998
|
+
# @overload start_screen_sharing(params = {})
|
14999
|
+
# @param [Hash] params ({})
|
15000
|
+
def start_screen_sharing(params = {}, options = {})
|
15001
|
+
req = build_request(:start_screen_sharing, params)
|
15002
|
+
req.send_request(options)
|
15003
|
+
end
|
15004
|
+
|
14954
15005
|
# Initiates a flow to start a new task contact. For more information
|
14955
15006
|
# about task contacts, see [Concepts: Tasks in Amazon Connect][1] in the
|
14956
15007
|
# *Amazon Connect Administrator Guide*.
|
@@ -15223,9 +15274,11 @@ module Aws::Connect
|
|
15223
15274
|
# allowed_capabilities: {
|
15224
15275
|
# customer: {
|
15225
15276
|
# video: "SEND", # accepts SEND
|
15277
|
+
# screen_share: "SEND", # accepts SEND
|
15226
15278
|
# },
|
15227
15279
|
# agent: {
|
15228
15280
|
# video: "SEND", # accepts SEND
|
15281
|
+
# screen_share: "SEND", # accepts SEND
|
15229
15282
|
# },
|
15230
15283
|
# },
|
15231
15284
|
# participant_details: { # required
|
@@ -18472,7 +18525,7 @@ module Aws::Connect
|
|
18472
18525
|
tracer: tracer
|
18473
18526
|
)
|
18474
18527
|
context[:gem_name] = 'aws-sdk-connect'
|
18475
|
-
context[:gem_version] = '1.
|
18528
|
+
context[:gem_version] = '1.183.0'
|
18476
18529
|
Seahorse::Client::Request.new(handlers, context)
|
18477
18530
|
end
|
18478
18531
|
|
@@ -1018,6 +1018,7 @@ module Aws::Connect
|
|
1018
1018
|
RuleTriggerEventSource = Shapes::StructureShape.new(name: 'RuleTriggerEventSource')
|
1019
1019
|
S3Config = Shapes::StructureShape.new(name: 'S3Config')
|
1020
1020
|
S3Uri = Shapes::StringShape.new(name: 'S3Uri')
|
1021
|
+
ScreenShareCapability = Shapes::StringShape.new(name: 'ScreenShareCapability')
|
1021
1022
|
SearchAgentStatusesRequest = Shapes::StructureShape.new(name: 'SearchAgentStatusesRequest')
|
1022
1023
|
SearchAgentStatusesResponse = Shapes::StructureShape.new(name: 'SearchAgentStatusesResponse')
|
1023
1024
|
SearchAvailablePhoneNumbersRequest = Shapes::StructureShape.new(name: 'SearchAvailablePhoneNumbersRequest')
|
@@ -1117,6 +1118,8 @@ module Aws::Connect
|
|
1117
1118
|
StartOutboundChatContactResponse = Shapes::StructureShape.new(name: 'StartOutboundChatContactResponse')
|
1118
1119
|
StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
|
1119
1120
|
StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
|
1121
|
+
StartScreenSharingRequest = Shapes::StructureShape.new(name: 'StartScreenSharingRequest')
|
1122
|
+
StartScreenSharingResponse = Shapes::StructureShape.new(name: 'StartScreenSharingResponse')
|
1120
1123
|
StartTaskContactRequest = Shapes::StructureShape.new(name: 'StartTaskContactRequest')
|
1121
1124
|
StartTaskContactResponse = Shapes::StructureShape.new(name: 'StartTaskContactResponse')
|
1122
1125
|
StartWebRTCContactRequest = Shapes::StructureShape.new(name: 'StartWebRTCContactRequest')
|
@@ -4011,6 +4014,7 @@ module Aws::Connect
|
|
4011
4014
|
OutputTypeNotFoundException.struct_class = Types::OutputTypeNotFoundException
|
4012
4015
|
|
4013
4016
|
ParticipantCapabilities.add_member(:video, Shapes::ShapeRef.new(shape: VideoCapability, location_name: "Video"))
|
4017
|
+
ParticipantCapabilities.add_member(:screen_share, Shapes::ShapeRef.new(shape: ScreenShareCapability, location_name: "ScreenShare"))
|
4014
4018
|
ParticipantCapabilities.struct_class = Types::ParticipantCapabilities
|
4015
4019
|
|
4016
4020
|
ParticipantDetails.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, required: true, location_name: "DisplayName"))
|
@@ -5013,6 +5017,13 @@ module Aws::Connect
|
|
5013
5017
|
StartOutboundVoiceContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
5014
5018
|
StartOutboundVoiceContactResponse.struct_class = Types::StartOutboundVoiceContactResponse
|
5015
5019
|
|
5020
|
+
StartScreenSharingRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
5021
|
+
StartScreenSharingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
5022
|
+
StartScreenSharingRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
|
5023
|
+
StartScreenSharingRequest.struct_class = Types::StartScreenSharingRequest
|
5024
|
+
|
5025
|
+
StartScreenSharingResponse.struct_class = Types::StartScreenSharingResponse
|
5026
|
+
|
5016
5027
|
StartTaskContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
5017
5028
|
StartTaskContactRequest.add_member(:previous_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "PreviousContactId"))
|
5018
5029
|
StartTaskContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId"))
|
@@ -8888,6 +8899,20 @@ module Aws::Connect
|
|
8888
8899
|
o.errors << Shapes::ShapeRef.new(shape: OutboundContactNotPermittedException)
|
8889
8900
|
end)
|
8890
8901
|
|
8902
|
+
api.add_operation(:start_screen_sharing, Seahorse::Model::Operation.new.tap do |o|
|
8903
|
+
o.name = "StartScreenSharing"
|
8904
|
+
o.http_method = "PUT"
|
8905
|
+
o.http_request_uri = "/contact/screen-sharing"
|
8906
|
+
o.input = Shapes::ShapeRef.new(shape: StartScreenSharingRequest)
|
8907
|
+
o.output = Shapes::ShapeRef.new(shape: StartScreenSharingResponse)
|
8908
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
8909
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
8910
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
8911
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
8912
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
8913
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
8914
|
+
end)
|
8915
|
+
|
8891
8916
|
api.add_operation(:start_task_contact, Seahorse::Model::Operation.new.tap do |o|
|
8892
8917
|
o.name = "StartTaskContact"
|
8893
8918
|
o.http_method = "PUT"
|
@@ -239,8 +239,15 @@ module Aws::Connect
|
|
239
239
|
# @return [Types::DeviceInfo]
|
240
240
|
#
|
241
241
|
# @!attribute [rw] capabilities
|
242
|
-
# The configuration for the allowed
|
243
|
-
# present over the call.
|
242
|
+
# The configuration for the allowed video and screen sharing
|
243
|
+
# capabilities for participants present over the call. For more
|
244
|
+
# information, see [Set up in-app, web, video calling, and screen
|
245
|
+
# sharing capabilities][1] in the *Amazon Connect Administrator
|
246
|
+
# Guide*.
|
247
|
+
#
|
248
|
+
#
|
249
|
+
#
|
250
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
|
244
251
|
# @return [Types::ParticipantCapabilities]
|
245
252
|
#
|
246
253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentInfo AWS API Documentation
|
@@ -986,9 +993,7 @@ module Aws::Connect
|
|
986
993
|
|
987
994
|
# @!attribute [rw] traffic_distribution_group_id
|
988
995
|
# The identifier of the traffic distribution group. This can be the ID
|
989
|
-
# or the ARN
|
990
|
-
# traffic distribution group was created. The ARN must be provided if
|
991
|
-
# the call is from the replicated Region.
|
996
|
+
# or the ARN of the traffic distribution group.
|
992
997
|
# @return [String]
|
993
998
|
#
|
994
999
|
# @!attribute [rw] user_id
|
@@ -4313,9 +4318,7 @@ module Aws::Connect
|
|
4313
4318
|
|
4314
4319
|
# @!attribute [rw] id
|
4315
4320
|
# The identifier of the traffic distribution group. This can be the ID
|
4316
|
-
# or the ARN
|
4317
|
-
# traffic distribution group was created. The ARN must be provided if
|
4318
|
-
# the call is from the replicated Region.
|
4321
|
+
# or the ARN of the traffic distribution group.
|
4319
4322
|
# @return [String]
|
4320
4323
|
#
|
4321
4324
|
# @!attribute [rw] arn
|
@@ -4916,8 +4919,15 @@ module Aws::Connect
|
|
4916
4919
|
# @return [Types::DeviceInfo]
|
4917
4920
|
#
|
4918
4921
|
# @!attribute [rw] capabilities
|
4919
|
-
# The configuration for the allowed
|
4920
|
-
# present over the call.
|
4922
|
+
# The configuration for the allowed video and screen sharing
|
4923
|
+
# capabilities for participants present over the call. For more
|
4924
|
+
# information, see [Set up in-app, web, video calling, and screen
|
4925
|
+
# sharing capabilities][1] in the *Amazon Connect Administrator
|
4926
|
+
# Guide*.
|
4927
|
+
#
|
4928
|
+
#
|
4929
|
+
#
|
4930
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
|
4921
4931
|
# @return [Types::ParticipantCapabilities]
|
4922
4932
|
#
|
4923
4933
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Customer AWS API Documentation
|
@@ -5453,9 +5463,7 @@ module Aws::Connect
|
|
5453
5463
|
|
5454
5464
|
# @!attribute [rw] traffic_distribution_group_id
|
5455
5465
|
# The identifier of the traffic distribution group. This can be the ID
|
5456
|
-
# or the ARN
|
5457
|
-
# traffic distribution group was created. The ARN must be provided if
|
5458
|
-
# the call is from the replicated Region.
|
5466
|
+
# or the ARN of the traffic distribution group.
|
5459
5467
|
# @return [String]
|
5460
5468
|
#
|
5461
5469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTrafficDistributionGroupRequest AWS API Documentation
|
@@ -6838,9 +6846,7 @@ module Aws::Connect
|
|
6838
6846
|
|
6839
6847
|
# @!attribute [rw] traffic_distribution_group_id
|
6840
6848
|
# The identifier of the traffic distribution group. This can be the ID
|
6841
|
-
# or the ARN
|
6842
|
-
# traffic distribution group was created. The ARN must be provided if
|
6843
|
-
# the call is from the replicated Region.
|
6849
|
+
# or the ARN of the traffic distribution group.
|
6844
6850
|
# @return [String]
|
6845
6851
|
#
|
6846
6852
|
# @!attribute [rw] user_id
|
@@ -9348,7 +9354,7 @@ module Aws::Connect
|
|
9348
9354
|
#
|
9349
9355
|
# UI name: [Average agent API connecting time][15]
|
9350
9356
|
#
|
9351
|
-
# <note markdown="1"> The `Negate` key in
|
9357
|
+
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for
|
9352
9358
|
# this metric.
|
9353
9359
|
#
|
9354
9360
|
# </note>
|
@@ -9808,7 +9814,7 @@ module Aws::Connect
|
|
9808
9814
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
9809
9815
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
9810
9816
|
#
|
9811
|
-
# Threshold: For `ThresholdValue
|
9817
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
9812
9818
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
9813
9819
|
# (for "Less than") or `LTE` (for "Less than equal").
|
9814
9820
|
#
|
@@ -10127,7 +10133,7 @@ module Aws::Connect
|
|
10127
10133
|
#
|
10128
10134
|
# UI name: [Agent API connecting time][74]
|
10129
10135
|
#
|
10130
|
-
# <note markdown="1"> The `Negate` key in
|
10136
|
+
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for
|
10131
10137
|
# this metric.
|
10132
10138
|
#
|
10133
10139
|
# </note>
|
@@ -14499,34 +14505,48 @@ module Aws::Connect
|
|
14499
14505
|
# @!attribute [rw] metric_filter_key
|
14500
14506
|
# The key to use for filtering data.
|
14501
14507
|
#
|
14502
|
-
# Valid metric filter keys:
|
14503
|
-
# These are the same values as the `InitiationMethod` and
|
14504
|
-
# `DisconnectReason` in the contact record. For more information, see
|
14505
|
-
# [ContactTraceRecord][1] in the *Amazon Connect Administrator Guide*.
|
14508
|
+
# Valid metric filter keys:
|
14506
14509
|
#
|
14510
|
+
# * ANSWERING\_MACHINE\_DETECTION\_STATUS
|
14507
14511
|
#
|
14512
|
+
# * CASE\_STATUS
|
14508
14513
|
#
|
14509
|
-
#
|
14514
|
+
# * DISCONNECT\_REASON
|
14515
|
+
#
|
14516
|
+
# * FLOWS\_ACTION\_IDENTIFIER
|
14517
|
+
#
|
14518
|
+
# * FLOWS\_NEXT\_ACTION\_IDENTIFIER
|
14519
|
+
#
|
14520
|
+
# * FLOWS\_OUTCOME\_TYPE
|
14521
|
+
#
|
14522
|
+
# * FLOWS\_RESOURCE\_TYPE
|
14523
|
+
#
|
14524
|
+
# * INITIATION\_METHOD
|
14510
14525
|
# @return [String]
|
14511
14526
|
#
|
14512
14527
|
# @!attribute [rw] metric_filter_values
|
14513
|
-
# The values to use for filtering data.
|
14528
|
+
# The values to use for filtering data. Values for metric-level
|
14529
|
+
# filters can be either a fixed set of values or a customized list,
|
14530
|
+
# depending on the use case.
|
14514
14531
|
#
|
14515
|
-
#
|
14516
|
-
# `
|
14517
|
-
#
|
14532
|
+
# For valid values of metric-level filters `INITIATION_METHOD`,
|
14533
|
+
# `DISCONNECT_REASON`, and `ANSWERING_MACHINE_DETECTION_STATUS`, see
|
14534
|
+
# [ContactTraceRecord][1] in the *Amazon Connect Administrator Guide*.
|
14518
14535
|
#
|
14519
|
-
#
|
14520
|
-
#
|
14521
|
-
#
|
14522
|
-
#
|
14536
|
+
# For valid values of the metric-level filter `FLOWS_OUTCOME_TYPE`,
|
14537
|
+
# see the description for the [Flow outcome][2] metric in the *Amazon
|
14538
|
+
# Connect Administrator Guide*.
|
14539
|
+
#
|
14540
|
+
#
|
14541
|
+
#
|
14542
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
14543
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
|
14523
14544
|
# @return [Array<String>]
|
14524
14545
|
#
|
14525
14546
|
# @!attribute [rw] negate
|
14526
|
-
#
|
14527
|
-
#
|
14528
|
-
#
|
14529
|
-
# filter.
|
14547
|
+
# If set to `true`, the API response contains results that filter out
|
14548
|
+
# the results matched by the metric-level filters condition. By
|
14549
|
+
# default, `Negate` is set to `false`.
|
14530
14550
|
# @return [Boolean]
|
14531
14551
|
#
|
14532
14552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricFilterV2 AWS API Documentation
|
@@ -14887,18 +14907,30 @@ module Aws::Connect
|
|
14887
14907
|
include Aws::Structure
|
14888
14908
|
end
|
14889
14909
|
|
14890
|
-
# The configuration for the allowed
|
14891
|
-
# present over the call.
|
14910
|
+
# The configuration for the allowed video and screen sharing
|
14911
|
+
# capabilities for participants present over the call. For more
|
14912
|
+
# information, see [Set up in-app, web, video calling, and screen
|
14913
|
+
# sharing capabilities][1] in the *Amazon Connect Administrator Guide*.
|
14914
|
+
#
|
14915
|
+
#
|
14916
|
+
#
|
14917
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
|
14892
14918
|
#
|
14893
14919
|
# @!attribute [rw] video
|
14894
|
-
# The configuration having the video sharing capabilities
|
14895
|
-
# participants over the call.
|
14920
|
+
# The configuration having the video and screen sharing capabilities
|
14921
|
+
# for participants over the call.
|
14922
|
+
# @return [String]
|
14923
|
+
#
|
14924
|
+
# @!attribute [rw] screen_share
|
14925
|
+
# The screen sharing capability that is enabled for the participant.
|
14926
|
+
# `SEND` indicates the participant can share their screen.
|
14896
14927
|
# @return [String]
|
14897
14928
|
#
|
14898
14929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantCapabilities AWS API Documentation
|
14899
14930
|
#
|
14900
14931
|
class ParticipantCapabilities < Struct.new(
|
14901
|
-
:video
|
14932
|
+
:video,
|
14933
|
+
:screen_share)
|
14902
14934
|
SENSITIVE = []
|
14903
14935
|
include Aws::Structure
|
14904
14936
|
end
|
@@ -19847,6 +19879,47 @@ module Aws::Connect
|
|
19847
19879
|
include Aws::Structure
|
19848
19880
|
end
|
19849
19881
|
|
19882
|
+
# @!attribute [rw] client_token
|
19883
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
19884
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
19885
|
+
# SDK populates this field. For more information about idempotency,
|
19886
|
+
# see [Making retries safe with idempotent APIs][1].
|
19887
|
+
#
|
19888
|
+
# **A suitable default value is auto-generated.** You should normally
|
19889
|
+
# not need to pass this option.
|
19890
|
+
#
|
19891
|
+
#
|
19892
|
+
#
|
19893
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
19894
|
+
# @return [String]
|
19895
|
+
#
|
19896
|
+
# @!attribute [rw] instance_id
|
19897
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
19898
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
19899
|
+
#
|
19900
|
+
#
|
19901
|
+
#
|
19902
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
19903
|
+
# @return [String]
|
19904
|
+
#
|
19905
|
+
# @!attribute [rw] contact_id
|
19906
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
19907
|
+
# @return [String]
|
19908
|
+
#
|
19909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartScreenSharingRequest AWS API Documentation
|
19910
|
+
#
|
19911
|
+
class StartScreenSharingRequest < Struct.new(
|
19912
|
+
:client_token,
|
19913
|
+
:instance_id,
|
19914
|
+
:contact_id)
|
19915
|
+
SENSITIVE = []
|
19916
|
+
include Aws::Structure
|
19917
|
+
end
|
19918
|
+
|
19919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartScreenSharingResponse AWS API Documentation
|
19920
|
+
#
|
19921
|
+
class StartScreenSharingResponse < Aws::EmptyStructure; end
|
19922
|
+
|
19850
19923
|
# @!attribute [rw] instance_id
|
19851
19924
|
# The identifier of the Amazon Connect instance. You can [find the
|
19852
19925
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -23342,6 +23415,11 @@ module Aws::Connect
|
|
23342
23415
|
#
|
23343
23416
|
# </note>
|
23344
23417
|
#
|
23418
|
+
# The `FirstName` and `LastName` length constraints below apply only to
|
23419
|
+
# instances using SAML for identity management. If you are using Amazon
|
23420
|
+
# Connect for identity management, the length constraints are 1-255 for
|
23421
|
+
# `FirstName`, and 1-256 for `LastName`.
|
23422
|
+
#
|
23345
23423
|
# @!attribute [rw] first_name
|
23346
23424
|
# The first name. This is required if you are using Amazon Connect or
|
23347
23425
|
# SAML for identity management.
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -3519,6 +3519,17 @@ module Aws
|
|
3519
3519
|
) -> _StartOutboundVoiceContactResponseSuccess
|
3520
3520
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartOutboundVoiceContactResponseSuccess
|
3521
3521
|
|
3522
|
+
interface _StartScreenSharingResponseSuccess
|
3523
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartScreenSharingResponse]
|
3524
|
+
end
|
3525
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#start_screen_sharing-instance_method
|
3526
|
+
def start_screen_sharing: (
|
3527
|
+
?client_token: ::String,
|
3528
|
+
instance_id: ::String,
|
3529
|
+
contact_id: ::String
|
3530
|
+
) -> _StartScreenSharingResponseSuccess
|
3531
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartScreenSharingResponseSuccess
|
3532
|
+
|
3522
3533
|
interface _StartTaskContactResponseSuccess
|
3523
3534
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartTaskContactResponse]
|
3524
3535
|
def contact_id: () -> ::String
|
@@ -3558,10 +3569,12 @@ module Aws
|
|
3558
3569
|
instance_id: ::String,
|
3559
3570
|
?allowed_capabilities: {
|
3560
3571
|
customer: {
|
3561
|
-
video: ("SEND")
|
3572
|
+
video: ("SEND")?,
|
3573
|
+
screen_share: ("SEND")?
|
3562
3574
|
}?,
|
3563
3575
|
agent: {
|
3564
|
-
video: ("SEND")
|
3576
|
+
video: ("SEND")?,
|
3577
|
+
screen_share: ("SEND")?
|
3565
3578
|
}?
|
3566
3579
|
},
|
3567
3580
|
participant_details: {
|
data/sig/types.rbs
CHANGED
@@ -3419,6 +3419,7 @@ module Aws::Connect
|
|
3419
3419
|
|
3420
3420
|
class ParticipantCapabilities
|
3421
3421
|
attr_accessor video: ("SEND")
|
3422
|
+
attr_accessor screen_share: ("SEND")
|
3422
3423
|
SENSITIVE: []
|
3423
3424
|
end
|
3424
3425
|
|
@@ -4621,6 +4622,16 @@ module Aws::Connect
|
|
4621
4622
|
SENSITIVE: []
|
4622
4623
|
end
|
4623
4624
|
|
4625
|
+
class StartScreenSharingRequest
|
4626
|
+
attr_accessor client_token: ::String
|
4627
|
+
attr_accessor instance_id: ::String
|
4628
|
+
attr_accessor contact_id: ::String
|
4629
|
+
SENSITIVE: []
|
4630
|
+
end
|
4631
|
+
|
4632
|
+
class StartScreenSharingResponse < Aws::EmptyStructure
|
4633
|
+
end
|
4634
|
+
|
4624
4635
|
class StartTaskContactRequest
|
4625
4636
|
attr_accessor instance_id: ::String
|
4626
4637
|
attr_accessor previous_contact_id: ::String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.183.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-10-
|
11
|
+
date: 2024-10-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|