aws-sdk-connect 1.127.0 → 1.129.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +115 -37
- data/lib/aws-sdk-connect/client_api.rb +15 -0
- data/lib/aws-sdk-connect/types.rb +217 -23
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 31decf9eea36ce0b7cf6764fc2f4564eaa64bc58bc77a21c63ab008289174b85
|
4
|
+
data.tar.gz: f8309e2f83d518e27e216bd1260f749873bbf4ae781eb6e156059567b50b5432
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bbc6189991f6ddd7d1fd04dfc3fe492dcda85a16531cf8cf3c81a0affbc2c054652083bdb4f2846412c53bf631aac961b73fcbb21a2181b198c0e46fbdd53790
|
7
|
+
data.tar.gz: bd95d68caaa1ac40e88be4e12e7f1ba42f2f2e9e3e1a01477a13d2c4206f6f102453008b47d41793d82042f8e965bf67bc299abd87d684cbc161171f00310c59
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.129.0 (2023-10-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - GetMetricDataV2 API: Update to include new metrics CONTACTS_RESOLVED_IN_X , AVG_HOLD_TIME_ALL_CONTACTS , AVG_RESOLUTION_TIME , ABANDONMENT_RATE , AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS with added features: Interval Period, TimeZone, Negate MetricFilters, Extended date time range.
|
8
|
+
|
9
|
+
1.128.0 (2023-09-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.127.0 (2023-09-26)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.129.0
|
@@ -1111,7 +1111,15 @@ module Aws::Connect
|
|
1111
1111
|
# The description of the flow.
|
1112
1112
|
#
|
1113
1113
|
# @option params [required, String] :content
|
1114
|
-
# The content of the flow.
|
1114
|
+
# The JSON string that represents the content of the flow. For an
|
1115
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
1116
|
+
# language][1].
|
1117
|
+
#
|
1118
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
#
|
1122
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1115
1123
|
#
|
1116
1124
|
# @option params [Hash<String,String>] :tags
|
1117
1125
|
# The tags used to organize, track, or control access for this resource.
|
@@ -2076,9 +2084,6 @@ module Aws::Connect
|
|
2076
2084
|
req.send_request(options)
|
2077
2085
|
end
|
2078
2086
|
|
2079
|
-
# This API is in preview release for Amazon Connect and is subject to
|
2080
|
-
# change.
|
2081
|
-
#
|
2082
2087
|
# Creates a security profile.
|
2083
2088
|
#
|
2084
2089
|
# @option params [required, String] :security_profile_name
|
@@ -3268,9 +3273,6 @@ module Aws::Connect
|
|
3268
3273
|
req.send_request(options)
|
3269
3274
|
end
|
3270
3275
|
|
3271
|
-
# This API is in preview release for Amazon Connect and is subject to
|
3272
|
-
# change.
|
3273
|
-
#
|
3274
3276
|
# Deletes a security profile.
|
3275
3277
|
#
|
3276
3278
|
# @option params [required, String] :instance_id
|
@@ -4474,9 +4476,6 @@ module Aws::Connect
|
|
4474
4476
|
req.send_request(options)
|
4475
4477
|
end
|
4476
4478
|
|
4477
|
-
# This API is in preview release for Amazon Connect and is subject to
|
4478
|
-
# change.
|
4479
|
-
#
|
4480
4479
|
# Gets basic information about the security profle.
|
4481
4480
|
#
|
4482
4481
|
# @option params [required, String] :security_profile_id
|
@@ -6012,8 +6011,8 @@ module Aws::Connect
|
|
6012
6011
|
# previous version of this API. It has new metrics, offers filtering at
|
6013
6012
|
# a metric level, and offers the ability to filter and group data by
|
6014
6013
|
# channels, queues, routing profiles, agents, and agent hierarchy
|
6015
|
-
# levels. It can retrieve historical data for the last
|
6016
|
-
#
|
6014
|
+
# levels. It can retrieve historical data for the last 3 months, at
|
6015
|
+
# varying intervals.
|
6017
6016
|
#
|
6018
6017
|
# For a description of the historical metrics that are supported by
|
6019
6018
|
# `GetMetricDataV2` and `GetMetricData`, see [Historical metrics
|
@@ -6031,10 +6030,10 @@ module Aws::Connect
|
|
6031
6030
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
6032
6031
|
# The timestamp, in UNIX Epoch time format, at which to start the
|
6033
6032
|
# reporting interval for the retrieval of historical metrics data. The
|
6034
|
-
# time must be before the end time timestamp. The
|
6035
|
-
#
|
6036
|
-
#
|
6037
|
-
#
|
6033
|
+
# time must be before the end time timestamp. The start and end time
|
6034
|
+
# depends on the `IntervalPeriod` selected. By default the time range
|
6035
|
+
# between start and end time is 35 days. Historical metrics are
|
6036
|
+
# available for 3 months.
|
6038
6037
|
#
|
6039
6038
|
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
6040
6039
|
# The timestamp, in UNIX Epoch time format, at which to end the
|
@@ -6042,8 +6041,41 @@ module Aws::Connect
|
|
6042
6041
|
# time must be later than the start time timestamp. It cannot be later
|
6043
6042
|
# than the current timestamp.
|
6044
6043
|
#
|
6045
|
-
#
|
6046
|
-
#
|
6044
|
+
# @option params [Types::IntervalDetails] :interval
|
6045
|
+
# The interval period and timezone to apply to returned metrics.
|
6046
|
+
#
|
6047
|
+
# * `IntervalPeriod`: An aggregated grouping applied to request metrics.
|
6048
|
+
# Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \| `THIRTY_MIN` \|
|
6049
|
+
# `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
6050
|
+
#
|
6051
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
6052
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
6053
|
+
# returns 48 results in the response. Each result is aggregated by the
|
6054
|
+
# THIRTY\_MIN period. By default Amazon Connect aggregates results
|
6055
|
+
# based on the `TOTAL` interval period.
|
6056
|
+
#
|
6057
|
+
# The following list describes restrictions on `StartTime` and
|
6058
|
+
# `EndTime` based on which `IntervalPeriod` is requested.
|
6059
|
+
#
|
6060
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
6061
|
+
# must be less than 3 days.
|
6062
|
+
#
|
6063
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
6064
|
+
# must be less than 3 days.
|
6065
|
+
#
|
6066
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
6067
|
+
# less than 3 days.
|
6068
|
+
#
|
6069
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
6070
|
+
# less than 35 days.
|
6071
|
+
#
|
6072
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
6073
|
+
# less than 35 days.
|
6074
|
+
#
|
6075
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must be
|
6076
|
+
# less than 35 days.
|
6077
|
+
#
|
6078
|
+
# * `TimeZone`: The timezone applied to requested metrics.
|
6047
6079
|
#
|
6048
6080
|
# @option params [required, Array<Types::FilterV2>] :filters
|
6049
6081
|
# The filters to apply to returned metrics. You can filter on the
|
@@ -6110,6 +6142,13 @@ module Aws::Connect
|
|
6110
6142
|
# description of each metric, see [Historical metrics definitions][1] in
|
6111
6143
|
# the *Amazon Connect Administrator's Guide*.
|
6112
6144
|
#
|
6145
|
+
# ABANDONMENT\_RATE
|
6146
|
+
#
|
6147
|
+
# : Unit: Percent
|
6148
|
+
#
|
6149
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6150
|
+
# Agent Hierarchy
|
6151
|
+
#
|
6113
6152
|
# AGENT\_ADHERENT\_TIME
|
6114
6153
|
#
|
6115
6154
|
# : This metric is available only in Amazon Web Services Regions where
|
@@ -6127,6 +6166,16 @@ module Aws::Connect
|
|
6127
6166
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6128
6167
|
# Agent Hierarchy
|
6129
6168
|
#
|
6169
|
+
# AGENT\_NON\_RESPONSE\_WITHOUT\_CUSTOMER\_ABANDONS
|
6170
|
+
#
|
6171
|
+
# : Unit: Count
|
6172
|
+
#
|
6173
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6174
|
+
# Agent Hierarchy
|
6175
|
+
#
|
6176
|
+
# Data for this metric is available starting from October 1, 2023
|
6177
|
+
# 0:00:00 GMT.
|
6178
|
+
#
|
6130
6179
|
# AGENT\_OCCUPANCY
|
6131
6180
|
#
|
6132
6181
|
# : Unit: Percentage
|
@@ -6182,16 +6231,10 @@ module Aws::Connect
|
|
6182
6231
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6183
6232
|
# Agent Hierarchy
|
6184
6233
|
#
|
6185
|
-
#
|
6186
|
-
#
|
6187
|
-
# : Unit: Seconds
|
6188
|
-
#
|
6189
|
-
# Valid metric filter key: `INITIATION_METHOD`. For now, this metric
|
6190
|
-
# only supports the following as `INITIATION_METHOD`: `INBOUND` \|
|
6191
|
-
# `OUTBOUND` \| `CALLBACK` \| `API`
|
6234
|
+
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
|
6235
|
+
# metric.
|
6192
6236
|
#
|
6193
|
-
#
|
6194
|
-
# Agent Hierarchy
|
6237
|
+
# </note>
|
6195
6238
|
#
|
6196
6239
|
# AVG\_CONTACT\_DURATION
|
6197
6240
|
#
|
@@ -6243,6 +6286,13 @@ module Aws::Connect
|
|
6243
6286
|
#
|
6244
6287
|
# </note>
|
6245
6288
|
#
|
6289
|
+
# AVG\_HOLD\_TIME\_ALL\_CONTACTS
|
6290
|
+
#
|
6291
|
+
# : Unit: Seconds
|
6292
|
+
#
|
6293
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6294
|
+
# Agent Hierarchy
|
6295
|
+
#
|
6246
6296
|
# AVG\_HOLDS
|
6247
6297
|
#
|
6248
6298
|
# : Unit: Count
|
@@ -6313,6 +6363,12 @@ module Aws::Connect
|
|
6313
6363
|
#
|
6314
6364
|
# </note>
|
6315
6365
|
#
|
6366
|
+
# AVG\_RESOLUTION\_TIME
|
6367
|
+
#
|
6368
|
+
# : Unit: Seconds
|
6369
|
+
#
|
6370
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6371
|
+
#
|
6316
6372
|
# AVG\_TALK\_TIME
|
6317
6373
|
#
|
6318
6374
|
# : This metric is available only for contacts analyzed by Contact Lens
|
@@ -6390,6 +6446,16 @@ module Aws::Connect
|
|
6390
6446
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6391
6447
|
# Agent Hierarchy
|
6392
6448
|
#
|
6449
|
+
# CONTACTS\_RESOLVED\_IN\_X
|
6450
|
+
#
|
6451
|
+
# : Unit: Count
|
6452
|
+
#
|
6453
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6454
|
+
#
|
6455
|
+
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
6456
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
6457
|
+
# `LT` (for "Less than").
|
6458
|
+
#
|
6393
6459
|
# CONTACTS\_TRANSFERRED\_OUT
|
6394
6460
|
#
|
6395
6461
|
# : Unit: Count
|
@@ -6494,6 +6560,10 @@ module Aws::Connect
|
|
6494
6560
|
# resource_arn: "ARN", # required
|
6495
6561
|
# start_time: Time.now, # required
|
6496
6562
|
# end_time: Time.now, # required
|
6563
|
+
# interval: {
|
6564
|
+
# time_zone: "String",
|
6565
|
+
# interval_period: "FIFTEEN_MIN", # accepts FIFTEEN_MIN, THIRTY_MIN, HOUR, DAY, WEEK, TOTAL
|
6566
|
+
# },
|
6497
6567
|
# filters: [ # required
|
6498
6568
|
# {
|
6499
6569
|
# filter_key: "ResourceArnOrId",
|
@@ -6514,6 +6584,7 @@ module Aws::Connect
|
|
6514
6584
|
# {
|
6515
6585
|
# metric_filter_key: "String",
|
6516
6586
|
# metric_filter_values: ["String"],
|
6587
|
+
# negate: false,
|
6517
6588
|
# },
|
6518
6589
|
# ],
|
6519
6590
|
# },
|
@@ -6528,6 +6599,9 @@ module Aws::Connect
|
|
6528
6599
|
# resp.metric_results #=> Array
|
6529
6600
|
# resp.metric_results[0].dimensions #=> Hash
|
6530
6601
|
# resp.metric_results[0].dimensions["DimensionsV2Key"] #=> String
|
6602
|
+
# resp.metric_results[0].metric_interval.interval #=> String, one of "FIFTEEN_MIN", "THIRTY_MIN", "HOUR", "DAY", "WEEK", "TOTAL"
|
6603
|
+
# resp.metric_results[0].metric_interval.start_time #=> Time
|
6604
|
+
# resp.metric_results[0].metric_interval.end_time #=> Time
|
6531
6605
|
# resp.metric_results[0].collections #=> Array
|
6532
6606
|
# resp.metric_results[0].collections[0].metric.name #=> String
|
6533
6607
|
# resp.metric_results[0].collections[0].metric.threshold #=> Array
|
@@ -6537,6 +6611,7 @@ module Aws::Connect
|
|
6537
6611
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
|
6538
6612
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
|
6539
6613
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values[0] #=> String
|
6614
|
+
# resp.metric_results[0].collections[0].metric.metric_filters[0].negate #=> Boolean
|
6540
6615
|
# resp.metric_results[0].collections[0].value #=> Float
|
6541
6616
|
#
|
6542
6617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2 AWS API Documentation
|
@@ -8421,9 +8496,6 @@ module Aws::Connect
|
|
8421
8496
|
req.send_request(options)
|
8422
8497
|
end
|
8423
8498
|
|
8424
|
-
# This API is in preview release for Amazon Connect and is subject to
|
8425
|
-
# change.
|
8426
|
-
#
|
8427
8499
|
# Lists the permissions granted to a security profile.
|
8428
8500
|
#
|
8429
8501
|
# @option params [required, String] :security_profile_id
|
@@ -11555,8 +11627,11 @@ module Aws::Connect
|
|
11555
11627
|
# The identifier of the flow.
|
11556
11628
|
#
|
11557
11629
|
# @option params [required, String] :content
|
11558
|
-
# The JSON string that represents
|
11559
|
-
# [Example contact flow in Amazon Connect Flow
|
11630
|
+
# The JSON string that represents the content of the flow. For an
|
11631
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
11632
|
+
# language][1].
|
11633
|
+
#
|
11634
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
11560
11635
|
#
|
11561
11636
|
#
|
11562
11637
|
#
|
@@ -11639,7 +11714,13 @@ module Aws::Connect
|
|
11639
11714
|
# The identifier of the flow module.
|
11640
11715
|
#
|
11641
11716
|
# @option params [required, String] :content
|
11642
|
-
# The content of the flow
|
11717
|
+
# The JSON string that represents the content of the flow. For an
|
11718
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
11719
|
+
# language][1].
|
11720
|
+
#
|
11721
|
+
#
|
11722
|
+
#
|
11723
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
11643
11724
|
#
|
11644
11725
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
11645
11726
|
#
|
@@ -12904,9 +12985,6 @@ module Aws::Connect
|
|
12904
12985
|
req.send_request(options)
|
12905
12986
|
end
|
12906
12987
|
|
12907
|
-
# This API is in preview release for Amazon Connect and is subject to
|
12908
|
-
# change.
|
12909
|
-
#
|
12910
12988
|
# Updates a security profile.
|
12911
12989
|
#
|
12912
12990
|
# @option params [String] :description
|
@@ -13600,7 +13678,7 @@ module Aws::Connect
|
|
13600
13678
|
params: params,
|
13601
13679
|
config: config)
|
13602
13680
|
context[:gem_name] = 'aws-sdk-connect'
|
13603
|
-
context[:gem_version] = '1.
|
13681
|
+
context[:gem_version] = '1.129.0'
|
13604
13682
|
Seahorse::Client::Request.new(handlers, context)
|
13605
13683
|
end
|
13606
13684
|
|
@@ -445,6 +445,8 @@ module Aws::Connect
|
|
445
445
|
IntegrationAssociationSummaryList = Shapes::ListShape.new(name: 'IntegrationAssociationSummaryList')
|
446
446
|
IntegrationType = Shapes::StringShape.new(name: 'IntegrationType')
|
447
447
|
InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
|
448
|
+
IntervalDetails = Shapes::StructureShape.new(name: 'IntervalDetails')
|
449
|
+
IntervalPeriod = Shapes::StringShape.new(name: 'IntervalPeriod')
|
448
450
|
InvalidContactFlowException = Shapes::StructureShape.new(name: 'InvalidContactFlowException')
|
449
451
|
InvalidContactFlowModuleException = Shapes::StructureShape.new(name: 'InvalidContactFlowModuleException')
|
450
452
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
@@ -562,6 +564,7 @@ module Aws::Connect
|
|
562
564
|
MetricFilterV2 = Shapes::StructureShape.new(name: 'MetricFilterV2')
|
563
565
|
MetricFilterValueList = Shapes::ListShape.new(name: 'MetricFilterValueList')
|
564
566
|
MetricFiltersV2List = Shapes::ListShape.new(name: 'MetricFiltersV2List')
|
567
|
+
MetricInterval = Shapes::StructureShape.new(name: 'MetricInterval')
|
565
568
|
MetricNameV2 = Shapes::StringShape.new(name: 'MetricNameV2')
|
566
569
|
MetricResultV2 = Shapes::StructureShape.new(name: 'MetricResultV2')
|
567
570
|
MetricResultsV2 = Shapes::ListShape.new(name: 'MetricResultsV2')
|
@@ -2234,6 +2237,7 @@ module Aws::Connect
|
|
2234
2237
|
GetMetricDataV2Request.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "ResourceArn"))
|
2235
2238
|
GetMetricDataV2Request.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartTime"))
|
2236
2239
|
GetMetricDataV2Request.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndTime"))
|
2240
|
+
GetMetricDataV2Request.add_member(:interval, Shapes::ShapeRef.new(shape: IntervalDetails, location_name: "Interval"))
|
2237
2241
|
GetMetricDataV2Request.add_member(:filters, Shapes::ShapeRef.new(shape: FiltersV2List, required: true, location_name: "Filters"))
|
2238
2242
|
GetMetricDataV2Request.add_member(:groupings, Shapes::ShapeRef.new(shape: GroupingsV2, location_name: "Groupings"))
|
2239
2243
|
GetMetricDataV2Request.add_member(:metrics, Shapes::ShapeRef.new(shape: MetricsV2, required: true, location_name: "Metrics"))
|
@@ -2462,6 +2466,10 @@ module Aws::Connect
|
|
2462
2466
|
InternalServiceException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
2463
2467
|
InternalServiceException.struct_class = Types::InternalServiceException
|
2464
2468
|
|
2469
|
+
IntervalDetails.add_member(:time_zone, Shapes::ShapeRef.new(shape: String, location_name: "TimeZone"))
|
2470
|
+
IntervalDetails.add_member(:interval_period, Shapes::ShapeRef.new(shape: IntervalPeriod, location_name: "IntervalPeriod"))
|
2471
|
+
IntervalDetails.struct_class = Types::IntervalDetails
|
2472
|
+
|
2465
2473
|
InvalidContactFlowException.add_member(:problems, Shapes::ShapeRef.new(shape: Problems, location_name: "problems"))
|
2466
2474
|
InvalidContactFlowException.struct_class = Types::InvalidContactFlowException
|
2467
2475
|
|
@@ -2910,13 +2918,20 @@ module Aws::Connect
|
|
2910
2918
|
|
2911
2919
|
MetricFilterV2.add_member(:metric_filter_key, Shapes::ShapeRef.new(shape: String, location_name: "MetricFilterKey"))
|
2912
2920
|
MetricFilterV2.add_member(:metric_filter_values, Shapes::ShapeRef.new(shape: MetricFilterValueList, location_name: "MetricFilterValues"))
|
2921
|
+
MetricFilterV2.add_member(:negate, Shapes::ShapeRef.new(shape: Boolean, location_name: "Negate"))
|
2913
2922
|
MetricFilterV2.struct_class = Types::MetricFilterV2
|
2914
2923
|
|
2915
2924
|
MetricFilterValueList.member = Shapes::ShapeRef.new(shape: String)
|
2916
2925
|
|
2917
2926
|
MetricFiltersV2List.member = Shapes::ShapeRef.new(shape: MetricFilterV2)
|
2918
2927
|
|
2928
|
+
MetricInterval.add_member(:interval, Shapes::ShapeRef.new(shape: IntervalPeriod, location_name: "Interval"))
|
2929
|
+
MetricInterval.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartTime"))
|
2930
|
+
MetricInterval.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
2931
|
+
MetricInterval.struct_class = Types::MetricInterval
|
2932
|
+
|
2919
2933
|
MetricResultV2.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionsV2Map, location_name: "Dimensions"))
|
2934
|
+
MetricResultV2.add_member(:metric_interval, Shapes::ShapeRef.new(shape: MetricInterval, location_name: "MetricInterval"))
|
2920
2935
|
MetricResultV2.add_member(:collections, Shapes::ShapeRef.new(shape: MetricDataCollectionsV2, location_name: "Collections"))
|
2921
2936
|
MetricResultV2.struct_class = Types::MetricResultV2
|
2922
2937
|
|
@@ -1105,7 +1105,13 @@ module Aws::Connect
|
|
1105
1105
|
# @return [String]
|
1106
1106
|
#
|
1107
1107
|
# @!attribute [rw] content
|
1108
|
-
# The content of the flow.
|
1108
|
+
# The JSON string that represents the content of the flow. For an
|
1109
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
1110
|
+
# language][1].
|
1111
|
+
#
|
1112
|
+
#
|
1113
|
+
#
|
1114
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1109
1115
|
# @return [String]
|
1110
1116
|
#
|
1111
1117
|
# @!attribute [rw] tags
|
@@ -1144,7 +1150,15 @@ module Aws::Connect
|
|
1144
1150
|
# @return [String]
|
1145
1151
|
#
|
1146
1152
|
# @!attribute [rw] content
|
1147
|
-
# The content of the flow
|
1153
|
+
# The JSON string that represents the content of the flow. For an
|
1154
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
1155
|
+
# language][1].
|
1156
|
+
#
|
1157
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1158
|
+
#
|
1159
|
+
#
|
1160
|
+
#
|
1161
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1148
1162
|
# @return [String]
|
1149
1163
|
#
|
1150
1164
|
# @!attribute [rw] description
|
@@ -1466,7 +1480,15 @@ module Aws::Connect
|
|
1466
1480
|
# @return [String]
|
1467
1481
|
#
|
1468
1482
|
# @!attribute [rw] content
|
1469
|
-
# The content of the flow.
|
1483
|
+
# The JSON string that represents the content of the flow. For an
|
1484
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
1485
|
+
# language][1].
|
1486
|
+
#
|
1487
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1488
|
+
#
|
1489
|
+
#
|
1490
|
+
#
|
1491
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1470
1492
|
# @return [String]
|
1471
1493
|
#
|
1472
1494
|
# @!attribute [rw] tags
|
@@ -6339,10 +6361,10 @@ module Aws::Connect
|
|
6339
6361
|
# @!attribute [rw] start_time
|
6340
6362
|
# The timestamp, in UNIX Epoch time format, at which to start the
|
6341
6363
|
# reporting interval for the retrieval of historical metrics data. The
|
6342
|
-
# time must be before the end time timestamp. The
|
6343
|
-
#
|
6344
|
-
#
|
6345
|
-
#
|
6364
|
+
# time must be before the end time timestamp. The start and end time
|
6365
|
+
# depends on the `IntervalPeriod` selected. By default the time range
|
6366
|
+
# between start and end time is 35 days. Historical metrics are
|
6367
|
+
# available for 3 months.
|
6346
6368
|
# @return [Time]
|
6347
6369
|
#
|
6348
6370
|
# @!attribute [rw] end_time
|
@@ -6350,11 +6372,45 @@ module Aws::Connect
|
|
6350
6372
|
# reporting interval for the retrieval of historical metrics data. The
|
6351
6373
|
# time must be later than the start time timestamp. It cannot be later
|
6352
6374
|
# than the current timestamp.
|
6353
|
-
#
|
6354
|
-
# The time range between the start and end time must be less than 24
|
6355
|
-
# hours.
|
6356
6375
|
# @return [Time]
|
6357
6376
|
#
|
6377
|
+
# @!attribute [rw] interval
|
6378
|
+
# The interval period and timezone to apply to returned metrics.
|
6379
|
+
#
|
6380
|
+
# * `IntervalPeriod`: An aggregated grouping applied to request
|
6381
|
+
# metrics. Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \|
|
6382
|
+
# `THIRTY_MIN` \| `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
6383
|
+
#
|
6384
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
6385
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
6386
|
+
# returns 48 results in the response. Each result is aggregated by
|
6387
|
+
# the THIRTY\_MIN period. By default Amazon Connect aggregates
|
6388
|
+
# results based on the `TOTAL` interval period.
|
6389
|
+
#
|
6390
|
+
# The following list describes restrictions on `StartTime` and
|
6391
|
+
# `EndTime` based on which `IntervalPeriod` is requested.
|
6392
|
+
#
|
6393
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
6394
|
+
# must be less than 3 days.
|
6395
|
+
#
|
6396
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
6397
|
+
# must be less than 3 days.
|
6398
|
+
#
|
6399
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
6400
|
+
# less than 3 days.
|
6401
|
+
#
|
6402
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
6403
|
+
# less than 35 days.
|
6404
|
+
#
|
6405
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
6406
|
+
# less than 35 days.
|
6407
|
+
#
|
6408
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must
|
6409
|
+
# be less than 35 days.
|
6410
|
+
#
|
6411
|
+
# * `TimeZone`: The timezone applied to requested metrics.
|
6412
|
+
# @return [Types::IntervalDetails]
|
6413
|
+
#
|
6358
6414
|
# @!attribute [rw] filters
|
6359
6415
|
# The filters to apply to returned metrics. You can filter on the
|
6360
6416
|
# following resources:
|
@@ -6422,6 +6478,13 @@ module Aws::Connect
|
|
6422
6478
|
# a description of each metric, see [Historical metrics
|
6423
6479
|
# definitions][1] in the *Amazon Connect Administrator's Guide*.
|
6424
6480
|
#
|
6481
|
+
# ABANDONMENT\_RATE
|
6482
|
+
#
|
6483
|
+
# : Unit: Percent
|
6484
|
+
#
|
6485
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6486
|
+
# Agent, Agent Hierarchy
|
6487
|
+
#
|
6425
6488
|
# AGENT\_ADHERENT\_TIME
|
6426
6489
|
#
|
6427
6490
|
# : This metric is available only in Amazon Web Services Regions where
|
@@ -6439,6 +6502,16 @@ module Aws::Connect
|
|
6439
6502
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6440
6503
|
# Agent, Agent Hierarchy
|
6441
6504
|
#
|
6505
|
+
# AGENT\_NON\_RESPONSE\_WITHOUT\_CUSTOMER\_ABANDONS
|
6506
|
+
#
|
6507
|
+
# : Unit: Count
|
6508
|
+
#
|
6509
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6510
|
+
# Agent, Agent Hierarchy
|
6511
|
+
#
|
6512
|
+
# Data for this metric is available starting from October 1, 2023
|
6513
|
+
# 0:00:00 GMT.
|
6514
|
+
#
|
6442
6515
|
# AGENT\_OCCUPANCY
|
6443
6516
|
#
|
6444
6517
|
# : Unit: Percentage
|
@@ -6495,16 +6568,10 @@ module Aws::Connect
|
|
6495
6568
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6496
6569
|
# Agent, Agent Hierarchy
|
6497
6570
|
#
|
6498
|
-
#
|
6571
|
+
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
|
6572
|
+
# this metric.
|
6499
6573
|
#
|
6500
|
-
#
|
6501
|
-
#
|
6502
|
-
# Valid metric filter key: `INITIATION_METHOD`. For now, this metric
|
6503
|
-
# only supports the following as `INITIATION_METHOD`: `INBOUND` \|
|
6504
|
-
# `OUTBOUND` \| `CALLBACK` \| `API`
|
6505
|
-
#
|
6506
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6507
|
-
# Agent, Agent Hierarchy
|
6574
|
+
# </note>
|
6508
6575
|
#
|
6509
6576
|
# AVG\_CONTACT\_DURATION
|
6510
6577
|
#
|
@@ -6556,6 +6623,13 @@ module Aws::Connect
|
|
6556
6623
|
#
|
6557
6624
|
# </note>
|
6558
6625
|
#
|
6626
|
+
# AVG\_HOLD\_TIME\_ALL\_CONTACTS
|
6627
|
+
#
|
6628
|
+
# : Unit: Seconds
|
6629
|
+
#
|
6630
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6631
|
+
# Agent, Agent Hierarchy
|
6632
|
+
#
|
6559
6633
|
# AVG\_HOLDS
|
6560
6634
|
#
|
6561
6635
|
# : Unit: Count
|
@@ -6626,6 +6700,12 @@ module Aws::Connect
|
|
6626
6700
|
#
|
6627
6701
|
# </note>
|
6628
6702
|
#
|
6703
|
+
# AVG\_RESOLUTION\_TIME
|
6704
|
+
#
|
6705
|
+
# : Unit: Seconds
|
6706
|
+
#
|
6707
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6708
|
+
#
|
6629
6709
|
# AVG\_TALK\_TIME
|
6630
6710
|
#
|
6631
6711
|
# : This metric is available only for contacts analyzed by Contact
|
@@ -6703,6 +6783,16 @@ module Aws::Connect
|
|
6703
6783
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6704
6784
|
# Agent, Agent Hierarchy
|
6705
6785
|
#
|
6786
|
+
# CONTACTS\_RESOLVED\_IN\_X
|
6787
|
+
#
|
6788
|
+
# : Unit: Count
|
6789
|
+
#
|
6790
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6791
|
+
#
|
6792
|
+
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
6793
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
6794
|
+
# `LT` (for "Less than").
|
6795
|
+
#
|
6706
6796
|
# CONTACTS\_TRANSFERRED\_OUT
|
6707
6797
|
#
|
6708
6798
|
# : Unit: Count
|
@@ -6803,6 +6893,7 @@ module Aws::Connect
|
|
6803
6893
|
:resource_arn,
|
6804
6894
|
:start_time,
|
6805
6895
|
:end_time,
|
6896
|
+
:interval,
|
6806
6897
|
:filters,
|
6807
6898
|
:groupings,
|
6808
6899
|
:metrics,
|
@@ -7812,6 +7903,54 @@ module Aws::Connect
|
|
7812
7903
|
include Aws::Structure
|
7813
7904
|
end
|
7814
7905
|
|
7906
|
+
# Information about the interval period to use for returning results.
|
7907
|
+
#
|
7908
|
+
# @!attribute [rw] time_zone
|
7909
|
+
# The timezone applied to requested metrics.
|
7910
|
+
# @return [String]
|
7911
|
+
#
|
7912
|
+
# @!attribute [rw] interval_period
|
7913
|
+
# `IntervalPeriod`: An aggregated grouping applied to request metrics.
|
7914
|
+
# Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \| `THIRTY_MIN` \|
|
7915
|
+
# `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
7916
|
+
#
|
7917
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
7918
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
7919
|
+
# returns 48 results in the response. Each result is aggregated by the
|
7920
|
+
# THIRTY\_MIN period. By default Amazon Connect aggregates results
|
7921
|
+
# based on the `TOTAL` interval period.
|
7922
|
+
#
|
7923
|
+
# The following list describes restrictions on `StartTime` and
|
7924
|
+
# `EndTime` based on what `IntervalPeriod` is requested.
|
7925
|
+
#
|
7926
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
7927
|
+
# must be less than 3 days.
|
7928
|
+
#
|
7929
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
7930
|
+
# must be less than 3 days.
|
7931
|
+
#
|
7932
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
7933
|
+
# less than 3 days.
|
7934
|
+
#
|
7935
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
7936
|
+
# less than 35 days.
|
7937
|
+
#
|
7938
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
7939
|
+
# less than 35 days.
|
7940
|
+
#
|
7941
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must be
|
7942
|
+
# less than 35 days.
|
7943
|
+
# @return [String]
|
7944
|
+
#
|
7945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/IntervalDetails AWS API Documentation
|
7946
|
+
#
|
7947
|
+
class IntervalDetails < Struct.new(
|
7948
|
+
:time_zone,
|
7949
|
+
:interval_period)
|
7950
|
+
SENSITIVE = []
|
7951
|
+
include Aws::Structure
|
7952
|
+
end
|
7953
|
+
|
7815
7954
|
# The flow is not valid.
|
7816
7955
|
#
|
7817
7956
|
# @!attribute [rw] problems
|
@@ -9476,6 +9615,9 @@ module Aws::Connect
|
|
9476
9615
|
end
|
9477
9616
|
|
9478
9617
|
# @!attribute [rw] applications
|
9618
|
+
# This API is in preview release for Amazon Connect and is subject to
|
9619
|
+
# change.
|
9620
|
+
#
|
9479
9621
|
# A list of the third party application's metadata.
|
9480
9622
|
# @return [Array<Types::Application>]
|
9481
9623
|
#
|
@@ -10142,11 +10284,49 @@ module Aws::Connect
|
|
10142
10284
|
# `CONTACT_FLOW_DISCONNECT` \| `OTHER` \| `EXPIRED` \| `API`
|
10143
10285
|
# @return [Array<String>]
|
10144
10286
|
#
|
10287
|
+
# @!attribute [rw] negate
|
10288
|
+
# The flag to use to filter on requested metric filter values or to
|
10289
|
+
# not filter on requested metric filter values. By default the negate
|
10290
|
+
# is `false`, which indicates to filter on the requested metric
|
10291
|
+
# filter.
|
10292
|
+
# @return [Boolean]
|
10293
|
+
#
|
10145
10294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricFilterV2 AWS API Documentation
|
10146
10295
|
#
|
10147
10296
|
class MetricFilterV2 < Struct.new(
|
10148
10297
|
:metric_filter_key,
|
10149
|
-
:metric_filter_values
|
10298
|
+
:metric_filter_values,
|
10299
|
+
:negate)
|
10300
|
+
SENSITIVE = []
|
10301
|
+
include Aws::Structure
|
10302
|
+
end
|
10303
|
+
|
10304
|
+
# The interval period with the start and end time for the metrics.
|
10305
|
+
#
|
10306
|
+
# @!attribute [rw] interval
|
10307
|
+
# The interval period provided in the API request.
|
10308
|
+
# @return [String]
|
10309
|
+
#
|
10310
|
+
# @!attribute [rw] start_time
|
10311
|
+
# The timestamp, in UNIX Epoch time format. Start time is based on the
|
10312
|
+
# interval period selected.
|
10313
|
+
# @return [Time]
|
10314
|
+
#
|
10315
|
+
# @!attribute [rw] end_time
|
10316
|
+
# The timestamp, in UNIX Epoch time format. End time is based on the
|
10317
|
+
# interval period selected. For example, If `IntervalPeriod` is
|
10318
|
+
# selected `THIRTY_MIN`, `StartTime` and `EndTime` in the API request
|
10319
|
+
# differs by 1 day, then 48 results are returned in the response. Each
|
10320
|
+
# result is aggregated by the 30 minutes period, with each `StartTime`
|
10321
|
+
# and `EndTime` differing by 30 minutes.
|
10322
|
+
# @return [Time]
|
10323
|
+
#
|
10324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricInterval AWS API Documentation
|
10325
|
+
#
|
10326
|
+
class MetricInterval < Struct.new(
|
10327
|
+
:interval,
|
10328
|
+
:start_time,
|
10329
|
+
:end_time)
|
10150
10330
|
SENSITIVE = []
|
10151
10331
|
include Aws::Structure
|
10152
10332
|
end
|
@@ -10157,6 +10337,10 @@ module Aws::Connect
|
|
10157
10337
|
# The dimension for the metrics.
|
10158
10338
|
# @return [Hash<String,String>]
|
10159
10339
|
#
|
10340
|
+
# @!attribute [rw] metric_interval
|
10341
|
+
# The interval period with the start and end time for the metrics.
|
10342
|
+
# @return [Types::MetricInterval]
|
10343
|
+
#
|
10160
10344
|
# @!attribute [rw] collections
|
10161
10345
|
# The set of metrics.
|
10162
10346
|
# @return [Array<Types::MetricDataV2>]
|
@@ -10165,6 +10349,7 @@ module Aws::Connect
|
|
10165
10349
|
#
|
10166
10350
|
class MetricResultV2 < Struct.new(
|
10167
10351
|
:dimensions,
|
10352
|
+
:metric_interval,
|
10168
10353
|
:collections)
|
10169
10354
|
SENSITIVE = []
|
10170
10355
|
include Aws::Structure
|
@@ -14509,8 +14694,11 @@ module Aws::Connect
|
|
14509
14694
|
# @return [String]
|
14510
14695
|
#
|
14511
14696
|
# @!attribute [rw] content
|
14512
|
-
# The JSON string that represents
|
14513
|
-
# [Example contact flow in Amazon Connect Flow
|
14697
|
+
# The JSON string that represents the content of the flow. For an
|
14698
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
14699
|
+
# language][1].
|
14700
|
+
#
|
14701
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
14514
14702
|
#
|
14515
14703
|
#
|
14516
14704
|
#
|
@@ -14586,7 +14774,13 @@ module Aws::Connect
|
|
14586
14774
|
# @return [String]
|
14587
14775
|
#
|
14588
14776
|
# @!attribute [rw] content
|
14589
|
-
# The content of the flow
|
14777
|
+
# The JSON string that represents the content of the flow. For an
|
14778
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
14779
|
+
# language][1].
|
14780
|
+
#
|
14781
|
+
#
|
14782
|
+
#
|
14783
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
14590
14784
|
# @return [String]
|
14591
14785
|
#
|
14592
14786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContentRequest AWS API Documentation
|
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.129.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-
|
11
|
+
date: 2023-10-03 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.
|
22
|
+
version: 3.184.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.
|
32
|
+
version: 3.184.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|