aws-sdk-connect 1.98.0 → 1.99.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f743495f317c7663c592dc09e1a3c0bada465cfe5a034dde787e7510916a837c
4
- data.tar.gz: 1f3fd412666fec0dd5a6c49f125cb67fcfa19e0817496f23100344150d8268cd
3
+ metadata.gz: dbbeee8752c5a4a1896b308298de20b42aff4764e75749c31bd9bc94f8e11bfa
4
+ data.tar.gz: '0864386079c22a2ad5f26f7f86f527419196bbb13238964b1639712538995ae9'
5
5
  SHA512:
6
- metadata.gz: b4acdea589c17b8797a288cc4cedeb5ef161bef6f62132a8b5885196bfb8e17e2295f3ccdf1cfd74de4e70e30311244f17c709290a749f249ccaaf4fed28dc91
7
- data.tar.gz: 550cdf5002ddebe73d6da936f5ed3330a38622a509798c3aa0c22f37746b69d460689f9719014f26f9f1e93d86912181478fd3db1675b100a8687dec80df783b
6
+ metadata.gz: 8dbe27a0028ee6830806bfbc56c14965d3361a85d36f2ae7ab8fb31c836b1d8801fcdcca789408828f97def238bda69dcb87777498f395a77eaa656ced5dc3d5
7
+ data.tar.gz: cf6711af911049228aa0ec3216b4e3f6b654c96deec4aa302a5799b068db26f6f45ffd6fda8cec7131255806d804e36d8fb8fa575752fe6594d2a514ece9bc34
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.99.0 (2023-03-09)
5
+ ------------------
6
+
7
+ * Feature - This release adds a new API, GetMetricDataV2, which returns metric data for Amazon Connect.
8
+
4
9
  1.98.0 (2023-02-24)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.98.0
1
+ 1.99.0
@@ -4805,6 +4805,389 @@ module Aws::Connect
4805
4805
  req.send_request(options)
4806
4806
  end
4807
4807
 
4808
+ # Gets metric data from the specified Amazon Connect instance.
4809
+ #
4810
+ # `GetMetricDataV2` offers more features than [GetMetricData][1], the
4811
+ # previous version of this API. It has new metrics, offers filtering at
4812
+ # a metric level, and offers the ability to filter and group data by
4813
+ # channels, queues, routing profiles, agents, and agent hierarchy
4814
+ # levels. It can retrieve historical data for last the 14 days, in
4815
+ # 24-hour intervals.
4816
+ #
4817
+ # For a description of the historical metrics that are supported by
4818
+ # `GetMetricDataV2` and `GetMetricData`, see [Historical metrics
4819
+ # definitions][2] in the *Amazon Connect Administrator's Guide*.
4820
+ #
4821
+ # This API is not available in the Amazon Web Services GovCloud (US)
4822
+ # Regions.
4823
+ #
4824
+ #
4825
+ #
4826
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html
4827
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
4828
+ #
4829
+ # @option params [required, String] :resource_arn
4830
+ # The Amazon Resource Name (ARN) of the resource. This includes the
4831
+ # `instanceId` an Amazon Connect instance.
4832
+ #
4833
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_time
4834
+ # The timestamp, in UNIX Epoch time format, at which to start the
4835
+ # reporting interval for the retrieval of historical metrics data. The
4836
+ # time must be before the end time timestamp. The time range between the
4837
+ # start and end time must be less than 24 hours. The start time cannot
4838
+ # be earlier than 14 days before the time of the request. Historical
4839
+ # metrics are available for 14 days.
4840
+ #
4841
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_time
4842
+ # The timestamp, in UNIX Epoch time format, at which to end the
4843
+ # reporting interval for the retrieval of historical metrics data. The
4844
+ # time must be later than the start time timestamp.
4845
+ #
4846
+ # The time range between the start and end time must be less than 24
4847
+ # hours.
4848
+ #
4849
+ # @option params [required, Array<Types::FilterV2>] :filters
4850
+ # The filters to apply to returned metrics. You can filter on the
4851
+ # following resources:
4852
+ #
4853
+ # * Queues
4854
+ #
4855
+ # * Routing profiles
4856
+ #
4857
+ # * Agents
4858
+ #
4859
+ # * Channels
4860
+ #
4861
+ # * User hierarchy groups
4862
+ #
4863
+ # At least one filter must be passed from queues, routing profiles,
4864
+ # agents, or user hierarchy groups.
4865
+ #
4866
+ # To filter by phone number, see [Create a historical metrics report][1]
4867
+ # in the *Amazon Connect Administrator's Guide*.
4868
+ #
4869
+ # Note the following limits:
4870
+ #
4871
+ # * **Filter keys**\: A maximum of 5 filter keys are supported in a
4872
+ # single request. Valid filter keys: `QUEUE` \| `ROUTING_PROFILE` \|
4873
+ # `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
4874
+ # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
4875
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
4876
+ #
4877
+ # * **Filter values**\: A maximum of 100 filter values are supported in
4878
+ # a single request. For example, a `GetMetricDataV2` request can
4879
+ # filter by 50 queues, 35 agents, and 15 routing profiles for a total
4880
+ # of 100 filter values. `VOICE`, `CHAT`, and `TASK` are valid
4881
+ # `filterValue` for the `CHANNEL` filter key.
4882
+ #
4883
+ #
4884
+ #
4885
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
4886
+ #
4887
+ # @option params [Array<String>] :groupings
4888
+ # The grouping applied to the metrics that are returned. For example,
4889
+ # when results are grouped by queue, the metrics returned are grouped by
4890
+ # queue. The values that are returned apply to the metrics for each
4891
+ # queue. They are not aggregated for all queues.
4892
+ #
4893
+ # If no grouping is specified, a summary of all metrics is returned.
4894
+ #
4895
+ # Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
4896
+ # `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
4897
+ # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
4898
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
4899
+ #
4900
+ # @option params [required, Array<Types::MetricV2>] :metrics
4901
+ # The metrics to retrieve. Specify the name, groupings, and filters for
4902
+ # each metric. The following historical metrics are available. For a
4903
+ # description of each metric, see [Historical metrics definitions][1] in
4904
+ # the *Amazon Connect Administrator's Guide*.
4905
+ #
4906
+ # AGENT\_ADHERENT\_TIME
4907
+ #
4908
+ # : This metric is available only in Amazon Web Services Regions where
4909
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4910
+ #
4911
+ # Unit: Seconds
4912
+ #
4913
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4914
+ # Agent Hierarchy
4915
+ #
4916
+ # AGENT\_NON\_RESPONSE
4917
+ #
4918
+ # : Unit: Count
4919
+ #
4920
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4921
+ # Agent Hierarchy
4922
+ #
4923
+ # AGENT\_OCCUPANCY
4924
+ #
4925
+ # : Unit: Percentage
4926
+ #
4927
+ # Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
4928
+ #
4929
+ # AGENT\_SCHEDULE\_ADHERENCE
4930
+ #
4931
+ # : This metric is available only in Amazon Web Services Regions where
4932
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4933
+ #
4934
+ # Unit: Percent
4935
+ #
4936
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4937
+ # Agent Hierarchy
4938
+ #
4939
+ # AGENT\_SCHEDULED\_TIME
4940
+ #
4941
+ # : This metric is available only in Amazon Web Services Regions where
4942
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4943
+ #
4944
+ # Unit: Seconds
4945
+ #
4946
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4947
+ # Agent Hierarchy
4948
+ #
4949
+ # AVG\_ABANDON\_TIME
4950
+ #
4951
+ # : Unit: Seconds
4952
+ #
4953
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4954
+ # Agent Hierarchy
4955
+ #
4956
+ # AVG\_AFTER\_CONTACT\_WORK\_TIME
4957
+ #
4958
+ # : Unit: Seconds
4959
+ #
4960
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4961
+ # Agent Hierarchy
4962
+ #
4963
+ # AVG\_AGENT\_CONNECTING\_TIME
4964
+ #
4965
+ # : Unit: Seconds
4966
+ #
4967
+ # Valid metric filter key: `INITIATION_METHOD`. For now, this metric
4968
+ # only supports the following as `INITIATION_METHOD`\: `INBOUND` \|
4969
+ # `OUTBOUND` \| `CALLBACK` \| `API`
4970
+ #
4971
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4972
+ # Agent Hierarchy
4973
+ #
4974
+ # AVG\_HANDLE\_TIME
4975
+ #
4976
+ # : Unit: Seconds
4977
+ #
4978
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4979
+ # Agent Hierarchy
4980
+ #
4981
+ # AVG\_HOLD\_TIME
4982
+ #
4983
+ # : Unit: Seconds
4984
+ #
4985
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4986
+ # Agent Hierarchy
4987
+ #
4988
+ # AVG\_INTERACTION\_AND\_HOLD\_TIME
4989
+ #
4990
+ # : Unit: Seconds
4991
+ #
4992
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
4993
+ # Agent Hierarchy
4994
+ #
4995
+ # AVG\_INTERACTION\_TIME
4996
+ #
4997
+ # : Unit: Seconds
4998
+ #
4999
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5000
+ #
5001
+ # AVG\_QUEUE\_ANSWER\_TIME
5002
+ #
5003
+ # : Unit: Seconds
5004
+ #
5005
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5006
+ #
5007
+ # CONTACTS\_ABANDONED
5008
+ #
5009
+ # : Unit: Count
5010
+ #
5011
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5012
+ # Agent Hierarchy
5013
+ #
5014
+ # CONTACTS\_CREATED
5015
+ #
5016
+ # : Unit: Count
5017
+ #
5018
+ # Valid metric filter key: `INITIATION_METHOD`
5019
+ #
5020
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5021
+ #
5022
+ # CONTACTS\_HANDLED
5023
+ #
5024
+ # : Unit: Count
5025
+ #
5026
+ # Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
5027
+ #
5028
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5029
+ # Agent Hierarchy
5030
+ #
5031
+ # CONTACTS\_HOLD\_ABANDONS
5032
+ #
5033
+ # : Unit: Count
5034
+ #
5035
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5036
+ # Agent Hierarchy
5037
+ #
5038
+ # CONTACTS\_QUEUED
5039
+ #
5040
+ # : Unit: Count
5041
+ #
5042
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5043
+ # Agent Hierarchy
5044
+ #
5045
+ # CONTACTS\_TRANSFERRED\_OUT
5046
+ #
5047
+ # : Unit: Count
5048
+ #
5049
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5050
+ # Agent Hierarchy
5051
+ #
5052
+ # CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
5053
+ #
5054
+ # : Unit: Count
5055
+ #
5056
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5057
+ # Agent Hierarchy
5058
+ #
5059
+ # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
5060
+ #
5061
+ # : Unit: Count
5062
+ #
5063
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5064
+ # Agent Hierarchy
5065
+ #
5066
+ # MAX\_QUEUED\_TIME
5067
+ #
5068
+ # : Unit: Seconds
5069
+ #
5070
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
5071
+ # Agent Hierarchy
5072
+ #
5073
+ # SERVICE\_LEVEL
5074
+ #
5075
+ # : You can include up to 20 SERVICE\_LEVEL metrics in a request.
5076
+ #
5077
+ # Unit: Percent
5078
+ #
5079
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5080
+ #
5081
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
5082
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
5083
+ # `LT` (for "Less than").
5084
+ #
5085
+ # SUM\_CONTACTS\_ANSWERED\_IN\_X
5086
+ #
5087
+ # : Unit: Count
5088
+ #
5089
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5090
+ #
5091
+ # SUM\_CONTACTS\_ABANDONED\_IN\_X
5092
+ #
5093
+ # : Unit: Count
5094
+ #
5095
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5096
+ #
5097
+ # SUM\_CONTACTS\_DISCONNECTED
5098
+ #
5099
+ # : Valid metric filter key: `DISCONNECT_REASON`
5100
+ #
5101
+ # Unit: Count
5102
+ #
5103
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5104
+ #
5105
+ # SUM\_RETRY\_CALLBACK\_ATTEMPTS
5106
+ #
5107
+ # : Unit: Count
5108
+ #
5109
+ # Valid groupings and filters: Queue, Channel, Routing Profile
5110
+ #
5111
+ #
5112
+ #
5113
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
5114
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region
5115
+ #
5116
+ # @option params [String] :next_token
5117
+ # The token for the next set of results. Use the value returned in the
5118
+ # previous response in the next request to retrieve the next set of
5119
+ # results.
5120
+ #
5121
+ # @option params [Integer] :max_results
5122
+ # The maximum number of results to return per page.
5123
+ #
5124
+ # @return [Types::GetMetricDataV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5125
+ #
5126
+ # * {Types::GetMetricDataV2Response#next_token #next_token} => String
5127
+ # * {Types::GetMetricDataV2Response#metric_results #metric_results} => Array&lt;Types::MetricResultV2&gt;
5128
+ #
5129
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5130
+ #
5131
+ # @example Request syntax with placeholder values
5132
+ #
5133
+ # resp = client.get_metric_data_v2({
5134
+ # resource_arn: "ARN", # required
5135
+ # start_time: Time.now, # required
5136
+ # end_time: Time.now, # required
5137
+ # filters: [ # required
5138
+ # {
5139
+ # filter_key: "ResourceArnOrId",
5140
+ # filter_values: ["ResourceArnOrId"],
5141
+ # },
5142
+ # ],
5143
+ # groupings: ["GroupingV2"],
5144
+ # metrics: [ # required
5145
+ # {
5146
+ # name: "MetricNameV2",
5147
+ # threshold: [
5148
+ # {
5149
+ # comparison: "ResourceArnOrId",
5150
+ # threshold_value: 1.0,
5151
+ # },
5152
+ # ],
5153
+ # metric_filters: [
5154
+ # {
5155
+ # metric_filter_key: "String",
5156
+ # metric_filter_values: ["String"],
5157
+ # },
5158
+ # ],
5159
+ # },
5160
+ # ],
5161
+ # next_token: "NextToken2500",
5162
+ # max_results: 1,
5163
+ # })
5164
+ #
5165
+ # @example Response structure
5166
+ #
5167
+ # resp.next_token #=> String
5168
+ # resp.metric_results #=> Array
5169
+ # resp.metric_results[0].dimensions #=> Hash
5170
+ # resp.metric_results[0].dimensions["DimensionsV2Key"] #=> String
5171
+ # resp.metric_results[0].collections #=> Array
5172
+ # resp.metric_results[0].collections[0].metric.name #=> String
5173
+ # resp.metric_results[0].collections[0].metric.threshold #=> Array
5174
+ # resp.metric_results[0].collections[0].metric.threshold[0].comparison #=> String
5175
+ # resp.metric_results[0].collections[0].metric.threshold[0].threshold_value #=> Float
5176
+ # resp.metric_results[0].collections[0].metric.metric_filters #=> Array
5177
+ # resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
5178
+ # resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
5179
+ # resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values[0] #=> String
5180
+ # resp.metric_results[0].collections[0].value #=> Float
5181
+ #
5182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2 AWS API Documentation
5183
+ #
5184
+ # @overload get_metric_data_v2(params = {})
5185
+ # @param [Hash] params ({})
5186
+ def get_metric_data_v2(params = {}, options = {})
5187
+ req = build_request(:get_metric_data_v2, params)
5188
+ req.send_request(options)
5189
+ end
5190
+
4808
5191
  # Gets details about a specific task template in the specified Amazon
4809
5192
  # Connect instance.
4810
5193
  #
@@ -10367,7 +10750,7 @@ module Aws::Connect
10367
10750
  params: params,
10368
10751
  config: config)
10369
10752
  context[:gem_name] = 'aws-sdk-connect'
10370
- context[:gem_version] = '1.98.0'
10753
+ context[:gem_version] = '1.99.0'
10371
10754
  Seahorse::Client::Request.new(handlers, context)
10372
10755
  end
10373
10756
 
@@ -229,6 +229,9 @@ module Aws::Connect
229
229
  Description250 = Shapes::StringShape.new(name: 'Description250')
230
230
  DestinationNotAllowedException = Shapes::StructureShape.new(name: 'DestinationNotAllowedException')
231
231
  Dimensions = Shapes::StructureShape.new(name: 'Dimensions')
232
+ DimensionsV2Key = Shapes::StringShape.new(name: 'DimensionsV2Key')
233
+ DimensionsV2Map = Shapes::MapShape.new(name: 'DimensionsV2Map')
234
+ DimensionsV2Value = Shapes::StringShape.new(name: 'DimensionsV2Value')
232
235
  DirectoryAlias = Shapes::StringShape.new(name: 'DirectoryAlias')
233
236
  DirectoryId = Shapes::StringShape.new(name: 'DirectoryId')
234
237
  DirectoryType = Shapes::StringShape.new(name: 'DirectoryType')
@@ -255,7 +258,10 @@ module Aws::Connect
255
258
  EventBridgeActionDefinition = Shapes::StructureShape.new(name: 'EventBridgeActionDefinition')
256
259
  EventBridgeActionName = Shapes::StringShape.new(name: 'EventBridgeActionName')
257
260
  EventSourceName = Shapes::StringShape.new(name: 'EventSourceName')
261
+ FilterV2 = Shapes::StructureShape.new(name: 'FilterV2')
262
+ FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
258
263
  Filters = Shapes::StructureShape.new(name: 'Filters')
264
+ FiltersV2List = Shapes::ListShape.new(name: 'FiltersV2List')
259
265
  FunctionArn = Shapes::StringShape.new(name: 'FunctionArn')
260
266
  FunctionArnsList = Shapes::ListShape.new(name: 'FunctionArnsList')
261
267
  GetContactAttributesRequest = Shapes::StructureShape.new(name: 'GetContactAttributesRequest')
@@ -268,12 +274,16 @@ module Aws::Connect
268
274
  GetFederationTokenResponse = Shapes::StructureShape.new(name: 'GetFederationTokenResponse')
269
275
  GetMetricDataRequest = Shapes::StructureShape.new(name: 'GetMetricDataRequest')
270
276
  GetMetricDataResponse = Shapes::StructureShape.new(name: 'GetMetricDataResponse')
277
+ GetMetricDataV2Request = Shapes::StructureShape.new(name: 'GetMetricDataV2Request')
278
+ GetMetricDataV2Response = Shapes::StructureShape.new(name: 'GetMetricDataV2Response')
271
279
  GetTaskTemplateRequest = Shapes::StructureShape.new(name: 'GetTaskTemplateRequest')
272
280
  GetTaskTemplateResponse = Shapes::StructureShape.new(name: 'GetTaskTemplateResponse')
273
281
  GetTrafficDistributionRequest = Shapes::StructureShape.new(name: 'GetTrafficDistributionRequest')
274
282
  GetTrafficDistributionResponse = Shapes::StructureShape.new(name: 'GetTrafficDistributionResponse')
275
283
  Grouping = Shapes::StringShape.new(name: 'Grouping')
284
+ GroupingV2 = Shapes::StringShape.new(name: 'GroupingV2')
276
285
  Groupings = Shapes::ListShape.new(name: 'Groupings')
286
+ GroupingsV2 = Shapes::ListShape.new(name: 'GroupingsV2')
277
287
  HierarchyGroup = Shapes::StructureShape.new(name: 'HierarchyGroup')
278
288
  HierarchyGroupCondition = Shapes::StructureShape.new(name: 'HierarchyGroupCondition')
279
289
  HierarchyGroupId = Shapes::StringShape.new(name: 'HierarchyGroupId')
@@ -426,6 +436,16 @@ module Aws::Connect
426
436
  MediaConcurrencies = Shapes::ListShape.new(name: 'MediaConcurrencies')
427
437
  MediaConcurrency = Shapes::StructureShape.new(name: 'MediaConcurrency')
428
438
  Message = Shapes::StringShape.new(name: 'Message')
439
+ MetricDataCollectionsV2 = Shapes::ListShape.new(name: 'MetricDataCollectionsV2')
440
+ MetricDataV2 = Shapes::StructureShape.new(name: 'MetricDataV2')
441
+ MetricFilterV2 = Shapes::StructureShape.new(name: 'MetricFilterV2')
442
+ MetricFilterValueList = Shapes::ListShape.new(name: 'MetricFilterValueList')
443
+ MetricFiltersV2List = Shapes::ListShape.new(name: 'MetricFiltersV2List')
444
+ MetricNameV2 = Shapes::StringShape.new(name: 'MetricNameV2')
445
+ MetricResultV2 = Shapes::StructureShape.new(name: 'MetricResultV2')
446
+ MetricResultsV2 = Shapes::ListShape.new(name: 'MetricResultsV2')
447
+ MetricV2 = Shapes::StructureShape.new(name: 'MetricV2')
448
+ MetricsV2 = Shapes::ListShape.new(name: 'MetricsV2')
429
449
  MinutesLimit60 = Shapes::IntegerShape.new(name: 'MinutesLimit60')
430
450
  MonitorCapability = Shapes::StringShape.new(name: 'MonitorCapability')
431
451
  MonitorContactRequest = Shapes::StructureShape.new(name: 'MonitorContactRequest')
@@ -532,6 +552,7 @@ module Aws::Connect
532
552
  ReplicateInstanceResponse = Shapes::StructureShape.new(name: 'ReplicateInstanceResponse')
533
553
  RequiredFieldInfo = Shapes::StructureShape.new(name: 'RequiredFieldInfo')
534
554
  RequiredTaskTemplateFields = Shapes::ListShape.new(name: 'RequiredTaskTemplateFields')
555
+ ResourceArnOrId = Shapes::StringShape.new(name: 'ResourceArnOrId')
535
556
  ResourceConflictException = Shapes::StructureShape.new(name: 'ResourceConflictException')
536
557
  ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
537
558
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -668,6 +689,8 @@ module Aws::Connect
668
689
  TaskTemplateStatus = Shapes::StringShape.new(name: 'TaskTemplateStatus')
669
690
  TelephonyConfig = Shapes::StructureShape.new(name: 'TelephonyConfig')
670
691
  Threshold = Shapes::StructureShape.new(name: 'Threshold')
692
+ ThresholdCollections = Shapes::ListShape.new(name: 'ThresholdCollections')
693
+ ThresholdV2 = Shapes::StructureShape.new(name: 'ThresholdV2')
671
694
  ThresholdValue = Shapes::FloatShape.new(name: 'ThresholdValue')
672
695
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
673
696
  TimeZone = Shapes::StringShape.new(name: 'TimeZone')
@@ -1491,6 +1514,9 @@ module Aws::Connect
1491
1514
  Dimensions.add_member(:routing_profile, Shapes::ShapeRef.new(shape: RoutingProfileReference, location_name: "RoutingProfile"))
1492
1515
  Dimensions.struct_class = Types::Dimensions
1493
1516
 
1517
+ DimensionsV2Map.key = Shapes::ShapeRef.new(shape: DimensionsV2Key)
1518
+ DimensionsV2Map.value = Shapes::ShapeRef.new(shape: DimensionsV2Value)
1519
+
1494
1520
  DisassociateApprovedOriginRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
1495
1521
  DisassociateApprovedOriginRequest.add_member(:origin, Shapes::ShapeRef.new(shape: Origin, required: true, location: "querystring", location_name: "origin"))
1496
1522
  DisassociateApprovedOriginRequest.struct_class = Types::DisassociateApprovedOriginRequest
@@ -1559,11 +1585,19 @@ module Aws::Connect
1559
1585
  EventBridgeActionDefinition.add_member(:name, Shapes::ShapeRef.new(shape: EventBridgeActionName, required: true, location_name: "Name"))
1560
1586
  EventBridgeActionDefinition.struct_class = Types::EventBridgeActionDefinition
1561
1587
 
1588
+ FilterV2.add_member(:filter_key, Shapes::ShapeRef.new(shape: ResourceArnOrId, location_name: "FilterKey"))
1589
+ FilterV2.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValueList, location_name: "FilterValues"))
1590
+ FilterV2.struct_class = Types::FilterV2
1591
+
1592
+ FilterValueList.member = Shapes::ShapeRef.new(shape: ResourceArnOrId)
1593
+
1562
1594
  Filters.add_member(:queues, Shapes::ShapeRef.new(shape: Queues, location_name: "Queues"))
1563
1595
  Filters.add_member(:channels, Shapes::ShapeRef.new(shape: Channels, location_name: "Channels"))
1564
1596
  Filters.add_member(:routing_profiles, Shapes::ShapeRef.new(shape: RoutingProfiles, location_name: "RoutingProfiles"))
1565
1597
  Filters.struct_class = Types::Filters
1566
1598
 
1599
+ FiltersV2List.member = Shapes::ShapeRef.new(shape: FilterV2)
1600
+
1567
1601
  FunctionArnsList.member = Shapes::ShapeRef.new(shape: FunctionArn)
1568
1602
 
1569
1603
  GetContactAttributesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
@@ -1622,6 +1656,20 @@ module Aws::Connect
1622
1656
  GetMetricDataResponse.add_member(:metric_results, Shapes::ShapeRef.new(shape: HistoricalMetricResults, location_name: "MetricResults"))
1623
1657
  GetMetricDataResponse.struct_class = Types::GetMetricDataResponse
1624
1658
 
1659
+ GetMetricDataV2Request.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "ResourceArn"))
1660
+ GetMetricDataV2Request.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartTime"))
1661
+ GetMetricDataV2Request.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndTime"))
1662
+ GetMetricDataV2Request.add_member(:filters, Shapes::ShapeRef.new(shape: FiltersV2List, required: true, location_name: "Filters"))
1663
+ GetMetricDataV2Request.add_member(:groupings, Shapes::ShapeRef.new(shape: GroupingsV2, location_name: "Groupings"))
1664
+ GetMetricDataV2Request.add_member(:metrics, Shapes::ShapeRef.new(shape: MetricsV2, required: true, location_name: "Metrics"))
1665
+ GetMetricDataV2Request.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken2500, location_name: "NextToken"))
1666
+ GetMetricDataV2Request.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
1667
+ GetMetricDataV2Request.struct_class = Types::GetMetricDataV2Request
1668
+
1669
+ GetMetricDataV2Response.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken2500, location_name: "NextToken"))
1670
+ GetMetricDataV2Response.add_member(:metric_results, Shapes::ShapeRef.new(shape: MetricResultsV2, location_name: "MetricResults"))
1671
+ GetMetricDataV2Response.struct_class = Types::GetMetricDataV2Response
1672
+
1625
1673
  GetTaskTemplateRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
1626
1674
  GetTaskTemplateRequest.add_member(:task_template_id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location: "uri", location_name: "TaskTemplateId"))
1627
1675
  GetTaskTemplateRequest.add_member(:snapshot_version, Shapes::ShapeRef.new(shape: SnapshotVersion, location: "querystring", location_name: "snapshotVersion"))
@@ -1652,6 +1700,8 @@ module Aws::Connect
1652
1700
 
1653
1701
  Groupings.member = Shapes::ShapeRef.new(shape: Grouping)
1654
1702
 
1703
+ GroupingsV2.member = Shapes::ShapeRef.new(shape: GroupingV2)
1704
+
1655
1705
  HierarchyGroup.add_member(:id, Shapes::ShapeRef.new(shape: HierarchyGroupId, location_name: "Id"))
1656
1706
  HierarchyGroup.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
1657
1707
  HierarchyGroup.add_member(:name, Shapes::ShapeRef.new(shape: HierarchyGroupName, location_name: "Name"))
@@ -2183,6 +2233,33 @@ module Aws::Connect
2183
2233
  MediaConcurrency.add_member(:concurrency, Shapes::ShapeRef.new(shape: Concurrency, required: true, location_name: "Concurrency"))
2184
2234
  MediaConcurrency.struct_class = Types::MediaConcurrency
2185
2235
 
2236
+ MetricDataCollectionsV2.member = Shapes::ShapeRef.new(shape: MetricDataV2)
2237
+
2238
+ MetricDataV2.add_member(:metric, Shapes::ShapeRef.new(shape: MetricV2, location_name: "Metric"))
2239
+ MetricDataV2.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "Value", metadata: {"box"=>true}))
2240
+ MetricDataV2.struct_class = Types::MetricDataV2
2241
+
2242
+ MetricFilterV2.add_member(:metric_filter_key, Shapes::ShapeRef.new(shape: String, location_name: "MetricFilterKey"))
2243
+ MetricFilterV2.add_member(:metric_filter_values, Shapes::ShapeRef.new(shape: MetricFilterValueList, location_name: "MetricFilterValues"))
2244
+ MetricFilterV2.struct_class = Types::MetricFilterV2
2245
+
2246
+ MetricFilterValueList.member = Shapes::ShapeRef.new(shape: String)
2247
+
2248
+ MetricFiltersV2List.member = Shapes::ShapeRef.new(shape: MetricFilterV2)
2249
+
2250
+ MetricResultV2.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionsV2Map, location_name: "Dimensions"))
2251
+ MetricResultV2.add_member(:collections, Shapes::ShapeRef.new(shape: MetricDataCollectionsV2, location_name: "Collections"))
2252
+ MetricResultV2.struct_class = Types::MetricResultV2
2253
+
2254
+ MetricResultsV2.member = Shapes::ShapeRef.new(shape: MetricResultV2)
2255
+
2256
+ MetricV2.add_member(:name, Shapes::ShapeRef.new(shape: MetricNameV2, location_name: "Name"))
2257
+ MetricV2.add_member(:threshold, Shapes::ShapeRef.new(shape: ThresholdCollections, location_name: "Threshold"))
2258
+ MetricV2.add_member(:metric_filters, Shapes::ShapeRef.new(shape: MetricFiltersV2List, location_name: "MetricFilters"))
2259
+ MetricV2.struct_class = Types::MetricV2
2260
+
2261
+ MetricsV2.member = Shapes::ShapeRef.new(shape: MetricV2)
2262
+
2186
2263
  MonitorContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
2187
2264
  MonitorContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
2188
2265
  MonitorContactRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: AgentResourceId, required: true, location_name: "UserId"))
@@ -2834,6 +2911,12 @@ module Aws::Connect
2834
2911
  Threshold.add_member(:threshold_value, Shapes::ShapeRef.new(shape: ThresholdValue, location_name: "ThresholdValue", metadata: {"box"=>true}))
2835
2912
  Threshold.struct_class = Types::Threshold
2836
2913
 
2914
+ ThresholdCollections.member = Shapes::ShapeRef.new(shape: ThresholdV2)
2915
+
2916
+ ThresholdV2.add_member(:comparison, Shapes::ShapeRef.new(shape: ResourceArnOrId, location_name: "Comparison"))
2917
+ ThresholdV2.add_member(:threshold_value, Shapes::ShapeRef.new(shape: ThresholdValue, location_name: "ThresholdValue", metadata: {"box"=>true}))
2918
+ ThresholdV2.struct_class = Types::ThresholdV2
2919
+
2837
2920
  ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
2838
2921
  ThrottlingException.struct_class = Types::ThrottlingException
2839
2922
 
@@ -4332,6 +4415,25 @@ module Aws::Connect
4332
4415
  )
4333
4416
  end)
4334
4417
 
4418
+ api.add_operation(:get_metric_data_v2, Seahorse::Model::Operation.new.tap do |o|
4419
+ o.name = "GetMetricDataV2"
4420
+ o.http_method = "POST"
4421
+ o.http_request_uri = "/metrics/data"
4422
+ o.input = Shapes::ShapeRef.new(shape: GetMetricDataV2Request)
4423
+ o.output = Shapes::ShapeRef.new(shape: GetMetricDataV2Response)
4424
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
4425
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
4426
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
4427
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
4428
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
4429
+ o[:pager] = Aws::Pager.new(
4430
+ limit_key: "max_results",
4431
+ tokens: {
4432
+ "next_token" => "next_token"
4433
+ }
4434
+ )
4435
+ end)
4436
+
4335
4437
  api.add_operation(:get_task_template, Seahorse::Model::Operation.new.tap do |o|
4336
4438
  o.name = "GetTaskTemplate"
4337
4439
  o.http_method = "GET"
@@ -1075,6 +1075,20 @@ module Aws::Connect
1075
1075
  end
1076
1076
  end
1077
1077
 
1078
+ class GetMetricDataV2
1079
+ def self.build(context)
1080
+ unless context.config.regional_endpoint
1081
+ endpoint = context.config.endpoint.to_s
1082
+ end
1083
+ Aws::Connect::EndpointParameters.new(
1084
+ region: context.config.region,
1085
+ use_dual_stack: context.config.use_dualstack_endpoint,
1086
+ use_fips: context.config.use_fips_endpoint,
1087
+ endpoint: endpoint,
1088
+ )
1089
+ end
1090
+ end
1091
+
1078
1092
  class GetTaskTemplate
1079
1093
  def self.build(context)
1080
1094
  unless context.config.regional_endpoint
@@ -208,6 +208,8 @@ module Aws::Connect
208
208
  Aws::Connect::Endpoints::GetFederationToken.build(context)
209
209
  when :get_metric_data
210
210
  Aws::Connect::Endpoints::GetMetricData.build(context)
211
+ when :get_metric_data_v2
212
+ Aws::Connect::Endpoints::GetMetricDataV2.build(context)
211
213
  when :get_task_template
212
214
  Aws::Connect::Endpoints::GetTaskTemplate.build(context)
213
215
  when :get_traffic_distribution
@@ -3903,6 +3903,36 @@ module Aws::Connect
3903
3903
  include Aws::Structure
3904
3904
  end
3905
3905
 
3906
+ # Contains the filter to apply when retrieving metrics with the
3907
+ # [GetMetricDataV2][1] API.
3908
+ #
3909
+ #
3910
+ #
3911
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html
3912
+ #
3913
+ # @!attribute [rw] filter_key
3914
+ # The key to use for filtering data. For example, `QUEUE`,
3915
+ # `ROUTING_PROFILE, AGENT`, `CHANNEL`, `AGENT_HIERARCHY_LEVEL_ONE`,
3916
+ # `AGENT_HIERARCHY_LEVEL_TWO`, `AGENT_HIERARCHY_LEVEL_THREE`,
3917
+ # `AGENT_HIERARCHY_LEVEL_FOUR`, `AGENT_HIERARCHY_LEVEL_FIVE`. There
3918
+ # must be at least 1 key and a maximum 5 keys.
3919
+ # @return [String]
3920
+ #
3921
+ # @!attribute [rw] filter_values
3922
+ # The identifiers to use for filtering data. For example, if you have
3923
+ # a filter key of `QUEUE`, you would add queue IDs or ARNs in
3924
+ # `FilterValues`.
3925
+ # @return [Array<String>]
3926
+ #
3927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/FilterV2 AWS API Documentation
3928
+ #
3929
+ class FilterV2 < Struct.new(
3930
+ :filter_key,
3931
+ :filter_values)
3932
+ SENSITIVE = []
3933
+ include Aws::Structure
3934
+ end
3935
+
3906
3936
  # Contains the filter to apply when retrieving metrics.
3907
3937
  #
3908
3938
  # @!attribute [rw] queues
@@ -4584,6 +4614,344 @@ module Aws::Connect
4584
4614
  include Aws::Structure
4585
4615
  end
4586
4616
 
4617
+ # @!attribute [rw] resource_arn
4618
+ # The Amazon Resource Name (ARN) of the resource. This includes the
4619
+ # `instanceId` an Amazon Connect instance.
4620
+ # @return [String]
4621
+ #
4622
+ # @!attribute [rw] start_time
4623
+ # The timestamp, in UNIX Epoch time format, at which to start the
4624
+ # reporting interval for the retrieval of historical metrics data. The
4625
+ # time must be before the end time timestamp. The time range between
4626
+ # the start and end time must be less than 24 hours. The start time
4627
+ # cannot be earlier than 14 days before the time of the request.
4628
+ # Historical metrics are available for 14 days.
4629
+ # @return [Time]
4630
+ #
4631
+ # @!attribute [rw] end_time
4632
+ # The timestamp, in UNIX Epoch time format, at which to end the
4633
+ # reporting interval for the retrieval of historical metrics data. The
4634
+ # time must be later than the start time timestamp.
4635
+ #
4636
+ # The time range between the start and end time must be less than 24
4637
+ # hours.
4638
+ # @return [Time]
4639
+ #
4640
+ # @!attribute [rw] filters
4641
+ # The filters to apply to returned metrics. You can filter on the
4642
+ # following resources:
4643
+ #
4644
+ # * Queues
4645
+ #
4646
+ # * Routing profiles
4647
+ #
4648
+ # * Agents
4649
+ #
4650
+ # * Channels
4651
+ #
4652
+ # * User hierarchy groups
4653
+ #
4654
+ # At least one filter must be passed from queues, routing profiles,
4655
+ # agents, or user hierarchy groups.
4656
+ #
4657
+ # To filter by phone number, see [Create a historical metrics
4658
+ # report][1] in the *Amazon Connect Administrator's Guide*.
4659
+ #
4660
+ # Note the following limits:
4661
+ #
4662
+ # * **Filter keys**\: A maximum of 5 filter keys are supported in a
4663
+ # single request. Valid filter keys: `QUEUE` \| `ROUTING_PROFILE` \|
4664
+ # `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
4665
+ # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
4666
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
4667
+ #
4668
+ # * **Filter values**\: A maximum of 100 filter values are supported
4669
+ # in a single request. For example, a `GetMetricDataV2` request can
4670
+ # filter by 50 queues, 35 agents, and 15 routing profiles for a
4671
+ # total of 100 filter values. `VOICE`, `CHAT`, and `TASK` are valid
4672
+ # `filterValue` for the `CHANNEL` filter key.
4673
+ #
4674
+ #
4675
+ #
4676
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
4677
+ # @return [Array<Types::FilterV2>]
4678
+ #
4679
+ # @!attribute [rw] groupings
4680
+ # The grouping applied to the metrics that are returned. For example,
4681
+ # when results are grouped by queue, the metrics returned are grouped
4682
+ # by queue. The values that are returned apply to the metrics for each
4683
+ # queue. They are not aggregated for all queues.
4684
+ #
4685
+ # If no grouping is specified, a summary of all metrics is returned.
4686
+ #
4687
+ # Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
4688
+ # `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
4689
+ # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
4690
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
4691
+ # @return [Array<String>]
4692
+ #
4693
+ # @!attribute [rw] metrics
4694
+ # The metrics to retrieve. Specify the name, groupings, and filters
4695
+ # for each metric. The following historical metrics are available. For
4696
+ # a description of each metric, see [Historical metrics
4697
+ # definitions][1] in the *Amazon Connect Administrator's Guide*.
4698
+ #
4699
+ # AGENT\_ADHERENT\_TIME
4700
+ #
4701
+ # : This metric is available only in Amazon Web Services Regions where
4702
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4703
+ #
4704
+ # Unit: Seconds
4705
+ #
4706
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4707
+ # Agent, Agent Hierarchy
4708
+ #
4709
+ # AGENT\_NON\_RESPONSE
4710
+ #
4711
+ # : Unit: Count
4712
+ #
4713
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4714
+ # Agent, Agent Hierarchy
4715
+ #
4716
+ # AGENT\_OCCUPANCY
4717
+ #
4718
+ # : Unit: Percentage
4719
+ #
4720
+ # Valid groupings and filters: Routing Profile, Agent, Agent
4721
+ # Hierarchy
4722
+ #
4723
+ # AGENT\_SCHEDULE\_ADHERENCE
4724
+ #
4725
+ # : This metric is available only in Amazon Web Services Regions where
4726
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4727
+ #
4728
+ # Unit: Percent
4729
+ #
4730
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4731
+ # Agent, Agent Hierarchy
4732
+ #
4733
+ # AGENT\_SCHEDULED\_TIME
4734
+ #
4735
+ # : This metric is available only in Amazon Web Services Regions where
4736
+ # [Forecasting, capacity planning, and scheduling][2] is available.
4737
+ #
4738
+ # Unit: Seconds
4739
+ #
4740
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4741
+ # Agent, Agent Hierarchy
4742
+ #
4743
+ # AVG\_ABANDON\_TIME
4744
+ #
4745
+ # : Unit: Seconds
4746
+ #
4747
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4748
+ # Agent, Agent Hierarchy
4749
+ #
4750
+ # AVG\_AFTER\_CONTACT\_WORK\_TIME
4751
+ #
4752
+ # : Unit: Seconds
4753
+ #
4754
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4755
+ # Agent, Agent Hierarchy
4756
+ #
4757
+ # AVG\_AGENT\_CONNECTING\_TIME
4758
+ #
4759
+ # : Unit: Seconds
4760
+ #
4761
+ # Valid metric filter key: `INITIATION_METHOD`. For now, this metric
4762
+ # only supports the following as `INITIATION_METHOD`\: `INBOUND` \|
4763
+ # `OUTBOUND` \| `CALLBACK` \| `API`
4764
+ #
4765
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4766
+ # Agent, Agent Hierarchy
4767
+ #
4768
+ # AVG\_HANDLE\_TIME
4769
+ #
4770
+ # : Unit: Seconds
4771
+ #
4772
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4773
+ # Agent, Agent Hierarchy
4774
+ #
4775
+ # AVG\_HOLD\_TIME
4776
+ #
4777
+ # : Unit: Seconds
4778
+ #
4779
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4780
+ # Agent, Agent Hierarchy
4781
+ #
4782
+ # AVG\_INTERACTION\_AND\_HOLD\_TIME
4783
+ #
4784
+ # : Unit: Seconds
4785
+ #
4786
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4787
+ # Agent, Agent Hierarchy
4788
+ #
4789
+ # AVG\_INTERACTION\_TIME
4790
+ #
4791
+ # : Unit: Seconds
4792
+ #
4793
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4794
+ #
4795
+ # AVG\_QUEUE\_ANSWER\_TIME
4796
+ #
4797
+ # : Unit: Seconds
4798
+ #
4799
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4800
+ #
4801
+ # CONTACTS\_ABANDONED
4802
+ #
4803
+ # : Unit: Count
4804
+ #
4805
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4806
+ # Agent, Agent Hierarchy
4807
+ #
4808
+ # CONTACTS\_CREATED
4809
+ #
4810
+ # : Unit: Count
4811
+ #
4812
+ # Valid metric filter key: `INITIATION_METHOD`
4813
+ #
4814
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4815
+ #
4816
+ # CONTACTS\_HANDLED
4817
+ #
4818
+ # : Unit: Count
4819
+ #
4820
+ # Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
4821
+ #
4822
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4823
+ # Agent, Agent Hierarchy
4824
+ #
4825
+ # CONTACTS\_HOLD\_ABANDONS
4826
+ #
4827
+ # : Unit: Count
4828
+ #
4829
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4830
+ # Agent, Agent Hierarchy
4831
+ #
4832
+ # CONTACTS\_QUEUED
4833
+ #
4834
+ # : Unit: Count
4835
+ #
4836
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4837
+ # Agent, Agent Hierarchy
4838
+ #
4839
+ # CONTACTS\_TRANSFERRED\_OUT
4840
+ #
4841
+ # : Unit: Count
4842
+ #
4843
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4844
+ # Agent, Agent Hierarchy
4845
+ #
4846
+ # CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
4847
+ #
4848
+ # : Unit: Count
4849
+ #
4850
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4851
+ # Agent, Agent Hierarchy
4852
+ #
4853
+ # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
4854
+ #
4855
+ # : Unit: Count
4856
+ #
4857
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4858
+ # Agent, Agent Hierarchy
4859
+ #
4860
+ # MAX\_QUEUED\_TIME
4861
+ #
4862
+ # : Unit: Seconds
4863
+ #
4864
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
4865
+ # Agent, Agent Hierarchy
4866
+ #
4867
+ # SERVICE\_LEVEL
4868
+ #
4869
+ # : You can include up to 20 SERVICE\_LEVEL metrics in a request.
4870
+ #
4871
+ # Unit: Percent
4872
+ #
4873
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4874
+ #
4875
+ # Threshold: For `ThresholdValue`, enter any whole number from 1 to
4876
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
4877
+ # `LT` (for "Less than").
4878
+ #
4879
+ # SUM\_CONTACTS\_ANSWERED\_IN\_X
4880
+ #
4881
+ # : Unit: Count
4882
+ #
4883
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4884
+ #
4885
+ # SUM\_CONTACTS\_ABANDONED\_IN\_X
4886
+ #
4887
+ # : Unit: Count
4888
+ #
4889
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4890
+ #
4891
+ # SUM\_CONTACTS\_DISCONNECTED
4892
+ #
4893
+ # : Valid metric filter key: `DISCONNECT_REASON`
4894
+ #
4895
+ # Unit: Count
4896
+ #
4897
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4898
+ #
4899
+ # SUM\_RETRY\_CALLBACK\_ATTEMPTS
4900
+ #
4901
+ # : Unit: Count
4902
+ #
4903
+ # Valid groupings and filters: Queue, Channel, Routing Profile
4904
+ #
4905
+ #
4906
+ #
4907
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
4908
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region
4909
+ # @return [Array<Types::MetricV2>]
4910
+ #
4911
+ # @!attribute [rw] next_token
4912
+ # The token for the next set of results. Use the value returned in the
4913
+ # previous response in the next request to retrieve the next set of
4914
+ # results.
4915
+ # @return [String]
4916
+ #
4917
+ # @!attribute [rw] max_results
4918
+ # The maximum number of results to return per page.
4919
+ # @return [Integer]
4920
+ #
4921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2Request AWS API Documentation
4922
+ #
4923
+ class GetMetricDataV2Request < Struct.new(
4924
+ :resource_arn,
4925
+ :start_time,
4926
+ :end_time,
4927
+ :filters,
4928
+ :groupings,
4929
+ :metrics,
4930
+ :next_token,
4931
+ :max_results)
4932
+ SENSITIVE = []
4933
+ include Aws::Structure
4934
+ end
4935
+
4936
+ # @!attribute [rw] next_token
4937
+ # If there are additional results, this is the token for the next set
4938
+ # of results.
4939
+ # @return [String]
4940
+ #
4941
+ # @!attribute [rw] metric_results
4942
+ # Information about the metrics requested in the API request If no
4943
+ # grouping is specified, a summary of metric data is returned.
4944
+ # @return [Array<Types::MetricResultV2>]
4945
+ #
4946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2Response AWS API Documentation
4947
+ #
4948
+ class GetMetricDataV2Response < Struct.new(
4949
+ :next_token,
4950
+ :metric_results)
4951
+ SENSITIVE = []
4952
+ include Aws::Structure
4953
+ end
4954
+
4587
4955
  # @!attribute [rw] instance_id
4588
4956
  # The identifier of the Amazon Connect instance. You can [find the
4589
4957
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -7352,6 +7720,101 @@ module Aws::Connect
7352
7720
  include Aws::Structure
7353
7721
  end
7354
7722
 
7723
+ # Contains the name, thresholds, and metric filters.
7724
+ #
7725
+ # @!attribute [rw] metric
7726
+ # The metric name, thresholds, and metric filters of the returned
7727
+ # metric.
7728
+ # @return [Types::MetricV2]
7729
+ #
7730
+ # @!attribute [rw] value
7731
+ # The corresponding value of the metric returned in the response.
7732
+ # @return [Float]
7733
+ #
7734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricDataV2 AWS API Documentation
7735
+ #
7736
+ class MetricDataV2 < Struct.new(
7737
+ :metric,
7738
+ :value)
7739
+ SENSITIVE = []
7740
+ include Aws::Structure
7741
+ end
7742
+
7743
+ # Contains information about the filter used when retrieving metrics.
7744
+ # `MetricFiltersV2` can be used on the following metrics:
7745
+ # `AVG_AGENT_CONNECTING_TIME`, `CONTACTS_CREATED`, `CONTACTS_HANDLED`,
7746
+ # `SUM_CONTACTS_DISCONNECTED`.
7747
+ #
7748
+ # @!attribute [rw] metric_filter_key
7749
+ # The key to use for filtering data.
7750
+ #
7751
+ # Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON`
7752
+ # @return [String]
7753
+ #
7754
+ # @!attribute [rw] metric_filter_values
7755
+ # The values to use for filtering data.
7756
+ #
7757
+ # Valid metric filter values for `INITIATION_METHOD`\: `INBOUND` \|
7758
+ # `OUTBOUND` \| `TRANSFER` \| `QUEUE_TRANSFER` \| `CALLBACK` \| `API`
7759
+ #
7760
+ # Valid metric filter values for `DISCONNECT_REASON`\:
7761
+ # `CUSTOMER_DISCONNECT` \| `AGENT_DISCONNECT` \|
7762
+ # `THIRD_PARTY_DISCONNECT` \| `TELECOM_PROBLEM` \| `BARGED` \|
7763
+ # `CONTACT_FLOW_DISCONNECT` \| `OTHER` \| `EXPIRED` \| `API`
7764
+ # @return [Array<String>]
7765
+ #
7766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricFilterV2 AWS API Documentation
7767
+ #
7768
+ class MetricFilterV2 < Struct.new(
7769
+ :metric_filter_key,
7770
+ :metric_filter_values)
7771
+ SENSITIVE = []
7772
+ include Aws::Structure
7773
+ end
7774
+
7775
+ # Contains information about the metric results.
7776
+ #
7777
+ # @!attribute [rw] dimensions
7778
+ # The dimension for the metrics.
7779
+ # @return [Hash<String,String>]
7780
+ #
7781
+ # @!attribute [rw] collections
7782
+ # The set of metrics.
7783
+ # @return [Array<Types::MetricDataV2>]
7784
+ #
7785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricResultV2 AWS API Documentation
7786
+ #
7787
+ class MetricResultV2 < Struct.new(
7788
+ :dimensions,
7789
+ :collections)
7790
+ SENSITIVE = []
7791
+ include Aws::Structure
7792
+ end
7793
+
7794
+ # Contains information about the metric.
7795
+ #
7796
+ # @!attribute [rw] name
7797
+ # The name of the metric.
7798
+ # @return [String]
7799
+ #
7800
+ # @!attribute [rw] threshold
7801
+ # Contains information about the threshold for service level metrics.
7802
+ # @return [Array<Types::ThresholdV2>]
7803
+ #
7804
+ # @!attribute [rw] metric_filters
7805
+ # Contains the filters to be used when returning data.
7806
+ # @return [Array<Types::MetricFilterV2>]
7807
+ #
7808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricV2 AWS API Documentation
7809
+ #
7810
+ class MetricV2 < Struct.new(
7811
+ :name,
7812
+ :threshold,
7813
+ :metric_filters)
7814
+ SENSITIVE = []
7815
+ include Aws::Structure
7816
+ end
7817
+
7355
7818
  # @!attribute [rw] instance_id
7356
7819
  # The identifier of the Amazon Connect instance. You can find the
7357
7820
  # instanceId in the ARN of the instance.
@@ -10467,6 +10930,26 @@ module Aws::Connect
10467
10930
  include Aws::Structure
10468
10931
  end
10469
10932
 
10933
+ # Contains information about the threshold for service level metrics.
10934
+ #
10935
+ # @!attribute [rw] comparison
10936
+ # The type of comparison. Only "less than" (LT) comparisons are
10937
+ # supported.
10938
+ # @return [String]
10939
+ #
10940
+ # @!attribute [rw] threshold_value
10941
+ # The threshold value to compare.
10942
+ # @return [Float]
10943
+ #
10944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ThresholdV2 AWS API Documentation
10945
+ #
10946
+ class ThresholdV2 < Struct.new(
10947
+ :comparison,
10948
+ :threshold_value)
10949
+ SENSITIVE = []
10950
+ include Aws::Structure
10951
+ end
10952
+
10470
10953
  # The throttling limit has been exceeded.
10471
10954
  #
10472
10955
  # @!attribute [rw] message
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connect/customizations'
52
52
  # @!group service
53
53
  module Aws::Connect
54
54
 
55
- GEM_VERSION = '1.98.0'
55
+ GEM_VERSION = '1.99.0'
56
56
 
57
57
  end
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.98.0
4
+ version: 1.99.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: 2023-02-24 00:00:00.000000000 Z
11
+ date: 2023-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core