aws-sdk-connect 1.89.0 → 1.90.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +75 -13
- data/lib/aws-sdk-connect/client_api.rb +28 -0
- data/lib/aws-sdk-connect/types.rb +127 -19
- data/lib/aws-sdk-connect.rb +1 -1
- 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: 273f7125d5300b56cbcc3af047953876527746e995d90b8ea6d97a4e543f7b03
|
4
|
+
data.tar.gz: ee23cd87340f1719c344ec6a835a63441e1d0e8af6a4c452bba4d4ca203a18ba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e66de2f9b74494ba87202f35dacd801631ebe6ed1790688e77f4a6593a5dff7f3cf361d4d7fd897c5535540f02537cfcb7f8fbceae84c0a52f5d832fdd6d8d26
|
7
|
+
data.tar.gz: 273dfb807d0eb90c6d39f3158fa7b9fefbde5aadbf179587c5d1882fdf7ffac158afa01448c3ca1fae16fba506a4141b975c5ddf74fb5f8032c42af43b38e46e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.90.0 (2022-12-23)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Support for Routing Profile filter, SortCriteria, and grouping by Routing Profiles for GetCurrentMetricData API. Support for RoutingProfiles, UserHierarchyGroups, and Agents as filters, NextStatus and AgentStatusName for GetCurrentUserData. Adds ApproximateTotalCount to both APIs.
|
8
|
+
|
4
9
|
1.89.0 (2022-12-22)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.90.0
|
@@ -3847,11 +3847,22 @@ module Aws::Connect
|
|
3847
3847
|
# instanceId in the ARN of the instance.
|
3848
3848
|
#
|
3849
3849
|
# @option params [required, Types::Filters] :filters
|
3850
|
-
# The
|
3851
|
-
#
|
3852
|
-
#
|
3853
|
-
#
|
3854
|
-
#
|
3850
|
+
# The filters to apply to returned metrics. You can filter up to the
|
3851
|
+
# following limits:
|
3852
|
+
#
|
3853
|
+
# * Queues: 100
|
3854
|
+
#
|
3855
|
+
# * Routing profiles: 100
|
3856
|
+
#
|
3857
|
+
# * Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
|
3858
|
+
#
|
3859
|
+
# Metric data is retrieved only for the resources associated with the
|
3860
|
+
# queues or routing profiles, and by any channels included in the
|
3861
|
+
# filter. (You cannot filter by both queue AND routing profile.) You can
|
3862
|
+
# include both resource IDs and resource ARNs in the same request.
|
3863
|
+
#
|
3864
|
+
# Currently tagging is only supported on the resources that are passed
|
3865
|
+
# in the filter.
|
3855
3866
|
#
|
3856
3867
|
# @option params [Array<String>] :groupings
|
3857
3868
|
# The grouping applied to the metrics returned. For example, when
|
@@ -3862,7 +3873,9 @@ module Aws::Connect
|
|
3862
3873
|
# VOICE, CHAT, and TASK channels are supported.
|
3863
3874
|
#
|
3864
3875
|
# * If you group by `ROUTING_PROFILE`, you must include either a queue
|
3865
|
-
# or routing profile filter.
|
3876
|
+
# or routing profile filter. In addition, a routing profile filter is
|
3877
|
+
# required for metrics `CONTACTS_SCHEDULED`, `CONTACTS_IN_QUEUE`, and
|
3878
|
+
# ` OLDEST_CONTACT_AGE`.
|
3866
3879
|
#
|
3867
3880
|
# * If no `Grouping` is included in the request, a summary of metrics is
|
3868
3881
|
# returned.
|
@@ -3991,11 +4004,24 @@ module Aws::Connect
|
|
3991
4004
|
# @option params [Integer] :max_results
|
3992
4005
|
# The maximum number of results to return per page.
|
3993
4006
|
#
|
4007
|
+
# @option params [Array<Types::CurrentMetricSortCriteria>] :sort_criteria
|
4008
|
+
# The way to sort the resulting response based on metrics. You can enter
|
4009
|
+
# one sort criteria. By default resources are sorted based on
|
4010
|
+
# `AGENTS_ONLINE`, `DESCENDING`. The metric collection is sorted based
|
4011
|
+
# on the input metrics.
|
4012
|
+
#
|
4013
|
+
# Note the following:
|
4014
|
+
#
|
4015
|
+
# * Sorting on `SLOTS_ACTIVE` and `SLOTS_AVAILABLE` is not supported.
|
4016
|
+
#
|
4017
|
+
# ^
|
4018
|
+
#
|
3994
4019
|
# @return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3995
4020
|
#
|
3996
4021
|
# * {Types::GetCurrentMetricDataResponse#next_token #next_token} => String
|
3997
4022
|
# * {Types::GetCurrentMetricDataResponse#metric_results #metric_results} => Array<Types::CurrentMetricResult>
|
3998
4023
|
# * {Types::GetCurrentMetricDataResponse#data_snapshot_time #data_snapshot_time} => Time
|
4024
|
+
# * {Types::GetCurrentMetricDataResponse#approximate_total_count #approximate_total_count} => Integer
|
3999
4025
|
#
|
4000
4026
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4001
4027
|
#
|
@@ -4006,8 +4032,9 @@ module Aws::Connect
|
|
4006
4032
|
# filters: { # required
|
4007
4033
|
# queues: ["QueueId"],
|
4008
4034
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
4035
|
+
# routing_profiles: ["RoutingProfileId"],
|
4009
4036
|
# },
|
4010
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
4037
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE
|
4011
4038
|
# current_metrics: [ # required
|
4012
4039
|
# {
|
4013
4040
|
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
@@ -4016,6 +4043,12 @@ module Aws::Connect
|
|
4016
4043
|
# ],
|
4017
4044
|
# next_token: "NextToken",
|
4018
4045
|
# max_results: 1,
|
4046
|
+
# sort_criteria: [
|
4047
|
+
# {
|
4048
|
+
# sort_by_metric: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
4049
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4050
|
+
# },
|
4051
|
+
# ],
|
4019
4052
|
# })
|
4020
4053
|
#
|
4021
4054
|
# @example Response structure
|
@@ -4025,11 +4058,14 @@ module Aws::Connect
|
|
4025
4058
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
4026
4059
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
4027
4060
|
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
4061
|
+
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
4062
|
+
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
4028
4063
|
# resp.metric_results[0].collections #=> Array
|
4029
4064
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
4030
4065
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
4031
4066
|
# resp.metric_results[0].collections[0].value #=> Float
|
4032
4067
|
# resp.data_snapshot_time #=> Time
|
4068
|
+
# resp.approximate_total_count #=> Integer
|
4033
4069
|
#
|
4034
4070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData AWS API Documentation
|
4035
4071
|
#
|
@@ -4048,9 +4084,25 @@ module Aws::Connect
|
|
4048
4084
|
# instanceId in the ARN of the instance.
|
4049
4085
|
#
|
4050
4086
|
# @option params [required, Types::UserDataFilters] :filters
|
4051
|
-
#
|
4052
|
-
#
|
4053
|
-
#
|
4087
|
+
# The filters to apply to returned user data. You can filter up to the
|
4088
|
+
# following limits:
|
4089
|
+
#
|
4090
|
+
# * Queues: 100
|
4091
|
+
#
|
4092
|
+
# * Routing profiles: 100
|
4093
|
+
#
|
4094
|
+
# * Agents: 100
|
4095
|
+
#
|
4096
|
+
# * Contact states: 9
|
4097
|
+
#
|
4098
|
+
# * User hierarchy groups: 1
|
4099
|
+
#
|
4100
|
+
# The user data is retrieved for only the specified values/resources in
|
4101
|
+
# the filter. A maximum of one filter can be passed from queues, routing
|
4102
|
+
# profiles, agents, and user hierarchy groups.
|
4103
|
+
#
|
4104
|
+
# Currently tagging is only supported on the resources that are passed
|
4105
|
+
# in the filter.
|
4054
4106
|
#
|
4055
4107
|
# @option params [String] :next_token
|
4056
4108
|
# The token for the next set of results. Use the value returned in the
|
@@ -4064,6 +4116,7 @@ module Aws::Connect
|
|
4064
4116
|
#
|
4065
4117
|
# * {Types::GetCurrentUserDataResponse#next_token #next_token} => String
|
4066
4118
|
# * {Types::GetCurrentUserDataResponse#user_data_list #user_data_list} => Array<Types::UserData>
|
4119
|
+
# * {Types::GetCurrentUserDataResponse#approximate_total_count #approximate_total_count} => Integer
|
4067
4120
|
#
|
4068
4121
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4069
4122
|
#
|
@@ -4076,6 +4129,9 @@ module Aws::Connect
|
|
4076
4129
|
# contact_filter: {
|
4077
4130
|
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
4078
4131
|
# },
|
4132
|
+
# routing_profiles: ["RoutingProfileId"],
|
4133
|
+
# agents: ["UserId"],
|
4134
|
+
# user_hierarchy_groups: ["HierarchyGroupId"],
|
4079
4135
|
# },
|
4080
4136
|
# next_token: "NextToken",
|
4081
4137
|
# max_results: 1,
|
@@ -4101,6 +4157,7 @@ module Aws::Connect
|
|
4101
4157
|
# resp.user_data_list[0].hierarchy_path.level_five.arn #=> String
|
4102
4158
|
# resp.user_data_list[0].status.status_start_timestamp #=> Time
|
4103
4159
|
# resp.user_data_list[0].status.status_arn #=> String
|
4160
|
+
# resp.user_data_list[0].status.status_name #=> String
|
4104
4161
|
# resp.user_data_list[0].available_slots_by_channel #=> Hash
|
4105
4162
|
# resp.user_data_list[0].available_slots_by_channel["Channel"] #=> Integer
|
4106
4163
|
# resp.user_data_list[0].max_slots_by_channel #=> Hash
|
@@ -4116,6 +4173,8 @@ module Aws::Connect
|
|
4116
4173
|
# resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
|
4117
4174
|
# resp.user_data_list[0].contacts[0].queue.id #=> String
|
4118
4175
|
# resp.user_data_list[0].contacts[0].queue.arn #=> String
|
4176
|
+
# resp.user_data_list[0].next_status #=> String
|
4177
|
+
# resp.approximate_total_count #=> Integer
|
4119
4178
|
#
|
4120
4179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserData AWS API Documentation
|
4121
4180
|
#
|
@@ -4421,8 +4480,9 @@ module Aws::Connect
|
|
4421
4480
|
# filters: { # required
|
4422
4481
|
# queues: ["QueueId"],
|
4423
4482
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
4483
|
+
# routing_profiles: ["RoutingProfileId"],
|
4424
4484
|
# },
|
4425
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
4485
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE
|
4426
4486
|
# historical_metrics: [ # required
|
4427
4487
|
# {
|
4428
4488
|
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
@@ -4445,6 +4505,8 @@ module Aws::Connect
|
|
4445
4505
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
4446
4506
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
4447
4507
|
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
4508
|
+
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
4509
|
+
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
4448
4510
|
# resp.metric_results[0].collections #=> Array
|
4449
4511
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
4450
4512
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -6356,7 +6418,7 @@ module Aws::Connect
|
|
6356
6418
|
|
6357
6419
|
# Initiates silent monitoring of a contact. The Contact Control Panel
|
6358
6420
|
# (CCP) of the user specified by *userId* will be set to silent
|
6359
|
-
# monitoring mode on the contact.
|
6421
|
+
# monitoring mode on the contact.
|
6360
6422
|
#
|
6361
6423
|
# @option params [required, String] :instance_id
|
6362
6424
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -9678,7 +9740,7 @@ module Aws::Connect
|
|
9678
9740
|
params: params,
|
9679
9741
|
config: config)
|
9680
9742
|
context[:gem_name] = 'aws-sdk-connect'
|
9681
|
-
context[:gem_version] = '1.
|
9743
|
+
context[:gem_version] = '1.90.0'
|
9682
9744
|
Seahorse::Client::Request.new(handlers, context)
|
9683
9745
|
end
|
9684
9746
|
|
@@ -37,6 +37,7 @@ module Aws::Connect
|
|
37
37
|
AgentStatusType = Shapes::StringShape.new(name: 'AgentStatusType')
|
38
38
|
AgentStatusTypes = Shapes::ListShape.new(name: 'AgentStatusTypes')
|
39
39
|
AgentUsername = Shapes::StringShape.new(name: 'AgentUsername')
|
40
|
+
AgentsMinOneMaxHundred = Shapes::ListShape.new(name: 'AgentsMinOneMaxHundred')
|
40
41
|
AliasArn = Shapes::StringShape.new(name: 'AliasArn')
|
41
42
|
AllowedAccessControlTags = Shapes::MapShape.new(name: 'AllowedAccessControlTags')
|
42
43
|
AllowedMonitorCapabilities = Shapes::ListShape.new(name: 'AllowedMonitorCapabilities')
|
@@ -160,6 +161,8 @@ module Aws::Connect
|
|
160
161
|
CurrentMetricName = Shapes::StringShape.new(name: 'CurrentMetricName')
|
161
162
|
CurrentMetricResult = Shapes::StructureShape.new(name: 'CurrentMetricResult')
|
162
163
|
CurrentMetricResults = Shapes::ListShape.new(name: 'CurrentMetricResults')
|
164
|
+
CurrentMetricSortCriteria = Shapes::StructureShape.new(name: 'CurrentMetricSortCriteria')
|
165
|
+
CurrentMetricSortCriteriaMaxOne = Shapes::ListShape.new(name: 'CurrentMetricSortCriteriaMaxOne')
|
163
166
|
CurrentMetrics = Shapes::ListShape.new(name: 'CurrentMetrics')
|
164
167
|
DateReference = Shapes::StructureShape.new(name: 'DateReference')
|
165
168
|
DefaultVocabulary = Shapes::StructureShape.new(name: 'DefaultVocabulary')
|
@@ -550,6 +553,7 @@ module Aws::Connect
|
|
550
553
|
RoutingProfileSearchFilter = Shapes::StructureShape.new(name: 'RoutingProfileSearchFilter')
|
551
554
|
RoutingProfileSummary = Shapes::StructureShape.new(name: 'RoutingProfileSummary')
|
552
555
|
RoutingProfileSummaryList = Shapes::ListShape.new(name: 'RoutingProfileSummaryList')
|
556
|
+
RoutingProfiles = Shapes::ListShape.new(name: 'RoutingProfiles')
|
553
557
|
Rule = Shapes::StructureShape.new(name: 'Rule')
|
554
558
|
RuleAction = Shapes::StructureShape.new(name: 'RuleAction')
|
555
559
|
RuleActions = Shapes::ListShape.new(name: 'RuleActions')
|
@@ -596,6 +600,7 @@ module Aws::Connect
|
|
596
600
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
597
601
|
SingleSelectOptions = Shapes::ListShape.new(name: 'SingleSelectOptions')
|
598
602
|
SnapshotVersion = Shapes::StringShape.new(name: 'SnapshotVersion')
|
603
|
+
SortOrder = Shapes::StringShape.new(name: 'SortOrder')
|
599
604
|
SourceApplicationName = Shapes::StringShape.new(name: 'SourceApplicationName')
|
600
605
|
SourceType = Shapes::StringShape.new(name: 'SourceType')
|
601
606
|
StartChatContactRequest = Shapes::StructureShape.new(name: 'StartChatContactRequest')
|
@@ -736,6 +741,7 @@ module Aws::Connect
|
|
736
741
|
User = Shapes::StructureShape.new(name: 'User')
|
737
742
|
UserData = Shapes::StructureShape.new(name: 'UserData')
|
738
743
|
UserDataFilters = Shapes::StructureShape.new(name: 'UserDataFilters')
|
744
|
+
UserDataHierarchyGroups = Shapes::ListShape.new(name: 'UserDataHierarchyGroups')
|
739
745
|
UserDataList = Shapes::ListShape.new(name: 'UserDataList')
|
740
746
|
UserId = Shapes::StringShape.new(name: 'UserId')
|
741
747
|
UserIdList = Shapes::ListShape.new(name: 'UserIdList')
|
@@ -804,6 +810,7 @@ module Aws::Connect
|
|
804
810
|
|
805
811
|
AgentStatusReference.add_member(:status_start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StatusStartTimestamp"))
|
806
812
|
AgentStatusReference.add_member(:status_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "StatusArn"))
|
813
|
+
AgentStatusReference.add_member(:status_name, Shapes::ShapeRef.new(shape: AgentStatusName, location_name: "StatusName"))
|
807
814
|
AgentStatusReference.struct_class = Types::AgentStatusReference
|
808
815
|
|
809
816
|
AgentStatusSummary.add_member(:id, Shapes::ShapeRef.new(shape: AgentStatusId, location_name: "Id"))
|
@@ -816,6 +823,8 @@ module Aws::Connect
|
|
816
823
|
|
817
824
|
AgentStatusTypes.member = Shapes::ShapeRef.new(shape: AgentStatusType)
|
818
825
|
|
826
|
+
AgentsMinOneMaxHundred.member = Shapes::ShapeRef.new(shape: UserId)
|
827
|
+
|
819
828
|
AllowedAccessControlTags.key = Shapes::ShapeRef.new(shape: SecurityProfilePolicyKey)
|
820
829
|
AllowedAccessControlTags.value = Shapes::ShapeRef.new(shape: SecurityProfilePolicyValue)
|
821
830
|
|
@@ -1247,6 +1256,12 @@ module Aws::Connect
|
|
1247
1256
|
|
1248
1257
|
CurrentMetricResults.member = Shapes::ShapeRef.new(shape: CurrentMetricResult)
|
1249
1258
|
|
1259
|
+
CurrentMetricSortCriteria.add_member(:sort_by_metric, Shapes::ShapeRef.new(shape: CurrentMetricName, location_name: "SortByMetric"))
|
1260
|
+
CurrentMetricSortCriteria.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, location_name: "SortOrder"))
|
1261
|
+
CurrentMetricSortCriteria.struct_class = Types::CurrentMetricSortCriteria
|
1262
|
+
|
1263
|
+
CurrentMetricSortCriteriaMaxOne.member = Shapes::ShapeRef.new(shape: CurrentMetricSortCriteria)
|
1264
|
+
|
1250
1265
|
CurrentMetrics.member = Shapes::ShapeRef.new(shape: CurrentMetric)
|
1251
1266
|
|
1252
1267
|
DateReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name"))
|
@@ -1462,6 +1477,7 @@ module Aws::Connect
|
|
1462
1477
|
|
1463
1478
|
Dimensions.add_member(:queue, Shapes::ShapeRef.new(shape: QueueReference, location_name: "Queue"))
|
1464
1479
|
Dimensions.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "Channel"))
|
1480
|
+
Dimensions.add_member(:routing_profile, Shapes::ShapeRef.new(shape: RoutingProfileReference, location_name: "RoutingProfile"))
|
1465
1481
|
Dimensions.struct_class = Types::Dimensions
|
1466
1482
|
|
1467
1483
|
DisassociateApprovedOriginRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
@@ -1534,6 +1550,7 @@ module Aws::Connect
|
|
1534
1550
|
|
1535
1551
|
Filters.add_member(:queues, Shapes::ShapeRef.new(shape: Queues, location_name: "Queues"))
|
1536
1552
|
Filters.add_member(:channels, Shapes::ShapeRef.new(shape: Channels, location_name: "Channels"))
|
1553
|
+
Filters.add_member(:routing_profiles, Shapes::ShapeRef.new(shape: RoutingProfiles, location_name: "RoutingProfiles"))
|
1537
1554
|
Filters.struct_class = Types::Filters
|
1538
1555
|
|
1539
1556
|
FunctionArnsList.member = Shapes::ShapeRef.new(shape: FunctionArn)
|
@@ -1551,11 +1568,13 @@ module Aws::Connect
|
|
1551
1568
|
GetCurrentMetricDataRequest.add_member(:current_metrics, Shapes::ShapeRef.new(shape: CurrentMetrics, required: true, location_name: "CurrentMetrics"))
|
1552
1569
|
GetCurrentMetricDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
1553
1570
|
GetCurrentMetricDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
|
1571
|
+
GetCurrentMetricDataRequest.add_member(:sort_criteria, Shapes::ShapeRef.new(shape: CurrentMetricSortCriteriaMaxOne, location_name: "SortCriteria"))
|
1554
1572
|
GetCurrentMetricDataRequest.struct_class = Types::GetCurrentMetricDataRequest
|
1555
1573
|
|
1556
1574
|
GetCurrentMetricDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
1557
1575
|
GetCurrentMetricDataResponse.add_member(:metric_results, Shapes::ShapeRef.new(shape: CurrentMetricResults, location_name: "MetricResults"))
|
1558
1576
|
GetCurrentMetricDataResponse.add_member(:data_snapshot_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "DataSnapshotTime"))
|
1577
|
+
GetCurrentMetricDataResponse.add_member(:approximate_total_count, Shapes::ShapeRef.new(shape: ApproximateTotalCount, location_name: "ApproximateTotalCount"))
|
1559
1578
|
GetCurrentMetricDataResponse.struct_class = Types::GetCurrentMetricDataResponse
|
1560
1579
|
|
1561
1580
|
GetCurrentUserDataRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
@@ -1566,6 +1585,7 @@ module Aws::Connect
|
|
1566
1585
|
|
1567
1586
|
GetCurrentUserDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
1568
1587
|
GetCurrentUserDataResponse.add_member(:user_data_list, Shapes::ShapeRef.new(shape: UserDataList, location_name: "UserDataList"))
|
1588
|
+
GetCurrentUserDataResponse.add_member(:approximate_total_count, Shapes::ShapeRef.new(shape: ApproximateTotalCount, location_name: "ApproximateTotalCount"))
|
1569
1589
|
GetCurrentUserDataResponse.struct_class = Types::GetCurrentUserDataResponse
|
1570
1590
|
|
1571
1591
|
GetFederationTokenRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
@@ -2452,6 +2472,8 @@ module Aws::Connect
|
|
2452
2472
|
|
2453
2473
|
RoutingProfileSummaryList.member = Shapes::ShapeRef.new(shape: RoutingProfileSummary)
|
2454
2474
|
|
2475
|
+
RoutingProfiles.member = Shapes::ShapeRef.new(shape: RoutingProfileId)
|
2476
|
+
|
2455
2477
|
Rule.add_member(:name, Shapes::ShapeRef.new(shape: RuleName, required: true, location_name: "Name"))
|
2456
2478
|
Rule.add_member(:rule_id, Shapes::ShapeRef.new(shape: RuleId, required: true, location_name: "RuleId"))
|
2457
2479
|
Rule.add_member(:rule_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "RuleArn"))
|
@@ -3108,12 +3130,18 @@ module Aws::Connect
|
|
3108
3130
|
UserData.add_member(:max_slots_by_channel, Shapes::ShapeRef.new(shape: ChannelToCountMap, location_name: "MaxSlotsByChannel"))
|
3109
3131
|
UserData.add_member(:active_slots_by_channel, Shapes::ShapeRef.new(shape: ChannelToCountMap, location_name: "ActiveSlotsByChannel"))
|
3110
3132
|
UserData.add_member(:contacts, Shapes::ShapeRef.new(shape: AgentContactReferenceList, location_name: "Contacts"))
|
3133
|
+
UserData.add_member(:next_status, Shapes::ShapeRef.new(shape: AgentStatusName, location_name: "NextStatus"))
|
3111
3134
|
UserData.struct_class = Types::UserData
|
3112
3135
|
|
3113
3136
|
UserDataFilters.add_member(:queues, Shapes::ShapeRef.new(shape: Queues, location_name: "Queues"))
|
3114
3137
|
UserDataFilters.add_member(:contact_filter, Shapes::ShapeRef.new(shape: ContactFilter, location_name: "ContactFilter"))
|
3138
|
+
UserDataFilters.add_member(:routing_profiles, Shapes::ShapeRef.new(shape: RoutingProfiles, location_name: "RoutingProfiles"))
|
3139
|
+
UserDataFilters.add_member(:agents, Shapes::ShapeRef.new(shape: AgentsMinOneMaxHundred, location_name: "Agents"))
|
3140
|
+
UserDataFilters.add_member(:user_hierarchy_groups, Shapes::ShapeRef.new(shape: UserDataHierarchyGroups, location_name: "UserHierarchyGroups"))
|
3115
3141
|
UserDataFilters.struct_class = Types::UserDataFilters
|
3116
3142
|
|
3143
|
+
UserDataHierarchyGroups.member = Shapes::ShapeRef.new(shape: HierarchyGroupId)
|
3144
|
+
|
3117
3145
|
UserDataList.member = Shapes::ShapeRef.new(shape: UserData)
|
3118
3146
|
|
3119
3147
|
UserIdList.member = Shapes::ShapeRef.new(shape: UserId)
|
@@ -170,11 +170,16 @@ module Aws::Connect
|
|
170
170
|
# The Amazon Resource Name (ARN) of the agent's status.
|
171
171
|
# @return [String]
|
172
172
|
#
|
173
|
+
# @!attribute [rw] status_name
|
174
|
+
# The name of the agent status.
|
175
|
+
# @return [String]
|
176
|
+
#
|
173
177
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusReference AWS API Documentation
|
174
178
|
#
|
175
179
|
class AgentStatusReference < Struct.new(
|
176
180
|
:status_start_timestamp,
|
177
|
-
:status_arn
|
181
|
+
:status_arn,
|
182
|
+
:status_name)
|
178
183
|
SENSITIVE = []
|
179
184
|
include Aws::Structure
|
180
185
|
end
|
@@ -2344,6 +2349,27 @@ module Aws::Connect
|
|
2344
2349
|
include Aws::Structure
|
2345
2350
|
end
|
2346
2351
|
|
2352
|
+
# The way to sort the resulting response based on metrics. By default
|
2353
|
+
# resources are sorted based on `AGENTS_ONLINE`, `DESCENDING`. The
|
2354
|
+
# metric collection is sorted based on the input metrics.
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] sort_by_metric
|
2357
|
+
# The current metric names.
|
2358
|
+
# @return [String]
|
2359
|
+
#
|
2360
|
+
# @!attribute [rw] sort_order
|
2361
|
+
# The way to sort.
|
2362
|
+
# @return [String]
|
2363
|
+
#
|
2364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetricSortCriteria AWS API Documentation
|
2365
|
+
#
|
2366
|
+
class CurrentMetricSortCriteria < Struct.new(
|
2367
|
+
:sort_by_metric,
|
2368
|
+
:sort_order)
|
2369
|
+
SENSITIVE = []
|
2370
|
+
include Aws::Structure
|
2371
|
+
end
|
2372
|
+
|
2347
2373
|
# Information about a reference when the `referenceType` is `DATE`.
|
2348
2374
|
# Otherwise, null.
|
2349
2375
|
#
|
@@ -3267,11 +3293,16 @@ module Aws::Connect
|
|
3267
3293
|
# The channel used for grouping and filters.
|
3268
3294
|
# @return [String]
|
3269
3295
|
#
|
3296
|
+
# @!attribute [rw] routing_profile
|
3297
|
+
# Information about the routing profile assigned to the user.
|
3298
|
+
# @return [Types::RoutingProfileReference]
|
3299
|
+
#
|
3270
3300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
|
3271
3301
|
#
|
3272
3302
|
class Dimensions < Struct.new(
|
3273
3303
|
:queue,
|
3274
|
-
:channel
|
3304
|
+
:channel,
|
3305
|
+
:routing_profile)
|
3275
3306
|
SENSITIVE = []
|
3276
3307
|
include Aws::Structure
|
3277
3308
|
end
|
@@ -3598,11 +3629,16 @@ module Aws::Connect
|
|
3598
3629
|
# The channel to use to filter the metrics.
|
3599
3630
|
# @return [Array<String>]
|
3600
3631
|
#
|
3632
|
+
# @!attribute [rw] routing_profiles
|
3633
|
+
# A list of up to 100 routing profile IDs or ARNs.
|
3634
|
+
# @return [Array<String>]
|
3635
|
+
#
|
3601
3636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
|
3602
3637
|
#
|
3603
3638
|
class Filters < Struct.new(
|
3604
3639
|
:queues,
|
3605
|
-
:channels
|
3640
|
+
:channels,
|
3641
|
+
:routing_profiles)
|
3606
3642
|
SENSITIVE = []
|
3607
3643
|
include Aws::Structure
|
3608
3644
|
end
|
@@ -3642,11 +3678,22 @@ module Aws::Connect
|
|
3642
3678
|
# @return [String]
|
3643
3679
|
#
|
3644
3680
|
# @!attribute [rw] filters
|
3645
|
-
# The
|
3646
|
-
#
|
3647
|
-
#
|
3648
|
-
#
|
3649
|
-
#
|
3681
|
+
# The filters to apply to returned metrics. You can filter up to the
|
3682
|
+
# following limits:
|
3683
|
+
#
|
3684
|
+
# * Queues: 100
|
3685
|
+
#
|
3686
|
+
# * Routing profiles: 100
|
3687
|
+
#
|
3688
|
+
# * Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
|
3689
|
+
#
|
3690
|
+
# Metric data is retrieved only for the resources associated with the
|
3691
|
+
# queues or routing profiles, and by any channels included in the
|
3692
|
+
# filter. (You cannot filter by both queue AND routing profile.) You
|
3693
|
+
# can include both resource IDs and resource ARNs in the same request.
|
3694
|
+
#
|
3695
|
+
# Currently tagging is only supported on the resources that are passed
|
3696
|
+
# in the filter.
|
3650
3697
|
# @return [Types::Filters]
|
3651
3698
|
#
|
3652
3699
|
# @!attribute [rw] groupings
|
@@ -3658,7 +3705,9 @@ module Aws::Connect
|
|
3658
3705
|
# VOICE, CHAT, and TASK channels are supported.
|
3659
3706
|
#
|
3660
3707
|
# * If you group by `ROUTING_PROFILE`, you must include either a queue
|
3661
|
-
# or routing profile filter.
|
3708
|
+
# or routing profile filter. In addition, a routing profile filter
|
3709
|
+
# is required for metrics `CONTACTS_SCHEDULED`, `CONTACTS_IN_QUEUE`,
|
3710
|
+
# and ` OLDEST_CONTACT_AGE`.
|
3662
3711
|
#
|
3663
3712
|
# * If no `Grouping` is included in the request, a summary of metrics
|
3664
3713
|
# is returned.
|
@@ -3791,6 +3840,19 @@ module Aws::Connect
|
|
3791
3840
|
# The maximum number of results to return per page.
|
3792
3841
|
# @return [Integer]
|
3793
3842
|
#
|
3843
|
+
# @!attribute [rw] sort_criteria
|
3844
|
+
# The way to sort the resulting response based on metrics. You can
|
3845
|
+
# enter one sort criteria. By default resources are sorted based on
|
3846
|
+
# `AGENTS_ONLINE`, `DESCENDING`. The metric collection is sorted based
|
3847
|
+
# on the input metrics.
|
3848
|
+
#
|
3849
|
+
# Note the following:
|
3850
|
+
#
|
3851
|
+
# * Sorting on `SLOTS_ACTIVE` and `SLOTS_AVAILABLE` is not supported.
|
3852
|
+
#
|
3853
|
+
# ^
|
3854
|
+
# @return [Array<Types::CurrentMetricSortCriteria>]
|
3855
|
+
#
|
3794
3856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
|
3795
3857
|
#
|
3796
3858
|
class GetCurrentMetricDataRequest < Struct.new(
|
@@ -3799,7 +3861,8 @@ module Aws::Connect
|
|
3799
3861
|
:groupings,
|
3800
3862
|
:current_metrics,
|
3801
3863
|
:next_token,
|
3802
|
-
:max_results
|
3864
|
+
:max_results,
|
3865
|
+
:sort_criteria)
|
3803
3866
|
SENSITIVE = []
|
3804
3867
|
include Aws::Structure
|
3805
3868
|
end
|
@@ -3822,12 +3885,17 @@ module Aws::Connect
|
|
3822
3885
|
# pagination.
|
3823
3886
|
# @return [Time]
|
3824
3887
|
#
|
3888
|
+
# @!attribute [rw] approximate_total_count
|
3889
|
+
# The total count of the result, regardless of the current page size.
|
3890
|
+
# @return [Integer]
|
3891
|
+
#
|
3825
3892
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataResponse AWS API Documentation
|
3826
3893
|
#
|
3827
3894
|
class GetCurrentMetricDataResponse < Struct.new(
|
3828
3895
|
:next_token,
|
3829
3896
|
:metric_results,
|
3830
|
-
:data_snapshot_time
|
3897
|
+
:data_snapshot_time,
|
3898
|
+
:approximate_total_count)
|
3831
3899
|
SENSITIVE = []
|
3832
3900
|
include Aws::Structure
|
3833
3901
|
end
|
@@ -3838,9 +3906,25 @@ module Aws::Connect
|
|
3838
3906
|
# @return [String]
|
3839
3907
|
#
|
3840
3908
|
# @!attribute [rw] filters
|
3841
|
-
#
|
3842
|
-
#
|
3843
|
-
#
|
3909
|
+
# The filters to apply to returned user data. You can filter up to the
|
3910
|
+
# following limits:
|
3911
|
+
#
|
3912
|
+
# * Queues: 100
|
3913
|
+
#
|
3914
|
+
# * Routing profiles: 100
|
3915
|
+
#
|
3916
|
+
# * Agents: 100
|
3917
|
+
#
|
3918
|
+
# * Contact states: 9
|
3919
|
+
#
|
3920
|
+
# * User hierarchy groups: 1
|
3921
|
+
#
|
3922
|
+
# The user data is retrieved for only the specified values/resources
|
3923
|
+
# in the filter. A maximum of one filter can be passed from queues,
|
3924
|
+
# routing profiles, agents, and user hierarchy groups.
|
3925
|
+
#
|
3926
|
+
# Currently tagging is only supported on the resources that are passed
|
3927
|
+
# in the filter.
|
3844
3928
|
# @return [Types::UserDataFilters]
|
3845
3929
|
#
|
3846
3930
|
# @!attribute [rw] next_token
|
@@ -3873,11 +3957,16 @@ module Aws::Connect
|
|
3873
3957
|
# A list of the user data that is returned.
|
3874
3958
|
# @return [Array<Types::UserData>]
|
3875
3959
|
#
|
3960
|
+
# @!attribute [rw] approximate_total_count
|
3961
|
+
# The total count of the result, regardless of the current page size.
|
3962
|
+
# @return [Integer]
|
3963
|
+
#
|
3876
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataResponse AWS API Documentation
|
3877
3965
|
#
|
3878
3966
|
class GetCurrentUserDataResponse < Struct.new(
|
3879
3967
|
:next_token,
|
3880
|
-
:user_data_list
|
3968
|
+
:user_data_list,
|
3969
|
+
:approximate_total_count)
|
3881
3970
|
SENSITIVE = []
|
3882
3971
|
include Aws::Structure
|
3883
3972
|
end
|
@@ -11351,6 +11440,10 @@ module Aws::Connect
|
|
11351
11440
|
# A list of contact reference information.
|
11352
11441
|
# @return [Array<Types::AgentContactReference>]
|
11353
11442
|
#
|
11443
|
+
# @!attribute [rw] next_status
|
11444
|
+
# The Next status of the agent.
|
11445
|
+
# @return [String]
|
11446
|
+
#
|
11354
11447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserData AWS API Documentation
|
11355
11448
|
#
|
11356
11449
|
class UserData < Struct.new(
|
@@ -11361,7 +11454,8 @@ module Aws::Connect
|
|
11361
11454
|
:available_slots_by_channel,
|
11362
11455
|
:max_slots_by_channel,
|
11363
11456
|
:active_slots_by_channel,
|
11364
|
-
:contacts
|
11457
|
+
:contacts,
|
11458
|
+
:next_status)
|
11365
11459
|
SENSITIVE = []
|
11366
11460
|
include Aws::Structure
|
11367
11461
|
end
|
@@ -11369,8 +11463,7 @@ module Aws::Connect
|
|
11369
11463
|
# A filter for the user data.
|
11370
11464
|
#
|
11371
11465
|
# @!attribute [rw] queues
|
11372
|
-
#
|
11373
|
-
# returned.
|
11466
|
+
# A list of up to 100 queues or ARNs.
|
11374
11467
|
# @return [Array<String>]
|
11375
11468
|
#
|
11376
11469
|
# @!attribute [rw] contact_filter
|
@@ -11378,11 +11471,26 @@ module Aws::Connect
|
|
11378
11471
|
# associated to the user. It contains a list of contact states.
|
11379
11472
|
# @return [Types::ContactFilter]
|
11380
11473
|
#
|
11474
|
+
# @!attribute [rw] routing_profiles
|
11475
|
+
# A list of up to 100 routing profile IDs or ARNs.
|
11476
|
+
# @return [Array<String>]
|
11477
|
+
#
|
11478
|
+
# @!attribute [rw] agents
|
11479
|
+
# A list of up to 100 agent IDs or ARNs.
|
11480
|
+
# @return [Array<String>]
|
11481
|
+
#
|
11482
|
+
# @!attribute [rw] user_hierarchy_groups
|
11483
|
+
# A UserHierarchyGroup ID or ARN.
|
11484
|
+
# @return [Array<String>]
|
11485
|
+
#
|
11381
11486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserDataFilters AWS API Documentation
|
11382
11487
|
#
|
11383
11488
|
class UserDataFilters < Struct.new(
|
11384
11489
|
:queues,
|
11385
|
-
:contact_filter
|
11490
|
+
:contact_filter,
|
11491
|
+
:routing_profiles,
|
11492
|
+
:agents,
|
11493
|
+
:user_hierarchy_groups)
|
11386
11494
|
SENSITIVE = []
|
11387
11495
|
include Aws::Structure
|
11388
11496
|
end
|
data/lib/aws-sdk-connect.rb
CHANGED
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.90.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: 2022-12-
|
11
|
+
date: 2022-12-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|