aws-sdk-connect 1.269.0 → 1.270.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +563 -3
- data/lib/aws-sdk-connect/client_api.rb +337 -0
- data/lib/aws-sdk-connect/types.rb +782 -0
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +97 -0
- data/sig/params.rbs +74 -0
- data/sig/types.rbs +193 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f99f40bd0a180018843111405c3713cc44ac4e5a7d637011382d2df3aa0e6041
|
|
4
|
+
data.tar.gz: 8901cfc8df0a7c4a6bad81e76cefa9f7ddf5199691dfa41b96a8b609e030a07d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ed27750ae82550e627e0609067def7f067c05f0ace1455257731d8a575234b32574cd92c6fdb393eb875bd117990ef41f9b830f38cd7116fd8645ff9bc87a34f
|
|
7
|
+
data.tar.gz: c316f22e8c2138a80eca09df797e4c2e1452e3cc71adee176b2e11a49b5f0e763be331ee3247954ac25a6e61bebcdfe76c2dd5437d27957eb244c39b58796610
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.270.0 (2026-08-11)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Seven new APIs for managing custom metrics, including create, describe, update, and delete. Using Custom Metrics, customers of Amazon Connect Customer can tailor analytics dashboards to their needs by applying custom thresholds, filters, and calculations to one or more out of the box measurements.
|
|
8
|
+
|
|
4
9
|
1.269.0 (2026-08-10)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.270.0
|
|
@@ -4072,6 +4072,120 @@ module Aws::Connect
|
|
|
4072
4072
|
req.send_request(options)
|
|
4073
4073
|
end
|
|
4074
4074
|
|
|
4075
|
+
# Creates a new metric definition for the specified Connect Customer
|
|
4076
|
+
# instance. You can create custom metrics that use formulas referencing
|
|
4077
|
+
# existing Amazon Web Services-managed metrics, optionally with filters
|
|
4078
|
+
# applied.
|
|
4079
|
+
#
|
|
4080
|
+
# @option params [required, String] :instance_id
|
|
4081
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
4082
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
4083
|
+
#
|
|
4084
|
+
#
|
|
4085
|
+
#
|
|
4086
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
4087
|
+
#
|
|
4088
|
+
# @option params [required, String] :name
|
|
4089
|
+
# The name of the metric.
|
|
4090
|
+
#
|
|
4091
|
+
# @option params [required, Types::MetricCalculation] :metric_calculation
|
|
4092
|
+
# The calculation definition for the metric, including the formula
|
|
4093
|
+
# expression and the component metrics it references.
|
|
4094
|
+
#
|
|
4095
|
+
# @option params [required, String] :unit
|
|
4096
|
+
# The display unit for the metric's data.
|
|
4097
|
+
#
|
|
4098
|
+
# @option params [String] :status
|
|
4099
|
+
# The publish status of the metric. Set to `PUBLISHED` to make the
|
|
4100
|
+
# metric available for use in dashboards and reports, or `SAVED` to keep
|
|
4101
|
+
# it in draft state.
|
|
4102
|
+
#
|
|
4103
|
+
# @option params [String] :client_token
|
|
4104
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
4105
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
4106
|
+
# SDK populates this field. For more information about idempotency, see
|
|
4107
|
+
# [Making retries safe with idempotent APIs][1].
|
|
4108
|
+
#
|
|
4109
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
4110
|
+
# not need to pass this option.**
|
|
4111
|
+
#
|
|
4112
|
+
#
|
|
4113
|
+
#
|
|
4114
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
4115
|
+
#
|
|
4116
|
+
# @option params [String] :description
|
|
4117
|
+
# The description of the metric.
|
|
4118
|
+
#
|
|
4119
|
+
# @option params [String] :positive_trend_indicator
|
|
4120
|
+
# How an increase in the metric value should be interpreted. Valid
|
|
4121
|
+
# values: `POSITIVE`, `NEUTRAL`, `NEGATIVE`.
|
|
4122
|
+
#
|
|
4123
|
+
# @option params [Hash<String,String>] :tags
|
|
4124
|
+
# The tags used to organize, track, or control access for this resource.
|
|
4125
|
+
# For example, \{ "Tags": \{"key1":"value1", "key2":"value2"}
|
|
4126
|
+
# }.
|
|
4127
|
+
#
|
|
4128
|
+
# @return [Types::CreateMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4129
|
+
#
|
|
4130
|
+
# * {Types::CreateMetricResponse#metric_arn #metric_arn} => String
|
|
4131
|
+
# * {Types::CreateMetricResponse#metric_id #metric_id} => String
|
|
4132
|
+
#
|
|
4133
|
+
# @example Request syntax with placeholder values
|
|
4134
|
+
#
|
|
4135
|
+
# resp = client.create_metric({
|
|
4136
|
+
# instance_id: "InstanceId", # required
|
|
4137
|
+
# name: "MetricName", # required
|
|
4138
|
+
# metric_calculation: { # required
|
|
4139
|
+
# calculation_components: [ # required
|
|
4140
|
+
# {
|
|
4141
|
+
# alias: "ComponentAlias", # required
|
|
4142
|
+
# metric_name: "MetricName",
|
|
4143
|
+
# metric_id: "MetricId",
|
|
4144
|
+
# metric_filters: [
|
|
4145
|
+
# {
|
|
4146
|
+
# metric_filter_key: "MetricFilterKey", # required
|
|
4147
|
+
# negate: false,
|
|
4148
|
+
# number_condition: {
|
|
4149
|
+
# comparison: "LESSER", # required, accepts LESSER, LESSER_OR_EQUAL, GREATER, GREATER_OR_EQUAL
|
|
4150
|
+
# values: [1.0], # required
|
|
4151
|
+
# },
|
|
4152
|
+
# string_condition: {
|
|
4153
|
+
# comparison: "MATCHES_ANY", # required, accepts MATCHES_ANY, MATCHES_NONE
|
|
4154
|
+
# values: ["String"], # required
|
|
4155
|
+
# },
|
|
4156
|
+
# boolean_condition: {
|
|
4157
|
+
# comparison: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
|
4158
|
+
# },
|
|
4159
|
+
# },
|
|
4160
|
+
# ],
|
|
4161
|
+
# },
|
|
4162
|
+
# ],
|
|
4163
|
+
# calculation: "CalculationExpression", # required
|
|
4164
|
+
# },
|
|
4165
|
+
# unit: "INTEGER", # required, accepts INTEGER, DOUBLE, PERCENT, SECONDS
|
|
4166
|
+
# status: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
4167
|
+
# client_token: "ClientToken",
|
|
4168
|
+
# description: "MetricDescription",
|
|
4169
|
+
# positive_trend_indicator: "POSITIVE", # accepts POSITIVE, NEGATIVE, NEUTRAL
|
|
4170
|
+
# tags: {
|
|
4171
|
+
# "TagKey" => "TagValue",
|
|
4172
|
+
# },
|
|
4173
|
+
# })
|
|
4174
|
+
#
|
|
4175
|
+
# @example Response structure
|
|
4176
|
+
#
|
|
4177
|
+
# resp.metric_arn #=> String
|
|
4178
|
+
# resp.metric_id #=> String
|
|
4179
|
+
#
|
|
4180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateMetric AWS API Documentation
|
|
4181
|
+
#
|
|
4182
|
+
# @overload create_metric(params = {})
|
|
4183
|
+
# @param [Hash] params ({})
|
|
4184
|
+
def create_metric(params = {}, options = {})
|
|
4185
|
+
req = build_request(:create_metric, params)
|
|
4186
|
+
req.send_request(options)
|
|
4187
|
+
end
|
|
4188
|
+
|
|
4075
4189
|
# Creates a new notification to be delivered to specified recipients.
|
|
4076
4190
|
# Notifications can include localized content with links, and an
|
|
4077
4191
|
# optional expiration time. Recipients can be specified as individual
|
|
@@ -6893,6 +7007,39 @@ module Aws::Connect
|
|
|
6893
7007
|
req.send_request(options)
|
|
6894
7008
|
end
|
|
6895
7009
|
|
|
7010
|
+
# Deletes an existing metric from the specified Connect Customer
|
|
7011
|
+
# instance. This operation fails with `ResourceConflictException` if the
|
|
7012
|
+
# metric is currently in use in a dashboard.
|
|
7013
|
+
#
|
|
7014
|
+
# @option params [required, String] :instance_id
|
|
7015
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
7016
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
7017
|
+
#
|
|
7018
|
+
#
|
|
7019
|
+
#
|
|
7020
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
7021
|
+
#
|
|
7022
|
+
# @option params [required, String] :metric_id
|
|
7023
|
+
# The identifier of the metric to delete.
|
|
7024
|
+
#
|
|
7025
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
7026
|
+
#
|
|
7027
|
+
# @example Request syntax with placeholder values
|
|
7028
|
+
#
|
|
7029
|
+
# resp = client.delete_metric({
|
|
7030
|
+
# instance_id: "InstanceId", # required
|
|
7031
|
+
# metric_id: "MetricId", # required
|
|
7032
|
+
# })
|
|
7033
|
+
#
|
|
7034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteMetric AWS API Documentation
|
|
7035
|
+
#
|
|
7036
|
+
# @overload delete_metric(params = {})
|
|
7037
|
+
# @param [Hash] params ({})
|
|
7038
|
+
def delete_metric(params = {}, options = {})
|
|
7039
|
+
req = build_request(:delete_metric, params)
|
|
7040
|
+
req.send_request(options)
|
|
7041
|
+
end
|
|
7042
|
+
|
|
6896
7043
|
# Deletes a notification. Once deleted, the notification is no longer
|
|
6897
7044
|
# visible to all users and cannot be managed through the Admin Website
|
|
6898
7045
|
# or APIs.
|
|
@@ -9034,6 +9181,93 @@ module Aws::Connect
|
|
|
9034
9181
|
req.send_request(options)
|
|
9035
9182
|
end
|
|
9036
9183
|
|
|
9184
|
+
# Retrieves the full definition of an existing metric from the specified
|
|
9185
|
+
# Connect Customer instance.
|
|
9186
|
+
#
|
|
9187
|
+
# @option params [required, String] :instance_id
|
|
9188
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
9189
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
9190
|
+
#
|
|
9191
|
+
#
|
|
9192
|
+
#
|
|
9193
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
9194
|
+
#
|
|
9195
|
+
# @option params [required, String] :metric_id
|
|
9196
|
+
# The identifier of the metric to describe. Adding the `$SAVED`
|
|
9197
|
+
# qualifier will describe the saved version of the metric. Adding
|
|
9198
|
+
# `$LATEST` or omitting a qualifier will describe the published version.
|
|
9199
|
+
#
|
|
9200
|
+
# @return [Types::DescribeMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
9201
|
+
#
|
|
9202
|
+
# * {Types::DescribeMetricResponse#metric #metric} => Types::MetricDefinition
|
|
9203
|
+
#
|
|
9204
|
+
# @example Request syntax with placeholder values
|
|
9205
|
+
#
|
|
9206
|
+
# resp = client.describe_metric({
|
|
9207
|
+
# instance_id: "InstanceId", # required
|
|
9208
|
+
# metric_id: "MetricId", # required
|
|
9209
|
+
# })
|
|
9210
|
+
#
|
|
9211
|
+
# @example Response structure
|
|
9212
|
+
#
|
|
9213
|
+
# resp.metric.arn #=> String
|
|
9214
|
+
# resp.metric.id #=> String
|
|
9215
|
+
# resp.metric.name #=> String
|
|
9216
|
+
# resp.metric.description #=> String
|
|
9217
|
+
# resp.metric.metric_calculation.calculation_components #=> Array
|
|
9218
|
+
# resp.metric.metric_calculation.calculation_components[0].alias #=> String
|
|
9219
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_name #=> String
|
|
9220
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_id #=> String
|
|
9221
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters #=> Array
|
|
9222
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].metric_filter_key #=> String
|
|
9223
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].negate #=> Boolean
|
|
9224
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.comparison #=> String, one of "LESSER", "LESSER_OR_EQUAL", "GREATER", "GREATER_OR_EQUAL"
|
|
9225
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.values #=> Array
|
|
9226
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.values[0] #=> Float
|
|
9227
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.comparison #=> String, one of "MATCHES_ANY", "MATCHES_NONE"
|
|
9228
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.values #=> Array
|
|
9229
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.values[0] #=> String
|
|
9230
|
+
# resp.metric.metric_calculation.calculation_components[0].metric_filters[0].boolean_condition.comparison #=> String, one of "IS_TRUE", "IS_FALSE"
|
|
9231
|
+
# resp.metric.metric_calculation.calculation #=> String
|
|
9232
|
+
# resp.metric.creation_method #=> String, one of "SERVICE_LEVEL_BUILDER", "METRIC_BUILDER"
|
|
9233
|
+
# resp.metric.status #=> String, one of "PUBLISHED", "SAVED"
|
|
9234
|
+
# resp.metric.type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
|
|
9235
|
+
# resp.metric.unit #=> String, one of "INTEGER", "DOUBLE", "PERCENT", "SECONDS"
|
|
9236
|
+
# resp.metric.positive_trend_indicator #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
|
|
9237
|
+
# resp.metric.groupings #=> Array
|
|
9238
|
+
# resp.metric.groupings[0] #=> String
|
|
9239
|
+
# resp.metric.filters #=> Array
|
|
9240
|
+
# resp.metric.filters[0].id #=> String
|
|
9241
|
+
# resp.metric.filters[0].type #=> String, one of "METRIC_LEVEL", "RESOURCE_LEVEL"
|
|
9242
|
+
# resp.metric.effective_time #=> Time
|
|
9243
|
+
# resp.metric.refresh_rate #=> Integer
|
|
9244
|
+
# resp.metric.category #=> String
|
|
9245
|
+
# resp.metric.supported_stats #=> Array
|
|
9246
|
+
# resp.metric.supported_stats[0] #=> String
|
|
9247
|
+
# resp.metric.default_stat #=> String
|
|
9248
|
+
# resp.metric.supports_preaggregate_calculation #=> Boolean
|
|
9249
|
+
# resp.metric.supports_custom_calculation #=> Boolean
|
|
9250
|
+
# resp.metric.primary_event_source #=> String
|
|
9251
|
+
# resp.metric.primary_event_source_effective_timestamp_type #=> String
|
|
9252
|
+
# resp.metric.created_time #=> Time
|
|
9253
|
+
# resp.metric.created_user.connect_user_arn #=> String
|
|
9254
|
+
# resp.metric.created_user.aws_identity_arn #=> String
|
|
9255
|
+
# resp.metric.last_modified_region #=> String
|
|
9256
|
+
# resp.metric.last_modified_time #=> Time
|
|
9257
|
+
# resp.metric.last_modified_user.connect_user_arn #=> String
|
|
9258
|
+
# resp.metric.last_modified_user.aws_identity_arn #=> String
|
|
9259
|
+
# resp.metric.tags #=> Hash
|
|
9260
|
+
# resp.metric.tags["TagKey"] #=> String
|
|
9261
|
+
#
|
|
9262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeMetric AWS API Documentation
|
|
9263
|
+
#
|
|
9264
|
+
# @overload describe_metric(params = {})
|
|
9265
|
+
# @param [Hash] params ({})
|
|
9266
|
+
def describe_metric(params = {}, options = {})
|
|
9267
|
+
req = build_request(:describe_metric, params)
|
|
9268
|
+
req.send_request(options)
|
|
9269
|
+
end
|
|
9270
|
+
|
|
9037
9271
|
# Retrieves detailed information about a specific notification,
|
|
9038
9272
|
# including its content, priority, recipients, and metadata.
|
|
9039
9273
|
#
|
|
@@ -17120,6 +17354,67 @@ module Aws::Connect
|
|
|
17120
17354
|
req.send_request(options)
|
|
17121
17355
|
end
|
|
17122
17356
|
|
|
17357
|
+
# Retrieves a paginated list of metric summaries for the specified
|
|
17358
|
+
# Connect Customer instance. Use pagination to ensure that the operation
|
|
17359
|
+
# returns quickly and successfully.
|
|
17360
|
+
#
|
|
17361
|
+
# @option params [required, String] :instance_id
|
|
17362
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
17363
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
17364
|
+
#
|
|
17365
|
+
#
|
|
17366
|
+
#
|
|
17367
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
17368
|
+
#
|
|
17369
|
+
# @option params [String] :type
|
|
17370
|
+
# The type of metrics to list. Valid values: `AWS_MANAGED` \|
|
|
17371
|
+
# `CUSTOMER_MANAGED`.
|
|
17372
|
+
#
|
|
17373
|
+
# @option params [Integer] :max_results
|
|
17374
|
+
# The maximum number of results to return per page.
|
|
17375
|
+
#
|
|
17376
|
+
# @option params [String] :next_token
|
|
17377
|
+
# The token for the next set of results. Use the value returned in the
|
|
17378
|
+
# previous response in the next request to retrieve the next set of
|
|
17379
|
+
# results.
|
|
17380
|
+
#
|
|
17381
|
+
# @return [Types::ListMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17382
|
+
#
|
|
17383
|
+
# * {Types::ListMetricsResponse#metric_summary_list #metric_summary_list} => Array<Types::MetricSummary>
|
|
17384
|
+
# * {Types::ListMetricsResponse#next_token #next_token} => String
|
|
17385
|
+
#
|
|
17386
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17387
|
+
#
|
|
17388
|
+
# @example Request syntax with placeholder values
|
|
17389
|
+
#
|
|
17390
|
+
# resp = client.list_metrics({
|
|
17391
|
+
# instance_id: "InstanceId", # required
|
|
17392
|
+
# type: "AWS_MANAGED", # accepts AWS_MANAGED, CUSTOMER_MANAGED
|
|
17393
|
+
# max_results: 1,
|
|
17394
|
+
# next_token: "NextToken",
|
|
17395
|
+
# })
|
|
17396
|
+
#
|
|
17397
|
+
# @example Response structure
|
|
17398
|
+
#
|
|
17399
|
+
# resp.metric_summary_list #=> Array
|
|
17400
|
+
# resp.metric_summary_list[0].arn #=> String
|
|
17401
|
+
# resp.metric_summary_list[0].id #=> String
|
|
17402
|
+
# resp.metric_summary_list[0].name #=> String
|
|
17403
|
+
# resp.metric_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
|
|
17404
|
+
# resp.metric_summary_list[0].type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
|
|
17405
|
+
# resp.metric_summary_list[0].last_modified_region #=> String
|
|
17406
|
+
# resp.metric_summary_list[0].last_modified_time #=> Time
|
|
17407
|
+
# resp.next_token #=> String
|
|
17408
|
+
#
|
|
17409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListMetrics AWS API Documentation
|
|
17410
|
+
#
|
|
17411
|
+
# @overload list_metrics(params = {})
|
|
17412
|
+
# @param [Hash] params ({})
|
|
17413
|
+
def list_metrics(params = {}, options = {})
|
|
17414
|
+
req = build_request(:list_metrics, params)
|
|
17415
|
+
req.send_request(options)
|
|
17416
|
+
end
|
|
17417
|
+
|
|
17123
17418
|
# Retrieves a paginated list of all notifications in the Amazon Connect
|
|
17124
17419
|
# instance.
|
|
17125
17420
|
#
|
|
@@ -21235,6 +21530,154 @@ module Aws::Connect
|
|
|
21235
21530
|
req.send_request(options)
|
|
21236
21531
|
end
|
|
21237
21532
|
|
|
21533
|
+
# Searches for metrics in the specified Connect Customer instance using
|
|
21534
|
+
# search criteria and optional tag-based filters. Use pagination to
|
|
21535
|
+
# ensure that the operation returns quickly and successfully.
|
|
21536
|
+
#
|
|
21537
|
+
# @option params [required, String] :instance_id
|
|
21538
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
21539
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
21540
|
+
#
|
|
21541
|
+
#
|
|
21542
|
+
#
|
|
21543
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
21544
|
+
#
|
|
21545
|
+
# @option params [String] :next_token
|
|
21546
|
+
# The token for the next set of results. Use the value returned in the
|
|
21547
|
+
# previous response in the next request to retrieve the next set of
|
|
21548
|
+
# results.
|
|
21549
|
+
#
|
|
21550
|
+
# @option params [Integer] :max_results
|
|
21551
|
+
# The maximum number of results to return per page.
|
|
21552
|
+
#
|
|
21553
|
+
# @option params [Types::MetricSearchFilter] :search_filter
|
|
21554
|
+
# Filters to be applied to search results.
|
|
21555
|
+
#
|
|
21556
|
+
# @option params [Types::MetricSearchCriteria] :search_criteria
|
|
21557
|
+
# The search criteria to filter the metrics.
|
|
21558
|
+
#
|
|
21559
|
+
# @return [Types::SearchMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
21560
|
+
#
|
|
21561
|
+
# * {Types::SearchMetricsResponse#metrics #metrics} => Array<Types::MetricDefinition>
|
|
21562
|
+
# * {Types::SearchMetricsResponse#next_token #next_token} => String
|
|
21563
|
+
# * {Types::SearchMetricsResponse#approximate_total_count #approximate_total_count} => Integer
|
|
21564
|
+
#
|
|
21565
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
21566
|
+
#
|
|
21567
|
+
# @example Request syntax with placeholder values
|
|
21568
|
+
#
|
|
21569
|
+
# resp = client.search_metrics({
|
|
21570
|
+
# instance_id: "InstanceId", # required
|
|
21571
|
+
# next_token: "NextToken",
|
|
21572
|
+
# max_results: 1,
|
|
21573
|
+
# search_filter: {
|
|
21574
|
+
# tag_filter: {
|
|
21575
|
+
# or_conditions: [
|
|
21576
|
+
# [
|
|
21577
|
+
# {
|
|
21578
|
+
# tag_key: "String",
|
|
21579
|
+
# tag_value: "String",
|
|
21580
|
+
# },
|
|
21581
|
+
# ],
|
|
21582
|
+
# ],
|
|
21583
|
+
# and_conditions: [
|
|
21584
|
+
# {
|
|
21585
|
+
# tag_key: "String",
|
|
21586
|
+
# tag_value: "String",
|
|
21587
|
+
# },
|
|
21588
|
+
# ],
|
|
21589
|
+
# tag_condition: {
|
|
21590
|
+
# tag_key: "String",
|
|
21591
|
+
# tag_value: "String",
|
|
21592
|
+
# },
|
|
21593
|
+
# },
|
|
21594
|
+
# },
|
|
21595
|
+
# search_criteria: {
|
|
21596
|
+
# or_conditions: [
|
|
21597
|
+
# {
|
|
21598
|
+
# # recursive MetricSearchCriteria
|
|
21599
|
+
# },
|
|
21600
|
+
# ],
|
|
21601
|
+
# and_conditions: [
|
|
21602
|
+
# {
|
|
21603
|
+
# # recursive MetricSearchCriteria
|
|
21604
|
+
# },
|
|
21605
|
+
# ],
|
|
21606
|
+
# string_condition: {
|
|
21607
|
+
# field_name: "String",
|
|
21608
|
+
# value: "String",
|
|
21609
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
21610
|
+
# },
|
|
21611
|
+
# boolean_condition: {
|
|
21612
|
+
# field_name: "String",
|
|
21613
|
+
# comparison_type: "IS_TRUE", # accepts IS_TRUE, IS_FALSE
|
|
21614
|
+
# },
|
|
21615
|
+
# },
|
|
21616
|
+
# })
|
|
21617
|
+
#
|
|
21618
|
+
# @example Response structure
|
|
21619
|
+
#
|
|
21620
|
+
# resp.metrics #=> Array
|
|
21621
|
+
# resp.metrics[0].arn #=> String
|
|
21622
|
+
# resp.metrics[0].id #=> String
|
|
21623
|
+
# resp.metrics[0].name #=> String
|
|
21624
|
+
# resp.metrics[0].description #=> String
|
|
21625
|
+
# resp.metrics[0].metric_calculation.calculation_components #=> Array
|
|
21626
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].alias #=> String
|
|
21627
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_name #=> String
|
|
21628
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_id #=> String
|
|
21629
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters #=> Array
|
|
21630
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].metric_filter_key #=> String
|
|
21631
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].negate #=> Boolean
|
|
21632
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.comparison #=> String, one of "LESSER", "LESSER_OR_EQUAL", "GREATER", "GREATER_OR_EQUAL"
|
|
21633
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.values #=> Array
|
|
21634
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.values[0] #=> Float
|
|
21635
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.comparison #=> String, one of "MATCHES_ANY", "MATCHES_NONE"
|
|
21636
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.values #=> Array
|
|
21637
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.values[0] #=> String
|
|
21638
|
+
# resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].boolean_condition.comparison #=> String, one of "IS_TRUE", "IS_FALSE"
|
|
21639
|
+
# resp.metrics[0].metric_calculation.calculation #=> String
|
|
21640
|
+
# resp.metrics[0].creation_method #=> String, one of "SERVICE_LEVEL_BUILDER", "METRIC_BUILDER"
|
|
21641
|
+
# resp.metrics[0].status #=> String, one of "PUBLISHED", "SAVED"
|
|
21642
|
+
# resp.metrics[0].type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
|
|
21643
|
+
# resp.metrics[0].unit #=> String, one of "INTEGER", "DOUBLE", "PERCENT", "SECONDS"
|
|
21644
|
+
# resp.metrics[0].positive_trend_indicator #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
|
|
21645
|
+
# resp.metrics[0].groupings #=> Array
|
|
21646
|
+
# resp.metrics[0].groupings[0] #=> String
|
|
21647
|
+
# resp.metrics[0].filters #=> Array
|
|
21648
|
+
# resp.metrics[0].filters[0].id #=> String
|
|
21649
|
+
# resp.metrics[0].filters[0].type #=> String, one of "METRIC_LEVEL", "RESOURCE_LEVEL"
|
|
21650
|
+
# resp.metrics[0].effective_time #=> Time
|
|
21651
|
+
# resp.metrics[0].refresh_rate #=> Integer
|
|
21652
|
+
# resp.metrics[0].category #=> String
|
|
21653
|
+
# resp.metrics[0].supported_stats #=> Array
|
|
21654
|
+
# resp.metrics[0].supported_stats[0] #=> String
|
|
21655
|
+
# resp.metrics[0].default_stat #=> String
|
|
21656
|
+
# resp.metrics[0].supports_preaggregate_calculation #=> Boolean
|
|
21657
|
+
# resp.metrics[0].supports_custom_calculation #=> Boolean
|
|
21658
|
+
# resp.metrics[0].primary_event_source #=> String
|
|
21659
|
+
# resp.metrics[0].primary_event_source_effective_timestamp_type #=> String
|
|
21660
|
+
# resp.metrics[0].created_time #=> Time
|
|
21661
|
+
# resp.metrics[0].created_user.connect_user_arn #=> String
|
|
21662
|
+
# resp.metrics[0].created_user.aws_identity_arn #=> String
|
|
21663
|
+
# resp.metrics[0].last_modified_region #=> String
|
|
21664
|
+
# resp.metrics[0].last_modified_time #=> Time
|
|
21665
|
+
# resp.metrics[0].last_modified_user.connect_user_arn #=> String
|
|
21666
|
+
# resp.metrics[0].last_modified_user.aws_identity_arn #=> String
|
|
21667
|
+
# resp.metrics[0].tags #=> Hash
|
|
21668
|
+
# resp.metrics[0].tags["TagKey"] #=> String
|
|
21669
|
+
# resp.next_token #=> String
|
|
21670
|
+
# resp.approximate_total_count #=> Integer
|
|
21671
|
+
#
|
|
21672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchMetrics AWS API Documentation
|
|
21673
|
+
#
|
|
21674
|
+
# @overload search_metrics(params = {})
|
|
21675
|
+
# @param [Hash] params ({})
|
|
21676
|
+
def search_metrics(params = {}, options = {})
|
|
21677
|
+
req = build_request(:search_metrics, params)
|
|
21678
|
+
req.send_request(options)
|
|
21679
|
+
end
|
|
21680
|
+
|
|
21238
21681
|
# Searches for notifications based on specified criteria and filters.
|
|
21239
21682
|
# Returns a paginated list of notifications matching the search
|
|
21240
21683
|
# parameters, ordered by descending creation time. Supports filtering by
|
|
@@ -21812,6 +22255,8 @@ module Aws::Connect
|
|
|
21812
22255
|
#
|
|
21813
22256
|
# * transfer-destination (also known as quick connect)
|
|
21814
22257
|
#
|
|
22258
|
+
# * metric
|
|
22259
|
+
#
|
|
21815
22260
|
# @option params [String] :next_token
|
|
21816
22261
|
# The token for the next set of results. Use the value returned in the
|
|
21817
22262
|
# previous response in the next request to retrieve the next set of
|
|
@@ -25753,8 +26198,8 @@ module Aws::Connect
|
|
|
25753
26198
|
#
|
|
25754
26199
|
# Some of the supported resource types are agents, routing profiles,
|
|
25755
26200
|
# queues, quick connects, flows, agent statuses, hours of operation,
|
|
25756
|
-
# phone numbers, security profiles,
|
|
25757
|
-
# list, see [Tagging resources in Connect Customer][1].
|
|
26201
|
+
# phone numbers, security profiles, task templates, and custom metrics.
|
|
26202
|
+
# For a complete list, see [Tagging resources in Connect Customer][1].
|
|
25758
26203
|
#
|
|
25759
26204
|
# For sample policies that use tags, see [Connect Customer
|
|
25760
26205
|
# Identity-Based Policy Examples][2] in the *Connect Customer
|
|
@@ -27858,6 +28303,121 @@ module Aws::Connect
|
|
|
27858
28303
|
req.send_request(options)
|
|
27859
28304
|
end
|
|
27860
28305
|
|
|
28306
|
+
# Updates the calculation, unit, and/or trend indicator of an existing
|
|
28307
|
+
# metric in the specified Connect Customer instance.
|
|
28308
|
+
#
|
|
28309
|
+
# @option params [required, String] :instance_id
|
|
28310
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
28311
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
28312
|
+
#
|
|
28313
|
+
#
|
|
28314
|
+
#
|
|
28315
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
28316
|
+
#
|
|
28317
|
+
# @option params [required, String] :metric_id
|
|
28318
|
+
# The identifier of the metric to update. Adding the `$SAVED` qualifier
|
|
28319
|
+
# will update the saved version of the metric. Adding `$LATEST` or
|
|
28320
|
+
# omitting a qualifier will update the published version.
|
|
28321
|
+
#
|
|
28322
|
+
# @option params [Types::MetricCalculation] :metric_calculation
|
|
28323
|
+
# The updated calculation definition for the metric.
|
|
28324
|
+
#
|
|
28325
|
+
# @option params [String] :unit
|
|
28326
|
+
# The updated display unit for the metric.
|
|
28327
|
+
#
|
|
28328
|
+
# @option params [String] :positive_trend_indicator
|
|
28329
|
+
# How an increase in the metric value should be interpreted. Valid
|
|
28330
|
+
# values: `POSITIVE`, `NEUTRAL`, `NEGATIVE`.
|
|
28331
|
+
#
|
|
28332
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
28333
|
+
#
|
|
28334
|
+
# @example Request syntax with placeholder values
|
|
28335
|
+
#
|
|
28336
|
+
# resp = client.update_metric_content({
|
|
28337
|
+
# instance_id: "InstanceId", # required
|
|
28338
|
+
# metric_id: "MetricId", # required
|
|
28339
|
+
# metric_calculation: {
|
|
28340
|
+
# calculation_components: [ # required
|
|
28341
|
+
# {
|
|
28342
|
+
# alias: "ComponentAlias", # required
|
|
28343
|
+
# metric_name: "MetricName",
|
|
28344
|
+
# metric_id: "MetricId",
|
|
28345
|
+
# metric_filters: [
|
|
28346
|
+
# {
|
|
28347
|
+
# metric_filter_key: "MetricFilterKey", # required
|
|
28348
|
+
# negate: false,
|
|
28349
|
+
# number_condition: {
|
|
28350
|
+
# comparison: "LESSER", # required, accepts LESSER, LESSER_OR_EQUAL, GREATER, GREATER_OR_EQUAL
|
|
28351
|
+
# values: [1.0], # required
|
|
28352
|
+
# },
|
|
28353
|
+
# string_condition: {
|
|
28354
|
+
# comparison: "MATCHES_ANY", # required, accepts MATCHES_ANY, MATCHES_NONE
|
|
28355
|
+
# values: ["String"], # required
|
|
28356
|
+
# },
|
|
28357
|
+
# boolean_condition: {
|
|
28358
|
+
# comparison: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
|
|
28359
|
+
# },
|
|
28360
|
+
# },
|
|
28361
|
+
# ],
|
|
28362
|
+
# },
|
|
28363
|
+
# ],
|
|
28364
|
+
# calculation: "CalculationExpression", # required
|
|
28365
|
+
# },
|
|
28366
|
+
# unit: "INTEGER", # accepts INTEGER, DOUBLE, PERCENT, SECONDS
|
|
28367
|
+
# positive_trend_indicator: "POSITIVE", # accepts POSITIVE, NEGATIVE, NEUTRAL
|
|
28368
|
+
# })
|
|
28369
|
+
#
|
|
28370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateMetricContent AWS API Documentation
|
|
28371
|
+
#
|
|
28372
|
+
# @overload update_metric_content(params = {})
|
|
28373
|
+
# @param [Hash] params ({})
|
|
28374
|
+
def update_metric_content(params = {}, options = {})
|
|
28375
|
+
req = build_request(:update_metric_content, params)
|
|
28376
|
+
req.send_request(options)
|
|
28377
|
+
end
|
|
28378
|
+
|
|
28379
|
+
# Updates the name and/or description of an existing metric in the
|
|
28380
|
+
# specified Connect Customer instance.
|
|
28381
|
+
#
|
|
28382
|
+
# @option params [required, String] :instance_id
|
|
28383
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
28384
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
28385
|
+
#
|
|
28386
|
+
#
|
|
28387
|
+
#
|
|
28388
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
28389
|
+
#
|
|
28390
|
+
# @option params [required, String] :metric_id
|
|
28391
|
+
# The identifier of the metric to update. Adding the `$SAVED` qualifier
|
|
28392
|
+
# will update the saved version of the metric. Adding `$LATEST` or
|
|
28393
|
+
# omitting a qualifier will update the published version.
|
|
28394
|
+
#
|
|
28395
|
+
# @option params [String] :name
|
|
28396
|
+
# The updated name of the metric.
|
|
28397
|
+
#
|
|
28398
|
+
# @option params [String] :description
|
|
28399
|
+
# The updated description of the metric.
|
|
28400
|
+
#
|
|
28401
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
28402
|
+
#
|
|
28403
|
+
# @example Request syntax with placeholder values
|
|
28404
|
+
#
|
|
28405
|
+
# resp = client.update_metric_metadata({
|
|
28406
|
+
# instance_id: "InstanceId", # required
|
|
28407
|
+
# metric_id: "MetricId", # required
|
|
28408
|
+
# name: "MetricName",
|
|
28409
|
+
# description: "MetricDescription",
|
|
28410
|
+
# })
|
|
28411
|
+
#
|
|
28412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateMetricMetadata AWS API Documentation
|
|
28413
|
+
#
|
|
28414
|
+
# @overload update_metric_metadata(params = {})
|
|
28415
|
+
# @param [Hash] params ({})
|
|
28416
|
+
def update_metric_metadata(params = {}, options = {})
|
|
28417
|
+
req = build_request(:update_metric_metadata, params)
|
|
28418
|
+
req.send_request(options)
|
|
28419
|
+
end
|
|
28420
|
+
|
|
27861
28421
|
# Updates the localized content of an existing notification. This
|
|
27862
28422
|
# operation applies to all users for whom the notification was sent.
|
|
27863
28423
|
#
|
|
@@ -30291,7 +30851,7 @@ module Aws::Connect
|
|
|
30291
30851
|
tracer: tracer
|
|
30292
30852
|
)
|
|
30293
30853
|
context[:gem_name] = 'aws-sdk-connect'
|
|
30294
|
-
context[:gem_version] = '1.
|
|
30854
|
+
context[:gem_version] = '1.270.0'
|
|
30295
30855
|
Seahorse::Client::Request.new(handlers, context)
|
|
30296
30856
|
end
|
|
30297
30857
|
|