aws-sdk-connect 1.180.0 → 1.182.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 capabilities for participants
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 if the API is being called in the Region where the
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 if the API is being called in the Region where the
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 capabilities for participants
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 if the API is being called in the Region where the
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 if the API is being called in the Region where the
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 Metric Level Filters is not applicable for
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` enter any whole number from 1 to
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 Metric Level Filters is not applicable for
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: `INITIATION_METHOD`, `DISCONNECT_REASON`.
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
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
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
- # Valid metric filter values for `INITIATION_METHOD`: `INBOUND` \|
14516
- # `OUTBOUND` \| `TRANSFER` \| `QUEUE_TRANSFER` \| `CALLBACK` \| `API`
14517
- # \| `WEBRTC_API` \| `MONITOR` \| `DISCONNECT` \| `EXTERNAL_OUTBOUND`
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
- # Valid metric filter values for `DISCONNECT_REASON`:
14520
- # `CUSTOMER_DISCONNECT` \| `AGENT_DISCONNECT` \|
14521
- # `THIRD_PARTY_DISCONNECT` \| `TELECOM_PROBLEM` \| `BARGED` \|
14522
- # `CONTACT_FLOW_DISCONNECT` \| `OTHER` \| `EXPIRED` \| `API`
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
- # The flag to use to filter on requested metric filter values or to
14527
- # not filter on requested metric filter values. By default the negate
14528
- # is `false`, which indicates to filter on the requested metric
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 capabilities for participants
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 for
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.
@@ -54,7 +54,7 @@ module Aws::Connect
54
54
  autoload :EndpointProvider, 'aws-sdk-connect/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-connect/endpoints'
56
56
 
57
- GEM_VERSION = '1.180.0'
57
+ GEM_VERSION = '1.182.0'
58
58
 
59
59
  end
60
60
 
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.180.0
4
+ version: 1.182.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-03 00:00:00.000000000 Z
11
+ date: 2024-10-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.207.0
22
+ version: 3.210.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.207.0
32
+ version: 3.210.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement