aws-sdk-connect 1.5.0 → 1.6.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/lib/aws-sdk-connect.rb +1 -1
- data/lib/aws-sdk-connect/client.rb +464 -11
- data/lib/aws-sdk-connect/client_api.rb +158 -0
- data/lib/aws-sdk-connect/types.rb +732 -6
- metadata +2 -2
@@ -20,13 +20,23 @@ module Aws::Connect
|
|
20
20
|
AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
|
21
21
|
Attributes = Shapes::MapShape.new(name: 'Attributes')
|
22
22
|
AutoAccept = Shapes::BooleanShape.new(name: 'AutoAccept')
|
23
|
+
Channel = Shapes::StringShape.new(name: 'Channel')
|
24
|
+
Channels = Shapes::ListShape.new(name: 'Channels')
|
23
25
|
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
|
26
|
+
Comparison = Shapes::StringShape.new(name: 'Comparison')
|
24
27
|
ContactFlowId = Shapes::StringShape.new(name: 'ContactFlowId')
|
25
28
|
ContactId = Shapes::StringShape.new(name: 'ContactId')
|
26
29
|
ContactNotFoundException = Shapes::StructureShape.new(name: 'ContactNotFoundException')
|
27
30
|
CreateUserRequest = Shapes::StructureShape.new(name: 'CreateUserRequest')
|
28
31
|
CreateUserResponse = Shapes::StructureShape.new(name: 'CreateUserResponse')
|
29
32
|
Credentials = Shapes::StructureShape.new(name: 'Credentials')
|
33
|
+
CurrentMetric = Shapes::StructureShape.new(name: 'CurrentMetric')
|
34
|
+
CurrentMetricData = Shapes::StructureShape.new(name: 'CurrentMetricData')
|
35
|
+
CurrentMetricDataCollections = Shapes::ListShape.new(name: 'CurrentMetricDataCollections')
|
36
|
+
CurrentMetricName = Shapes::StringShape.new(name: 'CurrentMetricName')
|
37
|
+
CurrentMetricResult = Shapes::StructureShape.new(name: 'CurrentMetricResult')
|
38
|
+
CurrentMetricResults = Shapes::ListShape.new(name: 'CurrentMetricResults')
|
39
|
+
CurrentMetrics = Shapes::ListShape.new(name: 'CurrentMetrics')
|
30
40
|
DeleteUserRequest = Shapes::StructureShape.new(name: 'DeleteUserRequest')
|
31
41
|
DescribeUserHierarchyGroupRequest = Shapes::StructureShape.new(name: 'DescribeUserHierarchyGroupRequest')
|
32
42
|
DescribeUserHierarchyGroupResponse = Shapes::StructureShape.new(name: 'DescribeUserHierarchyGroupResponse')
|
@@ -35,11 +45,19 @@ module Aws::Connect
|
|
35
45
|
DescribeUserRequest = Shapes::StructureShape.new(name: 'DescribeUserRequest')
|
36
46
|
DescribeUserResponse = Shapes::StructureShape.new(name: 'DescribeUserResponse')
|
37
47
|
DestinationNotAllowedException = Shapes::StructureShape.new(name: 'DestinationNotAllowedException')
|
48
|
+
Dimensions = Shapes::StructureShape.new(name: 'Dimensions')
|
38
49
|
DirectoryUserId = Shapes::StringShape.new(name: 'DirectoryUserId')
|
39
50
|
DuplicateResourceException = Shapes::StructureShape.new(name: 'DuplicateResourceException')
|
40
51
|
Email = Shapes::StringShape.new(name: 'Email')
|
52
|
+
Filters = Shapes::StructureShape.new(name: 'Filters')
|
53
|
+
GetCurrentMetricDataRequest = Shapes::StructureShape.new(name: 'GetCurrentMetricDataRequest')
|
54
|
+
GetCurrentMetricDataResponse = Shapes::StructureShape.new(name: 'GetCurrentMetricDataResponse')
|
41
55
|
GetFederationTokenRequest = Shapes::StructureShape.new(name: 'GetFederationTokenRequest')
|
42
56
|
GetFederationTokenResponse = Shapes::StructureShape.new(name: 'GetFederationTokenResponse')
|
57
|
+
GetMetricDataRequest = Shapes::StructureShape.new(name: 'GetMetricDataRequest')
|
58
|
+
GetMetricDataResponse = Shapes::StructureShape.new(name: 'GetMetricDataResponse')
|
59
|
+
Grouping = Shapes::StringShape.new(name: 'Grouping')
|
60
|
+
Groupings = Shapes::ListShape.new(name: 'Groupings')
|
43
61
|
HierarchyGroup = Shapes::StructureShape.new(name: 'HierarchyGroup')
|
44
62
|
HierarchyGroupId = Shapes::StringShape.new(name: 'HierarchyGroupId')
|
45
63
|
HierarchyGroupName = Shapes::StringShape.new(name: 'HierarchyGroupName')
|
@@ -50,6 +68,13 @@ module Aws::Connect
|
|
50
68
|
HierarchyLevelName = Shapes::StringShape.new(name: 'HierarchyLevelName')
|
51
69
|
HierarchyPath = Shapes::StructureShape.new(name: 'HierarchyPath')
|
52
70
|
HierarchyStructure = Shapes::StructureShape.new(name: 'HierarchyStructure')
|
71
|
+
HistoricalMetric = Shapes::StructureShape.new(name: 'HistoricalMetric')
|
72
|
+
HistoricalMetricData = Shapes::StructureShape.new(name: 'HistoricalMetricData')
|
73
|
+
HistoricalMetricDataCollections = Shapes::ListShape.new(name: 'HistoricalMetricDataCollections')
|
74
|
+
HistoricalMetricName = Shapes::StringShape.new(name: 'HistoricalMetricName')
|
75
|
+
HistoricalMetricResult = Shapes::StructureShape.new(name: 'HistoricalMetricResult')
|
76
|
+
HistoricalMetricResults = Shapes::ListShape.new(name: 'HistoricalMetricResults')
|
77
|
+
HistoricalMetrics = Shapes::ListShape.new(name: 'HistoricalMetrics')
|
53
78
|
InstanceId = Shapes::StringShape.new(name: 'InstanceId')
|
54
79
|
InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
|
55
80
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
@@ -63,6 +88,7 @@ module Aws::Connect
|
|
63
88
|
ListUserHierarchyGroupsResponse = Shapes::StructureShape.new(name: 'ListUserHierarchyGroupsResponse')
|
64
89
|
ListUsersRequest = Shapes::StructureShape.new(name: 'ListUsersRequest')
|
65
90
|
ListUsersResponse = Shapes::StructureShape.new(name: 'ListUsersResponse')
|
91
|
+
MaxResult100 = Shapes::IntegerShape.new(name: 'MaxResult100')
|
66
92
|
MaxResult1000 = Shapes::IntegerShape.new(name: 'MaxResult1000')
|
67
93
|
Message = Shapes::StringShape.new(name: 'Message')
|
68
94
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
@@ -71,6 +97,8 @@ module Aws::Connect
|
|
71
97
|
PhoneNumber = Shapes::StringShape.new(name: 'PhoneNumber')
|
72
98
|
PhoneType = Shapes::StringShape.new(name: 'PhoneType')
|
73
99
|
QueueId = Shapes::StringShape.new(name: 'QueueId')
|
100
|
+
QueueReference = Shapes::StructureShape.new(name: 'QueueReference')
|
101
|
+
Queues = Shapes::ListShape.new(name: 'Queues')
|
74
102
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
75
103
|
RoutingProfileId = Shapes::StringShape.new(name: 'RoutingProfileId')
|
76
104
|
RoutingProfileName = Shapes::StringShape.new(name: 'RoutingProfileName')
|
@@ -84,9 +112,13 @@ module Aws::Connect
|
|
84
112
|
SecurityToken = Shapes::StringShape.new(name: 'SecurityToken')
|
85
113
|
StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
|
86
114
|
StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
|
115
|
+
Statistic = Shapes::StringShape.new(name: 'Statistic')
|
87
116
|
StopContactRequest = Shapes::StructureShape.new(name: 'StopContactRequest')
|
88
117
|
StopContactResponse = Shapes::StructureShape.new(name: 'StopContactResponse')
|
118
|
+
Threshold = Shapes::StructureShape.new(name: 'Threshold')
|
119
|
+
ThresholdValue = Shapes::FloatShape.new(name: 'ThresholdValue')
|
89
120
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
121
|
+
Unit = Shapes::StringShape.new(name: 'Unit')
|
90
122
|
UpdateContactAttributesRequest = Shapes::StructureShape.new(name: 'UpdateContactAttributesRequest')
|
91
123
|
UpdateContactAttributesResponse = Shapes::StructureShape.new(name: 'UpdateContactAttributesResponse')
|
92
124
|
UpdateUserHierarchyRequest = Shapes::StructureShape.new(name: 'UpdateUserHierarchyRequest')
|
@@ -101,11 +133,14 @@ module Aws::Connect
|
|
101
133
|
UserPhoneConfig = Shapes::StructureShape.new(name: 'UserPhoneConfig')
|
102
134
|
UserSummary = Shapes::StructureShape.new(name: 'UserSummary')
|
103
135
|
UserSummaryList = Shapes::ListShape.new(name: 'UserSummaryList')
|
136
|
+
Value = Shapes::FloatShape.new(name: 'Value')
|
104
137
|
timestamp = Shapes::TimestampShape.new(name: 'timestamp')
|
105
138
|
|
106
139
|
Attributes.key = Shapes::ShapeRef.new(shape: AttributeName)
|
107
140
|
Attributes.value = Shapes::ShapeRef.new(shape: AttributeValue)
|
108
141
|
|
142
|
+
Channels.member = Shapes::ShapeRef.new(shape: Channel)
|
143
|
+
|
109
144
|
CreateUserRequest.add_member(:username, Shapes::ShapeRef.new(shape: AgentUsername, required: true, location_name: "Username"))
|
110
145
|
CreateUserRequest.add_member(:password, Shapes::ShapeRef.new(shape: Password, location_name: "Password"))
|
111
146
|
CreateUserRequest.add_member(:identity_info, Shapes::ShapeRef.new(shape: UserIdentityInfo, location_name: "IdentityInfo"))
|
@@ -127,6 +162,24 @@ module Aws::Connect
|
|
127
162
|
Credentials.add_member(:refresh_token_expiration, Shapes::ShapeRef.new(shape: timestamp, location_name: "RefreshTokenExpiration"))
|
128
163
|
Credentials.struct_class = Types::Credentials
|
129
164
|
|
165
|
+
CurrentMetric.add_member(:name, Shapes::ShapeRef.new(shape: CurrentMetricName, location_name: "Name"))
|
166
|
+
CurrentMetric.add_member(:unit, Shapes::ShapeRef.new(shape: Unit, location_name: "Unit"))
|
167
|
+
CurrentMetric.struct_class = Types::CurrentMetric
|
168
|
+
|
169
|
+
CurrentMetricData.add_member(:metric, Shapes::ShapeRef.new(shape: CurrentMetric, location_name: "Metric"))
|
170
|
+
CurrentMetricData.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "Value", metadata: {"box"=>true}))
|
171
|
+
CurrentMetricData.struct_class = Types::CurrentMetricData
|
172
|
+
|
173
|
+
CurrentMetricDataCollections.member = Shapes::ShapeRef.new(shape: CurrentMetricData)
|
174
|
+
|
175
|
+
CurrentMetricResult.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
|
176
|
+
CurrentMetricResult.add_member(:collections, Shapes::ShapeRef.new(shape: CurrentMetricDataCollections, location_name: "Collections"))
|
177
|
+
CurrentMetricResult.struct_class = Types::CurrentMetricResult
|
178
|
+
|
179
|
+
CurrentMetricResults.member = Shapes::ShapeRef.new(shape: CurrentMetricResult)
|
180
|
+
|
181
|
+
CurrentMetrics.member = Shapes::ShapeRef.new(shape: CurrentMetric)
|
182
|
+
|
130
183
|
DeleteUserRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
131
184
|
DeleteUserRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, required: true, location: "uri", location_name: "UserId"))
|
132
185
|
DeleteUserRequest.struct_class = Types::DeleteUserRequest
|
@@ -151,12 +204,49 @@ module Aws::Connect
|
|
151
204
|
DescribeUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
|
152
205
|
DescribeUserResponse.struct_class = Types::DescribeUserResponse
|
153
206
|
|
207
|
+
Dimensions.add_member(:queue, Shapes::ShapeRef.new(shape: QueueReference, location_name: "Queue"))
|
208
|
+
Dimensions.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "Channel"))
|
209
|
+
Dimensions.struct_class = Types::Dimensions
|
210
|
+
|
211
|
+
Filters.add_member(:queues, Shapes::ShapeRef.new(shape: Queues, location_name: "Queues"))
|
212
|
+
Filters.add_member(:channels, Shapes::ShapeRef.new(shape: Channels, location_name: "Channels"))
|
213
|
+
Filters.struct_class = Types::Filters
|
214
|
+
|
215
|
+
GetCurrentMetricDataRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
216
|
+
GetCurrentMetricDataRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, required: true, location_name: "Filters"))
|
217
|
+
GetCurrentMetricDataRequest.add_member(:groupings, Shapes::ShapeRef.new(shape: Groupings, location_name: "Groupings"))
|
218
|
+
GetCurrentMetricDataRequest.add_member(:current_metrics, Shapes::ShapeRef.new(shape: CurrentMetrics, required: true, location_name: "CurrentMetrics"))
|
219
|
+
GetCurrentMetricDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
220
|
+
GetCurrentMetricDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
|
221
|
+
GetCurrentMetricDataRequest.struct_class = Types::GetCurrentMetricDataRequest
|
222
|
+
|
223
|
+
GetCurrentMetricDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
224
|
+
GetCurrentMetricDataResponse.add_member(:metric_results, Shapes::ShapeRef.new(shape: CurrentMetricResults, location_name: "MetricResults"))
|
225
|
+
GetCurrentMetricDataResponse.add_member(:data_snapshot_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "DataSnapshotTime"))
|
226
|
+
GetCurrentMetricDataResponse.struct_class = Types::GetCurrentMetricDataResponse
|
227
|
+
|
154
228
|
GetFederationTokenRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
155
229
|
GetFederationTokenRequest.struct_class = Types::GetFederationTokenRequest
|
156
230
|
|
157
231
|
GetFederationTokenResponse.add_member(:credentials, Shapes::ShapeRef.new(shape: Credentials, location_name: "Credentials"))
|
158
232
|
GetFederationTokenResponse.struct_class = Types::GetFederationTokenResponse
|
159
233
|
|
234
|
+
GetMetricDataRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
235
|
+
GetMetricDataRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "StartTime"))
|
236
|
+
GetMetricDataRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "EndTime"))
|
237
|
+
GetMetricDataRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, required: true, location_name: "Filters"))
|
238
|
+
GetMetricDataRequest.add_member(:groupings, Shapes::ShapeRef.new(shape: Groupings, location_name: "Groupings"))
|
239
|
+
GetMetricDataRequest.add_member(:historical_metrics, Shapes::ShapeRef.new(shape: HistoricalMetrics, required: true, location_name: "HistoricalMetrics"))
|
240
|
+
GetMetricDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
241
|
+
GetMetricDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
|
242
|
+
GetMetricDataRequest.struct_class = Types::GetMetricDataRequest
|
243
|
+
|
244
|
+
GetMetricDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
245
|
+
GetMetricDataResponse.add_member(:metric_results, Shapes::ShapeRef.new(shape: HistoricalMetricResults, location_name: "MetricResults"))
|
246
|
+
GetMetricDataResponse.struct_class = Types::GetMetricDataResponse
|
247
|
+
|
248
|
+
Groupings.member = Shapes::ShapeRef.new(shape: Grouping)
|
249
|
+
|
160
250
|
HierarchyGroup.add_member(:id, Shapes::ShapeRef.new(shape: HierarchyGroupId, location_name: "Id"))
|
161
251
|
HierarchyGroup.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
162
252
|
HierarchyGroup.add_member(:name, Shapes::ShapeRef.new(shape: HierarchyGroupName, location_name: "Name"))
|
@@ -190,6 +280,26 @@ module Aws::Connect
|
|
190
280
|
HierarchyStructure.add_member(:level_five, Shapes::ShapeRef.new(shape: HierarchyLevel, location_name: "LevelFive"))
|
191
281
|
HierarchyStructure.struct_class = Types::HierarchyStructure
|
192
282
|
|
283
|
+
HistoricalMetric.add_member(:name, Shapes::ShapeRef.new(shape: HistoricalMetricName, location_name: "Name"))
|
284
|
+
HistoricalMetric.add_member(:threshold, Shapes::ShapeRef.new(shape: Threshold, location_name: "Threshold", metadata: {"box"=>true}))
|
285
|
+
HistoricalMetric.add_member(:statistic, Shapes::ShapeRef.new(shape: Statistic, location_name: "Statistic"))
|
286
|
+
HistoricalMetric.add_member(:unit, Shapes::ShapeRef.new(shape: Unit, location_name: "Unit"))
|
287
|
+
HistoricalMetric.struct_class = Types::HistoricalMetric
|
288
|
+
|
289
|
+
HistoricalMetricData.add_member(:metric, Shapes::ShapeRef.new(shape: HistoricalMetric, location_name: "Metric"))
|
290
|
+
HistoricalMetricData.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "Value", metadata: {"box"=>true}))
|
291
|
+
HistoricalMetricData.struct_class = Types::HistoricalMetricData
|
292
|
+
|
293
|
+
HistoricalMetricDataCollections.member = Shapes::ShapeRef.new(shape: HistoricalMetricData)
|
294
|
+
|
295
|
+
HistoricalMetricResult.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
|
296
|
+
HistoricalMetricResult.add_member(:collections, Shapes::ShapeRef.new(shape: HistoricalMetricDataCollections, location_name: "Collections"))
|
297
|
+
HistoricalMetricResult.struct_class = Types::HistoricalMetricResult
|
298
|
+
|
299
|
+
HistoricalMetricResults.member = Shapes::ShapeRef.new(shape: HistoricalMetricResult)
|
300
|
+
|
301
|
+
HistoricalMetrics.member = Shapes::ShapeRef.new(shape: HistoricalMetric)
|
302
|
+
|
193
303
|
ListRoutingProfilesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
194
304
|
ListRoutingProfilesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
195
305
|
ListRoutingProfilesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult1000, location: "querystring", location_name: "maxResults", metadata: {"box"=>true}))
|
@@ -226,6 +336,12 @@ module Aws::Connect
|
|
226
336
|
ListUsersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
227
337
|
ListUsersResponse.struct_class = Types::ListUsersResponse
|
228
338
|
|
339
|
+
QueueReference.add_member(:id, Shapes::ShapeRef.new(shape: QueueId, location_name: "Id"))
|
340
|
+
QueueReference.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
341
|
+
QueueReference.struct_class = Types::QueueReference
|
342
|
+
|
343
|
+
Queues.member = Shapes::ShapeRef.new(shape: QueueId)
|
344
|
+
|
229
345
|
RoutingProfileSummary.add_member(:id, Shapes::ShapeRef.new(shape: RoutingProfileId, location_name: "Id"))
|
230
346
|
RoutingProfileSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
231
347
|
RoutingProfileSummary.add_member(:name, Shapes::ShapeRef.new(shape: RoutingProfileName, location_name: "Name"))
|
@@ -260,6 +376,10 @@ module Aws::Connect
|
|
260
376
|
|
261
377
|
StopContactResponse.struct_class = Types::StopContactResponse
|
262
378
|
|
379
|
+
Threshold.add_member(:comparison, Shapes::ShapeRef.new(shape: Comparison, location_name: "Comparison"))
|
380
|
+
Threshold.add_member(:threshold_value, Shapes::ShapeRef.new(shape: ThresholdValue, location_name: "ThresholdValue", metadata: {"box"=>true}))
|
381
|
+
Threshold.struct_class = Types::Threshold
|
382
|
+
|
263
383
|
UpdateContactAttributesRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "InitialContactId"))
|
264
384
|
UpdateContactAttributesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
265
385
|
UpdateContactAttributesRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, required: true, location_name: "Attributes"))
|
@@ -407,6 +527,25 @@ module Aws::Connect
|
|
407
527
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
408
528
|
end)
|
409
529
|
|
530
|
+
api.add_operation(:get_current_metric_data, Seahorse::Model::Operation.new.tap do |o|
|
531
|
+
o.name = "GetCurrentMetricData"
|
532
|
+
o.http_method = "POST"
|
533
|
+
o.http_request_uri = "/metrics/current/{InstanceId}"
|
534
|
+
o.input = Shapes::ShapeRef.new(shape: GetCurrentMetricDataRequest)
|
535
|
+
o.output = Shapes::ShapeRef.new(shape: GetCurrentMetricDataResponse)
|
536
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
537
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
538
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
539
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
540
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
541
|
+
o[:pager] = Aws::Pager.new(
|
542
|
+
limit_key: "max_results",
|
543
|
+
tokens: {
|
544
|
+
"next_token" => "next_token"
|
545
|
+
}
|
546
|
+
)
|
547
|
+
end)
|
548
|
+
|
410
549
|
api.add_operation(:get_federation_token, Seahorse::Model::Operation.new.tap do |o|
|
411
550
|
o.name = "GetFederationToken"
|
412
551
|
o.http_method = "GET"
|
@@ -421,6 +560,25 @@ module Aws::Connect
|
|
421
560
|
o.errors << Shapes::ShapeRef.new(shape: DuplicateResourceException)
|
422
561
|
end)
|
423
562
|
|
563
|
+
api.add_operation(:get_metric_data, Seahorse::Model::Operation.new.tap do |o|
|
564
|
+
o.name = "GetMetricData"
|
565
|
+
o.http_method = "POST"
|
566
|
+
o.http_request_uri = "/metrics/historical/{InstanceId}"
|
567
|
+
o.input = Shapes::ShapeRef.new(shape: GetMetricDataRequest)
|
568
|
+
o.output = Shapes::ShapeRef.new(shape: GetMetricDataResponse)
|
569
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
570
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
571
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
572
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
573
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
574
|
+
o[:pager] = Aws::Pager.new(
|
575
|
+
limit_key: "max_results",
|
576
|
+
tokens: {
|
577
|
+
"next_token" => "next_token"
|
578
|
+
}
|
579
|
+
)
|
580
|
+
end)
|
581
|
+
|
424
582
|
api.add_operation(:list_routing_profiles, Seahorse::Model::Operation.new.tap do |o|
|
425
583
|
o.name = "ListRoutingProfiles"
|
426
584
|
o.http_method = "GET"
|
@@ -33,7 +33,7 @@ module Aws::Connect
|
|
33
33
|
# }
|
34
34
|
#
|
35
35
|
# @!attribute [rw] username
|
36
|
-
# The user name in Amazon Connect for the
|
36
|
+
# The user name in Amazon Connect for the account to create.
|
37
37
|
# @return [String]
|
38
38
|
#
|
39
39
|
# @!attribute [rw] password
|
@@ -157,6 +157,69 @@ module Aws::Connect
|
|
157
157
|
include Aws::Structure
|
158
158
|
end
|
159
159
|
|
160
|
+
# A `CurrentMetric` object that contains the Name and Unit for the
|
161
|
+
# metric.
|
162
|
+
#
|
163
|
+
# @note When making an API call, you may pass CurrentMetric
|
164
|
+
# data as a hash:
|
165
|
+
#
|
166
|
+
# {
|
167
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
168
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
169
|
+
# }
|
170
|
+
#
|
171
|
+
# @!attribute [rw] name
|
172
|
+
# The name of the metric.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] unit
|
176
|
+
# The unit for the metric.
|
177
|
+
# @return [String]
|
178
|
+
#
|
179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetric AWS API Documentation
|
180
|
+
#
|
181
|
+
class CurrentMetric < Struct.new(
|
182
|
+
:name,
|
183
|
+
:unit)
|
184
|
+
include Aws::Structure
|
185
|
+
end
|
186
|
+
|
187
|
+
# A `CurrentMetricData` object.
|
188
|
+
#
|
189
|
+
# @!attribute [rw] metric
|
190
|
+
# The metric in a `CurrentMetricData` object.
|
191
|
+
# @return [Types::CurrentMetric]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] value
|
194
|
+
# The value of the metric in the CurrentMetricData object.
|
195
|
+
# @return [Float]
|
196
|
+
#
|
197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetricData AWS API Documentation
|
198
|
+
#
|
199
|
+
class CurrentMetricData < Struct.new(
|
200
|
+
:metric,
|
201
|
+
:value)
|
202
|
+
include Aws::Structure
|
203
|
+
end
|
204
|
+
|
205
|
+
# A `CurrentMetricResult` object.
|
206
|
+
#
|
207
|
+
# @!attribute [rw] dimensions
|
208
|
+
# The `Dimensions` for the `CurrentMetricResult` object.
|
209
|
+
# @return [Types::Dimensions]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] collections
|
212
|
+
# The `Collections` for the `CurrentMetricResult` object.
|
213
|
+
# @return [Array<Types::CurrentMetricData>]
|
214
|
+
#
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CurrentMetricResult AWS API Documentation
|
216
|
+
#
|
217
|
+
class CurrentMetricResult < Struct.new(
|
218
|
+
:dimensions,
|
219
|
+
:collections)
|
220
|
+
include Aws::Structure
|
221
|
+
end
|
222
|
+
|
160
223
|
# @note When making an API call, you may pass DeleteUserRequest
|
161
224
|
# data as a hash:
|
162
225
|
#
|
@@ -305,6 +368,227 @@ module Aws::Connect
|
|
305
368
|
include Aws::Structure
|
306
369
|
end
|
307
370
|
|
371
|
+
# A `Dimensions` object that includes the Channel and Queue for the
|
372
|
+
# metric.
|
373
|
+
#
|
374
|
+
# @!attribute [rw] queue
|
375
|
+
# A `QueueReference` object used as one part of dimension for the
|
376
|
+
# metrics results.
|
377
|
+
# @return [Types::QueueReference]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] channel
|
380
|
+
# The channel used for grouping and filters. Only VOICE is supported.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
|
384
|
+
#
|
385
|
+
class Dimensions < Struct.new(
|
386
|
+
:queue,
|
387
|
+
:channel)
|
388
|
+
include Aws::Structure
|
389
|
+
end
|
390
|
+
|
391
|
+
# The filter, either channel or queues, to apply to the metric results
|
392
|
+
# retrieved.
|
393
|
+
#
|
394
|
+
# @note When making an API call, you may pass Filters
|
395
|
+
# data as a hash:
|
396
|
+
#
|
397
|
+
# {
|
398
|
+
# queues: ["QueueId"],
|
399
|
+
# channels: ["VOICE"], # accepts VOICE
|
400
|
+
# }
|
401
|
+
#
|
402
|
+
# @!attribute [rw] queues
|
403
|
+
# A list of up to 100 queue IDs or queue ARNs to use to filter the
|
404
|
+
# metrics retrieved. You can include both IDs and ARNs in a request.
|
405
|
+
# @return [Array<String>]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] channels
|
408
|
+
# The Channel to use as a filter for the metrics returned. Only VOICE
|
409
|
+
# is supported.
|
410
|
+
# @return [Array<String>]
|
411
|
+
#
|
412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
|
413
|
+
#
|
414
|
+
class Filters < Struct.new(
|
415
|
+
:queues,
|
416
|
+
:channels)
|
417
|
+
include Aws::Structure
|
418
|
+
end
|
419
|
+
|
420
|
+
# @note When making an API call, you may pass GetCurrentMetricDataRequest
|
421
|
+
# data as a hash:
|
422
|
+
#
|
423
|
+
# {
|
424
|
+
# instance_id: "InstanceId", # required
|
425
|
+
# filters: { # required
|
426
|
+
# queues: ["QueueId"],
|
427
|
+
# channels: ["VOICE"], # accepts VOICE
|
428
|
+
# },
|
429
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
430
|
+
# current_metrics: [ # required
|
431
|
+
# {
|
432
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
433
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
434
|
+
# },
|
435
|
+
# ],
|
436
|
+
# next_token: "NextToken",
|
437
|
+
# max_results: 1,
|
438
|
+
# }
|
439
|
+
#
|
440
|
+
# @!attribute [rw] instance_id
|
441
|
+
# The identifier for your Amazon Connect instance. To find the ID of
|
442
|
+
# your instance, open the AWS console and select Amazon Connect.
|
443
|
+
# Select the alias of the instance in the Instance alias column. The
|
444
|
+
# instance ID is displayed in the Overview section of your instance
|
445
|
+
# settings. For example, the instance ID is the set of characters at
|
446
|
+
# the end of the instance ARN, after instance/, such as
|
447
|
+
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] filters
|
451
|
+
# A `Filters` object that contains a list of queue IDs or queue ARNs,
|
452
|
+
# up to 100, or list of Channels to use to filter the metrics returned
|
453
|
+
# in the response. Metric data is retrieved only for the resources
|
454
|
+
# associated with the queue IDs, ARNs, or Channels included in the
|
455
|
+
# filter. You can include both IDs and ARNs in the same request. To
|
456
|
+
# retrieve metrics for all queues, add the queue ID or ARN for each
|
457
|
+
# queue in your instance. Only VOICE is supported for Channels.
|
458
|
+
#
|
459
|
+
# To find the ARN for a queue, open the queue you want to use in the
|
460
|
+
# Amazon Connect Queue editor. The ARN for the queue is displayed in
|
461
|
+
# the address bar as part of the URL. For example, the queue ARN is
|
462
|
+
# the set of characters at the end of the URL, after 'id=' such as
|
463
|
+
# `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
|
464
|
+
# The queue ID is also included in the URL, and is the string after
|
465
|
+
# 'queue/'.
|
466
|
+
# @return [Types::Filters]
|
467
|
+
#
|
468
|
+
# @!attribute [rw] groupings
|
469
|
+
# The grouping applied to the metrics returned. For example, when
|
470
|
+
# grouped by QUEUE, the metrics returned apply to each queue rather
|
471
|
+
# than aggregated for all queues. If you group by CHANNEL, you should
|
472
|
+
# include a Channels filter. The only supported channel is VOICE.
|
473
|
+
#
|
474
|
+
# If no `Grouping` is included in the request, a summary of
|
475
|
+
# `CurrentMetrics` is returned.
|
476
|
+
# @return [Array<String>]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] current_metrics
|
479
|
+
# A list of `CurrentMetric` objects for the metrics to retrieve. Each
|
480
|
+
# `CurrentMetric` includes a name of a metric to retrieve and the unit
|
481
|
+
# to use for it.
|
482
|
+
#
|
483
|
+
# The following metrics are available:
|
484
|
+
#
|
485
|
+
# AGENTS\_AVAILABLE
|
486
|
+
#
|
487
|
+
# : Unit: COUNT
|
488
|
+
#
|
489
|
+
# AGENTS\_ONLINE
|
490
|
+
#
|
491
|
+
# : Unit: COUNT
|
492
|
+
#
|
493
|
+
# AGENTS\_ON\_CALL
|
494
|
+
#
|
495
|
+
# : Unit: COUNT
|
496
|
+
#
|
497
|
+
# AGENTS\_STAFFED
|
498
|
+
#
|
499
|
+
# : Unit: COUNT
|
500
|
+
#
|
501
|
+
# AGENTS\_AFTER\_CONTACT\_WORK
|
502
|
+
#
|
503
|
+
# : Unit: COUNT
|
504
|
+
#
|
505
|
+
# AGENTS\_NON\_PRODUCTIVE
|
506
|
+
#
|
507
|
+
# : Unit: COUNT
|
508
|
+
#
|
509
|
+
# AGENTS\_ERROR
|
510
|
+
#
|
511
|
+
# : Unit: COUNT
|
512
|
+
#
|
513
|
+
# CONTACTS\_IN\_QUEUE
|
514
|
+
#
|
515
|
+
# : Unit: COUNT
|
516
|
+
#
|
517
|
+
# OLDEST\_CONTACT\_AGE
|
518
|
+
#
|
519
|
+
# : Unit: SECONDS
|
520
|
+
#
|
521
|
+
# CONTACTS\_SCHEDULED
|
522
|
+
#
|
523
|
+
# : Unit: COUNT
|
524
|
+
# @return [Array<Types::CurrentMetric>]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] next_token
|
527
|
+
# The token for the next set of results. Use the value returned in the
|
528
|
+
# previous response in the next request to retrieve the next set of
|
529
|
+
# results.
|
530
|
+
#
|
531
|
+
# The token expires after 5 minutes from the time it is created.
|
532
|
+
# Subsequent requests that use the [NextToken]() must use the same
|
533
|
+
# request parameters as the request that generated the token.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] max_results
|
537
|
+
# `MaxResults` indicates the maximum number of results to return per
|
538
|
+
# page in the response, between 1 and 100.
|
539
|
+
# @return [Integer]
|
540
|
+
#
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
|
542
|
+
#
|
543
|
+
class GetCurrentMetricDataRequest < Struct.new(
|
544
|
+
:instance_id,
|
545
|
+
:filters,
|
546
|
+
:groupings,
|
547
|
+
:current_metrics,
|
548
|
+
:next_token,
|
549
|
+
:max_results)
|
550
|
+
include Aws::Structure
|
551
|
+
end
|
552
|
+
|
553
|
+
# @!attribute [rw] next_token
|
554
|
+
# A string returned in the response. Use the value returned in the
|
555
|
+
# response as the value of the NextToken in a subsequent request to
|
556
|
+
# retrieve the next set of results.
|
557
|
+
#
|
558
|
+
# The token expires after 5 minutes from the time it is created.
|
559
|
+
# Subsequent requests that use the NextToken must use the same request
|
560
|
+
# parameters as the request that generated the token.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] metric_results
|
564
|
+
# A list of `CurrentMetricResult` objects organized by `Dimensions`
|
565
|
+
# combining with `CurrentMetricDataCollections`.
|
566
|
+
#
|
567
|
+
# `Dimensions` is the resourceId specified in the `Filters` of the
|
568
|
+
# request.
|
569
|
+
#
|
570
|
+
# `Collections` is a list of `CurrentMetricData` objects with
|
571
|
+
# corresponding values to the `CurrentMetrics` specified in the
|
572
|
+
# request.
|
573
|
+
#
|
574
|
+
# If no `Grouping` is specified in the request, `Collections` is a
|
575
|
+
# summary for the `CurrentMetric` returned.
|
576
|
+
# @return [Array<Types::CurrentMetricResult>]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] data_snapshot_time
|
579
|
+
# The time at which `CurrentMetricData` was retrieved and cached for
|
580
|
+
# pagination.
|
581
|
+
# @return [Time]
|
582
|
+
#
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataResponse AWS API Documentation
|
584
|
+
#
|
585
|
+
class GetCurrentMetricDataResponse < Struct.new(
|
586
|
+
:next_token,
|
587
|
+
:metric_results,
|
588
|
+
:data_snapshot_time)
|
589
|
+
include Aws::Structure
|
590
|
+
end
|
591
|
+
|
308
592
|
# @note When making an API call, you may pass GetFederationTokenRequest
|
309
593
|
# data as a hash:
|
310
594
|
#
|
@@ -340,6 +624,321 @@ module Aws::Connect
|
|
340
624
|
include Aws::Structure
|
341
625
|
end
|
342
626
|
|
627
|
+
# @note When making an API call, you may pass GetMetricDataRequest
|
628
|
+
# data as a hash:
|
629
|
+
#
|
630
|
+
# {
|
631
|
+
# instance_id: "InstanceId", # required
|
632
|
+
# start_time: Time.now, # required
|
633
|
+
# end_time: Time.now, # required
|
634
|
+
# filters: { # required
|
635
|
+
# queues: ["QueueId"],
|
636
|
+
# channels: ["VOICE"], # accepts VOICE
|
637
|
+
# },
|
638
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
639
|
+
# historical_metrics: [ # required
|
640
|
+
# {
|
641
|
+
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
642
|
+
# threshold: {
|
643
|
+
# comparison: "LT", # accepts LT
|
644
|
+
# threshold_value: 1.0,
|
645
|
+
# },
|
646
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
647
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
648
|
+
# },
|
649
|
+
# ],
|
650
|
+
# next_token: "NextToken",
|
651
|
+
# max_results: 1,
|
652
|
+
# }
|
653
|
+
#
|
654
|
+
# @!attribute [rw] instance_id
|
655
|
+
# The identifier for your Amazon Connect instance. To find the ID of
|
656
|
+
# your instance, open the AWS console and select Amazon Connect.
|
657
|
+
# Select the alias of the instance in the Instance alias column. The
|
658
|
+
# instance ID is displayed in the Overview section of your instance
|
659
|
+
# settings. For example, the instance ID is the set of characters at
|
660
|
+
# the end of the instance ARN, after instance/, such as
|
661
|
+
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] start_time
|
665
|
+
# The timestamp, in UNIX Epoch time format, at which to start the
|
666
|
+
# reporting interval for the retrieval of historical metrics data. The
|
667
|
+
# time must be specified using a multiple of 5 minutes, such as 10:05,
|
668
|
+
# 10:10, 10:15.
|
669
|
+
#
|
670
|
+
# `StartTime` cannot be earlier than 24 hours before the time of the
|
671
|
+
# request. Historical metrics are available in Amazon Connect only for
|
672
|
+
# 24 hours.
|
673
|
+
# @return [Time]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] end_time
|
676
|
+
# The timestamp, in UNIX Epoch time format, at which to end the
|
677
|
+
# reporting interval for the retrieval of historical metrics data. The
|
678
|
+
# time must be specified using an interval of 5 minutes, such as
|
679
|
+
# 11:00, 11:05, 11:10, and must be later than the `StartTime`
|
680
|
+
# timestamp.
|
681
|
+
#
|
682
|
+
# The time range between `StartTime` and `EndTime` must be less than
|
683
|
+
# 24 hours.
|
684
|
+
# @return [Time]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] filters
|
687
|
+
# A `Filters` object that contains a list of queue IDs or queue ARNs,
|
688
|
+
# up to 100, or a list of Channels to use to filter the metrics
|
689
|
+
# returned in the response. Metric data is retrieved only for the
|
690
|
+
# resources associated with the IDs, ARNs, or Channels included in the
|
691
|
+
# filter. You can use both IDs and ARNs together in a request. Only
|
692
|
+
# VOICE is supported for Channel.
|
693
|
+
#
|
694
|
+
# To find the ARN for a queue, open the queue you want to use in the
|
695
|
+
# Amazon Connect Queue editor. The ARN for the queue is displayed in
|
696
|
+
# the address bar as part of the URL. For example, the queue ARN is
|
697
|
+
# the set of characters at the end of the URL, after 'id=' such as
|
698
|
+
# `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
|
699
|
+
# The queue ID is also included in the URL, and is the string after
|
700
|
+
# 'queue/'.
|
701
|
+
# @return [Types::Filters]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] groupings
|
704
|
+
# The grouping applied to the metrics returned. For example, when
|
705
|
+
# results are grouped by queueId, the metrics returned are grouped by
|
706
|
+
# queue. The values returned apply to the metrics for each queue
|
707
|
+
# rather than aggregated for all queues.
|
708
|
+
#
|
709
|
+
# The current version supports grouping by Queue
|
710
|
+
#
|
711
|
+
# If no `Grouping` is included in the request, a summary of
|
712
|
+
# `HistoricalMetrics` for all queues is returned.
|
713
|
+
# @return [Array<String>]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] historical_metrics
|
716
|
+
# A list of `HistoricalMetric` objects that contain the metrics to
|
717
|
+
# retrieve with the request.
|
718
|
+
#
|
719
|
+
# A `HistoricalMetric` object contains: `HistoricalMetricName`,
|
720
|
+
# `Statistic`, `Threshold`, and `Unit`.
|
721
|
+
#
|
722
|
+
# For each historical metric you include in the request, you must
|
723
|
+
# include a `Unit` and a `Statistic`.
|
724
|
+
#
|
725
|
+
# The following historical metrics are available:
|
726
|
+
#
|
727
|
+
# CONTACTS\_QUEUED
|
728
|
+
#
|
729
|
+
# : Unit: COUNT
|
730
|
+
#
|
731
|
+
# Statistic: SUM
|
732
|
+
#
|
733
|
+
# CONTACTS\_HANDLED
|
734
|
+
#
|
735
|
+
# : Unit: COUNT
|
736
|
+
#
|
737
|
+
# Statistics: SUM
|
738
|
+
#
|
739
|
+
# CONTACTS\_ABANDONED
|
740
|
+
#
|
741
|
+
# : Unit: COUNT
|
742
|
+
#
|
743
|
+
# Statistics: SUM
|
744
|
+
#
|
745
|
+
# CONTACTS\_CONSULTED
|
746
|
+
#
|
747
|
+
# : Unit: COUNT
|
748
|
+
#
|
749
|
+
# Statistics: SUM
|
750
|
+
#
|
751
|
+
# CONTACTS\_AGENT\_HUNG\_UP\_FIRST
|
752
|
+
#
|
753
|
+
# : Unit: COUNT
|
754
|
+
#
|
755
|
+
# Statistics: SUM
|
756
|
+
#
|
757
|
+
# CONTACTS\_HANDLED\_INCOMING
|
758
|
+
#
|
759
|
+
# : Unit: COUNT
|
760
|
+
#
|
761
|
+
# Statistics: SUM
|
762
|
+
#
|
763
|
+
# CONTACTS\_HANDLED\_OUTBOUND
|
764
|
+
#
|
765
|
+
# : Unit: COUNT
|
766
|
+
#
|
767
|
+
# Statistics: SUM
|
768
|
+
#
|
769
|
+
# CONTACTS\_HOLD\_ABANDONS
|
770
|
+
#
|
771
|
+
# : Unit: COUNT
|
772
|
+
#
|
773
|
+
# Statistics: SUM
|
774
|
+
#
|
775
|
+
# CONTACTS\_TRANSFERRED\_IN
|
776
|
+
#
|
777
|
+
# : Unit: COUNT
|
778
|
+
#
|
779
|
+
# Statistics: SUM
|
780
|
+
#
|
781
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
782
|
+
#
|
783
|
+
# : Unit: COUNT
|
784
|
+
#
|
785
|
+
# Statistics: SUM
|
786
|
+
#
|
787
|
+
# CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
|
788
|
+
#
|
789
|
+
# : Unit: COUNT
|
790
|
+
#
|
791
|
+
# Statistics: SUM
|
792
|
+
#
|
793
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
794
|
+
#
|
795
|
+
# : Unit: COUNT
|
796
|
+
#
|
797
|
+
# Statistics: SUM
|
798
|
+
#
|
799
|
+
# CALLBACK\_CONTACTS\_HANDLED
|
800
|
+
#
|
801
|
+
# : Unit: COUNT
|
802
|
+
#
|
803
|
+
# Statistics: SUM
|
804
|
+
#
|
805
|
+
# CALLBACK\_CONTACTS\_HANDLED
|
806
|
+
#
|
807
|
+
# : Unit: COUNT
|
808
|
+
#
|
809
|
+
# Statistics: SUM
|
810
|
+
#
|
811
|
+
# API\_CONTACTS\_HANDLED
|
812
|
+
#
|
813
|
+
# : Unit: COUNT
|
814
|
+
#
|
815
|
+
# Statistics: SUM
|
816
|
+
#
|
817
|
+
# CONTACTS\_MISSED
|
818
|
+
#
|
819
|
+
# : Unit: COUNT
|
820
|
+
#
|
821
|
+
# Statistics: SUM
|
822
|
+
#
|
823
|
+
# OCCUPANCY
|
824
|
+
#
|
825
|
+
# : Unit: PERCENT
|
826
|
+
#
|
827
|
+
# Statistics: AVG
|
828
|
+
#
|
829
|
+
# HANDLE\_TIME
|
830
|
+
#
|
831
|
+
# : Unit: SECONDS
|
832
|
+
#
|
833
|
+
# Statistics: AVG
|
834
|
+
#
|
835
|
+
# AFTER\_CONTACT\_WORK\_TIME
|
836
|
+
#
|
837
|
+
# : Unit: SECONDS
|
838
|
+
#
|
839
|
+
# Statistics: AVG
|
840
|
+
#
|
841
|
+
# QUEUED\_TIME
|
842
|
+
#
|
843
|
+
# : Unit: SECONDS
|
844
|
+
#
|
845
|
+
# Statistics: MAX
|
846
|
+
#
|
847
|
+
# ABANDON\_TIME
|
848
|
+
#
|
849
|
+
# : Unit: COUNT
|
850
|
+
#
|
851
|
+
# Statistics: SUM
|
852
|
+
#
|
853
|
+
# QUEUE\_ANSWER\_TIME
|
854
|
+
#
|
855
|
+
# : Unit: SECONDS
|
856
|
+
#
|
857
|
+
# Statistics: AVG
|
858
|
+
#
|
859
|
+
# HOLD\_TIME
|
860
|
+
#
|
861
|
+
# : Unit: SECONDS
|
862
|
+
#
|
863
|
+
# Statistics: AVG
|
864
|
+
#
|
865
|
+
# INTERACTION\_TIME
|
866
|
+
#
|
867
|
+
# : Unit: SECONDS
|
868
|
+
#
|
869
|
+
# Statistics: AVG
|
870
|
+
#
|
871
|
+
# INTERACTION\_AND\_HOLD\_TIME
|
872
|
+
#
|
873
|
+
# : Unit: SECONDS
|
874
|
+
#
|
875
|
+
# Statistics: AVG
|
876
|
+
#
|
877
|
+
# SERVICE\_LEVEL
|
878
|
+
#
|
879
|
+
# : Unit: PERCENT
|
880
|
+
#
|
881
|
+
# Statistics: AVG
|
882
|
+
#
|
883
|
+
# Threshold: Only "Less than" comparisons are supported, with the
|
884
|
+
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90,
|
885
|
+
# 120, 180, 240, 300, 600
|
886
|
+
# @return [Array<Types::HistoricalMetric>]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] next_token
|
889
|
+
# The token for the next set of results. Use the value returned in the
|
890
|
+
# previous response in the next request to retrieve the next set of
|
891
|
+
# results.
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @!attribute [rw] max_results
|
895
|
+
# Indicates the maximum number of results to return per page in the
|
896
|
+
# response, between 1-100.
|
897
|
+
# @return [Integer]
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataRequest AWS API Documentation
|
900
|
+
#
|
901
|
+
class GetMetricDataRequest < Struct.new(
|
902
|
+
:instance_id,
|
903
|
+
:start_time,
|
904
|
+
:end_time,
|
905
|
+
:filters,
|
906
|
+
:groupings,
|
907
|
+
:historical_metrics,
|
908
|
+
:next_token,
|
909
|
+
:max_results)
|
910
|
+
include Aws::Structure
|
911
|
+
end
|
912
|
+
|
913
|
+
# @!attribute [rw] next_token
|
914
|
+
# A string returned in the response. Use the value returned in the
|
915
|
+
# response as the value of the NextToken in a subsequent request to
|
916
|
+
# retrieve the next set of results.
|
917
|
+
#
|
918
|
+
# The token expires after 5 minutes from the time it is created.
|
919
|
+
# Subsequent requests that use the NextToken must use the same request
|
920
|
+
# parameters as the request that generated the token.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] metric_results
|
924
|
+
# A list of `HistoricalMetricResult` objects, organized by
|
925
|
+
# `Dimensions`, which is the ID of the resource specified in the
|
926
|
+
# `Filters` used for the request. The metrics are combined with the
|
927
|
+
# metrics included in `Collections`, which is a list of
|
928
|
+
# `HisotricalMetricData` objects.
|
929
|
+
#
|
930
|
+
# If no `Grouping` is specified in the request, `Collections` includes
|
931
|
+
# summary data for the `HistoricalMetrics`.
|
932
|
+
# @return [Array<Types::HistoricalMetricResult>]
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataResponse AWS API Documentation
|
935
|
+
#
|
936
|
+
class GetMetricDataResponse < Struct.new(
|
937
|
+
:next_token,
|
938
|
+
:metric_results)
|
939
|
+
include Aws::Structure
|
940
|
+
end
|
941
|
+
|
343
942
|
# A `HierarchyGroup` object that contains information about a hierarchy
|
344
943
|
# group in your Amazon Connect instance.
|
345
944
|
#
|
@@ -501,6 +1100,85 @@ module Aws::Connect
|
|
501
1100
|
include Aws::Structure
|
502
1101
|
end
|
503
1102
|
|
1103
|
+
# A `HistoricalMetric` object that contains the Name, Unit, Statistic,
|
1104
|
+
# and Threshold for the metric.
|
1105
|
+
#
|
1106
|
+
# @note When making an API call, you may pass HistoricalMetric
|
1107
|
+
# data as a hash:
|
1108
|
+
#
|
1109
|
+
# {
|
1110
|
+
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
1111
|
+
# threshold: {
|
1112
|
+
# comparison: "LT", # accepts LT
|
1113
|
+
# threshold_value: 1.0,
|
1114
|
+
# },
|
1115
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
1116
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
1117
|
+
# }
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] name
|
1120
|
+
# The name of the historical metric.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] threshold
|
1124
|
+
# The threshold for the metric, used with service level metrics.
|
1125
|
+
# @return [Types::Threshold]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] statistic
|
1128
|
+
# The statistic for the metric: SUM, MAX, or SUM.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] unit
|
1132
|
+
# The unit for the metric: COUNT, PERCENT, or SECONDS.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetric AWS API Documentation
|
1136
|
+
#
|
1137
|
+
class HistoricalMetric < Struct.new(
|
1138
|
+
:name,
|
1139
|
+
:threshold,
|
1140
|
+
:statistic,
|
1141
|
+
:unit)
|
1142
|
+
include Aws::Structure
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# A `HistoricalMetricData` object than contains a `Metric` and a
|
1146
|
+
# `Value`.
|
1147
|
+
#
|
1148
|
+
# @!attribute [rw] metric
|
1149
|
+
# A `HistoricalMetric` object.
|
1150
|
+
# @return [Types::HistoricalMetric]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] value
|
1153
|
+
# The `Value` of the metric.
|
1154
|
+
# @return [Float]
|
1155
|
+
#
|
1156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricData AWS API Documentation
|
1157
|
+
#
|
1158
|
+
class HistoricalMetricData < Struct.new(
|
1159
|
+
:metric,
|
1160
|
+
:value)
|
1161
|
+
include Aws::Structure
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# The metrics data returned from a `GetMetricData` operation.
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] dimensions
|
1167
|
+
# The `Dimensions` for the metrics.
|
1168
|
+
# @return [Types::Dimensions]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] collections
|
1171
|
+
# A list of `HistoricalMetricData` objects.
|
1172
|
+
# @return [Array<Types::HistoricalMetricData>]
|
1173
|
+
#
|
1174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricResult AWS API Documentation
|
1175
|
+
#
|
1176
|
+
class HistoricalMetricResult < Struct.new(
|
1177
|
+
:dimensions,
|
1178
|
+
:collections)
|
1179
|
+
include Aws::Structure
|
1180
|
+
end
|
1181
|
+
|
504
1182
|
# @note When making an API call, you may pass ListRoutingProfilesRequest
|
505
1183
|
# data as a hash:
|
506
1184
|
#
|
@@ -727,6 +1405,25 @@ module Aws::Connect
|
|
727
1405
|
include Aws::Structure
|
728
1406
|
end
|
729
1407
|
|
1408
|
+
# A QueueReference object that contains the the QueueId and ARN for the
|
1409
|
+
# queue resource for which metrics are returned.
|
1410
|
+
#
|
1411
|
+
# @!attribute [rw] id
|
1412
|
+
# The ID of the queue associated with the metrics returned.
|
1413
|
+
# @return [String]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] arn
|
1416
|
+
# The Amazon Resource Name (ARN) of queue.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
1420
|
+
#
|
1421
|
+
class QueueReference < Struct.new(
|
1422
|
+
:id,
|
1423
|
+
:arn)
|
1424
|
+
include Aws::Structure
|
1425
|
+
end
|
1426
|
+
|
730
1427
|
# A `RoutingProfileSummary` object that contains information about a
|
731
1428
|
# routing profile, including ARN, Id, and Name.
|
732
1429
|
#
|
@@ -916,6 +1613,35 @@ module Aws::Connect
|
|
916
1613
|
#
|
917
1614
|
class StopContactResponse < Aws::EmptyStructure; end
|
918
1615
|
|
1616
|
+
# A `Threshold` object that includes a comparison and `ThresholdValue`
|
1617
|
+
# to compare to. Used with service level metrics.
|
1618
|
+
#
|
1619
|
+
# @note When making an API call, you may pass Threshold
|
1620
|
+
# data as a hash:
|
1621
|
+
#
|
1622
|
+
# {
|
1623
|
+
# comparison: "LT", # accepts LT
|
1624
|
+
# threshold_value: 1.0,
|
1625
|
+
# }
|
1626
|
+
#
|
1627
|
+
# @!attribute [rw] comparison
|
1628
|
+
# The Threshold to use to compare service level metrics to. Only
|
1629
|
+
# "Less than" (LT) comparisons are supported.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] threshold_value
|
1633
|
+
# The value of the threshold to compare the metric to. Only "Less
|
1634
|
+
# than" (LT) comparisons are supported.
|
1635
|
+
# @return [Float]
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Threshold AWS API Documentation
|
1638
|
+
#
|
1639
|
+
class Threshold < Struct.new(
|
1640
|
+
:comparison,
|
1641
|
+
:threshold_value)
|
1642
|
+
include Aws::Structure
|
1643
|
+
end
|
1644
|
+
|
919
1645
|
# @note When making an API call, you may pass UpdateContactAttributesRequest
|
920
1646
|
# data as a hash:
|
921
1647
|
#
|
@@ -935,11 +1661,11 @@ module Aws::Connect
|
|
935
1661
|
#
|
936
1662
|
# @!attribute [rw] instance_id
|
937
1663
|
# The identifier for your Amazon Connect instance. To find the ID of
|
938
|
-
# your
|
939
|
-
#
|
940
|
-
# is displayed in the Overview section of your instance
|
941
|
-
# example, the instance ID is the set of characters at
|
942
|
-
# instance ARN, after instance/, such as
|
1664
|
+
# your instance, open the AWS console and select Amazon Connect.
|
1665
|
+
# Select the alias of the instance in the Instance alias column. The
|
1666
|
+
# instance ID is displayed in the Overview section of your instance
|
1667
|
+
# settings. For example, the instance ID is the set of characters at
|
1668
|
+
# the end of the instance ARN, after instance/, such as
|
943
1669
|
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
944
1670
|
# @return [String]
|
945
1671
|
#
|