aws-sdk-connect 1.85.0 → 1.86.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +340 -5
- data/lib/aws-sdk-connect/client_api.rb +224 -0
- data/lib/aws-sdk-connect/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-connect/endpoint_provider.rb +73 -74
- data/lib/aws-sdk-connect/endpoints.rb +70 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-connect/types.rb +525 -2874
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -23,6 +23,20 @@ module Aws::Connect
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Information about an action.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] action_type
|
29
|
+
# The action type.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ActionSummary AWS API Documentation
|
33
|
+
#
|
34
|
+
class ActionSummary < Struct.new(
|
35
|
+
:action_type)
|
36
|
+
SENSITIVE = []
|
37
|
+
include Aws::Structure
|
38
|
+
end
|
39
|
+
|
26
40
|
# Information about the [contact][1] associated to the user.
|
27
41
|
#
|
28
42
|
#
|
@@ -196,14 +210,6 @@ module Aws::Connect
|
|
196
210
|
|
197
211
|
# Configuration of the answering machine detection.
|
198
212
|
#
|
199
|
-
# @note When making an API call, you may pass AnswerMachineDetectionConfig
|
200
|
-
# data as a hash:
|
201
|
-
#
|
202
|
-
# {
|
203
|
-
# enable_answer_machine_detection: false,
|
204
|
-
# await_answer_machine_prompt: false,
|
205
|
-
# }
|
206
|
-
#
|
207
213
|
# @!attribute [rw] enable_answer_machine_detection
|
208
214
|
# The flag to indicate if answer machine detection analysis needs to
|
209
215
|
# be performed for a voice call. If set to `true`, `TrafficType` must
|
@@ -223,14 +229,19 @@ module Aws::Connect
|
|
223
229
|
include Aws::Structure
|
224
230
|
end
|
225
231
|
|
226
|
-
#
|
227
|
-
#
|
232
|
+
# This action must be set if `TriggerEventSource` is one of the
|
233
|
+
# following values: `OnPostCallAnalysisAvailable` \|
|
234
|
+
# `OnRealTimeCallAnalysisAvailable` \| `OnPostChatAnalysisAvailable`.
|
235
|
+
# Contact is categorized using the rule name.
|
236
|
+
#
|
237
|
+
# `RuleName` is used as `ContactCategory`.
|
238
|
+
#
|
239
|
+
# @api private
|
228
240
|
#
|
229
|
-
#
|
230
|
-
# instance_id: "InstanceId", # required
|
231
|
-
# origin: "Origin", # required
|
232
|
-
# }
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssignContactCategoryActionDefinition AWS API Documentation
|
233
242
|
#
|
243
|
+
class AssignContactCategoryActionDefinition < Aws::EmptyStructure; end
|
244
|
+
|
234
245
|
# @!attribute [rw] instance_id
|
235
246
|
# The identifier of the Amazon Connect instance. You can find the
|
236
247
|
# instanceId in the ARN of the instance.
|
@@ -249,20 +260,6 @@ module Aws::Connect
|
|
249
260
|
include Aws::Structure
|
250
261
|
end
|
251
262
|
|
252
|
-
# @note When making an API call, you may pass AssociateBotRequest
|
253
|
-
# data as a hash:
|
254
|
-
#
|
255
|
-
# {
|
256
|
-
# instance_id: "InstanceId", # required
|
257
|
-
# lex_bot: {
|
258
|
-
# name: "BotName",
|
259
|
-
# lex_region: "LexRegion",
|
260
|
-
# },
|
261
|
-
# lex_v2_bot: {
|
262
|
-
# alias_arn: "AliasArn",
|
263
|
-
# },
|
264
|
-
# }
|
265
|
-
#
|
266
263
|
# @!attribute [rw] instance_id
|
267
264
|
# The identifier of the Amazon Connect instance. You can find the
|
268
265
|
# instanceId in the ARN of the instance.
|
@@ -286,15 +283,6 @@ module Aws::Connect
|
|
286
283
|
include Aws::Structure
|
287
284
|
end
|
288
285
|
|
289
|
-
# @note When making an API call, you may pass AssociateDefaultVocabularyRequest
|
290
|
-
# data as a hash:
|
291
|
-
#
|
292
|
-
# {
|
293
|
-
# instance_id: "InstanceId", # required
|
294
|
-
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
295
|
-
# vocabulary_id: "VocabularyId",
|
296
|
-
# }
|
297
|
-
#
|
298
286
|
# @!attribute [rw] instance_id
|
299
287
|
# The identifier of the Amazon Connect instance. You can find the
|
300
288
|
# instanceId in the ARN of the instance.
|
@@ -329,40 +317,6 @@ module Aws::Connect
|
|
329
317
|
#
|
330
318
|
class AssociateDefaultVocabularyResponse < Aws::EmptyStructure; end
|
331
319
|
|
332
|
-
# @note When making an API call, you may pass AssociateInstanceStorageConfigRequest
|
333
|
-
# data as a hash:
|
334
|
-
#
|
335
|
-
# {
|
336
|
-
# instance_id: "InstanceId", # required
|
337
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
|
338
|
-
# storage_config: { # required
|
339
|
-
# association_id: "AssociationId",
|
340
|
-
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
341
|
-
# s3_config: {
|
342
|
-
# bucket_name: "BucketName", # required
|
343
|
-
# bucket_prefix: "Prefix", # required
|
344
|
-
# encryption_config: {
|
345
|
-
# encryption_type: "KMS", # required, accepts KMS
|
346
|
-
# key_id: "KeyId", # required
|
347
|
-
# },
|
348
|
-
# },
|
349
|
-
# kinesis_video_stream_config: {
|
350
|
-
# prefix: "Prefix", # required
|
351
|
-
# retention_period_hours: 1, # required
|
352
|
-
# encryption_config: { # required
|
353
|
-
# encryption_type: "KMS", # required, accepts KMS
|
354
|
-
# key_id: "KeyId", # required
|
355
|
-
# },
|
356
|
-
# },
|
357
|
-
# kinesis_stream_config: {
|
358
|
-
# stream_arn: "ARN", # required
|
359
|
-
# },
|
360
|
-
# kinesis_firehose_config: {
|
361
|
-
# firehose_arn: "ARN", # required
|
362
|
-
# },
|
363
|
-
# },
|
364
|
-
# }
|
365
|
-
#
|
366
320
|
# @!attribute [rw] instance_id
|
367
321
|
# The identifier of the Amazon Connect instance. You can find the
|
368
322
|
# instanceId in the ARN of the instance.
|
@@ -399,14 +353,6 @@ module Aws::Connect
|
|
399
353
|
include Aws::Structure
|
400
354
|
end
|
401
355
|
|
402
|
-
# @note When making an API call, you may pass AssociateLambdaFunctionRequest
|
403
|
-
# data as a hash:
|
404
|
-
#
|
405
|
-
# {
|
406
|
-
# instance_id: "InstanceId", # required
|
407
|
-
# function_arn: "FunctionArn", # required
|
408
|
-
# }
|
409
|
-
#
|
410
356
|
# @!attribute [rw] instance_id
|
411
357
|
# The identifier of the Amazon Connect instance. You can find the
|
412
358
|
# instanceId in the ARN of the instance.
|
@@ -426,17 +372,6 @@ module Aws::Connect
|
|
426
372
|
include Aws::Structure
|
427
373
|
end
|
428
374
|
|
429
|
-
# @note When making an API call, you may pass AssociateLexBotRequest
|
430
|
-
# data as a hash:
|
431
|
-
#
|
432
|
-
# {
|
433
|
-
# instance_id: "InstanceId", # required
|
434
|
-
# lex_bot: { # required
|
435
|
-
# name: "BotName",
|
436
|
-
# lex_region: "LexRegion",
|
437
|
-
# },
|
438
|
-
# }
|
439
|
-
#
|
440
375
|
# @!attribute [rw] instance_id
|
441
376
|
# The identifier of the Amazon Connect instance. You can find the
|
442
377
|
# instanceId in the ARN of the instance.
|
@@ -455,15 +390,6 @@ module Aws::Connect
|
|
455
390
|
include Aws::Structure
|
456
391
|
end
|
457
392
|
|
458
|
-
# @note When making an API call, you may pass AssociatePhoneNumberContactFlowRequest
|
459
|
-
# data as a hash:
|
460
|
-
#
|
461
|
-
# {
|
462
|
-
# phone_number_id: "PhoneNumberId", # required
|
463
|
-
# instance_id: "InstanceId", # required
|
464
|
-
# contact_flow_id: "ContactFlowId", # required
|
465
|
-
# }
|
466
|
-
#
|
467
393
|
# @!attribute [rw] phone_number_id
|
468
394
|
# A unique identifier for the phone number.
|
469
395
|
# @return [String]
|
@@ -487,15 +413,6 @@ module Aws::Connect
|
|
487
413
|
include Aws::Structure
|
488
414
|
end
|
489
415
|
|
490
|
-
# @note When making an API call, you may pass AssociateQueueQuickConnectsRequest
|
491
|
-
# data as a hash:
|
492
|
-
#
|
493
|
-
# {
|
494
|
-
# instance_id: "InstanceId", # required
|
495
|
-
# queue_id: "QueueId", # required
|
496
|
-
# quick_connect_ids: ["QuickConnectId"], # required
|
497
|
-
# }
|
498
|
-
#
|
499
416
|
# @!attribute [rw] instance_id
|
500
417
|
# The identifier of the Amazon Connect instance. You can find the
|
501
418
|
# instanceId in the ARN of the instance.
|
@@ -519,24 +436,6 @@ module Aws::Connect
|
|
519
436
|
include Aws::Structure
|
520
437
|
end
|
521
438
|
|
522
|
-
# @note When making an API call, you may pass AssociateRoutingProfileQueuesRequest
|
523
|
-
# data as a hash:
|
524
|
-
#
|
525
|
-
# {
|
526
|
-
# instance_id: "InstanceId", # required
|
527
|
-
# routing_profile_id: "RoutingProfileId", # required
|
528
|
-
# queue_configs: [ # required
|
529
|
-
# {
|
530
|
-
# queue_reference: { # required
|
531
|
-
# queue_id: "QueueId", # required
|
532
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
533
|
-
# },
|
534
|
-
# priority: 1, # required
|
535
|
-
# delay: 1, # required
|
536
|
-
# },
|
537
|
-
# ],
|
538
|
-
# }
|
539
|
-
#
|
540
439
|
# @!attribute [rw] instance_id
|
541
440
|
# The identifier of the Amazon Connect instance. You can find the
|
542
441
|
# instanceId in the ARN of the instance.
|
@@ -560,14 +459,6 @@ module Aws::Connect
|
|
560
459
|
include Aws::Structure
|
561
460
|
end
|
562
461
|
|
563
|
-
# @note When making an API call, you may pass AssociateSecurityKeyRequest
|
564
|
-
# data as a hash:
|
565
|
-
#
|
566
|
-
# {
|
567
|
-
# instance_id: "InstanceId", # required
|
568
|
-
# key: "PEM", # required
|
569
|
-
# }
|
570
|
-
#
|
571
462
|
# @!attribute [rw] instance_id
|
572
463
|
# The identifier of the Amazon Connect instance. You can find the
|
573
464
|
# instanceId in the ARN of the instance.
|
@@ -670,14 +561,6 @@ module Aws::Connect
|
|
670
561
|
|
671
562
|
# A chat message.
|
672
563
|
#
|
673
|
-
# @note When making an API call, you may pass ChatMessage
|
674
|
-
# data as a hash:
|
675
|
-
#
|
676
|
-
# {
|
677
|
-
# content_type: "ChatContentType", # required
|
678
|
-
# content: "ChatContent", # required
|
679
|
-
# }
|
680
|
-
#
|
681
564
|
# @!attribute [rw] content_type
|
682
565
|
# The type of the content. Supported types are `text/plain`.
|
683
566
|
# @return [String]
|
@@ -698,13 +581,6 @@ module Aws::Connect
|
|
698
581
|
# The streaming configuration, such as the Amazon SNS streaming
|
699
582
|
# endpoint.
|
700
583
|
#
|
701
|
-
# @note When making an API call, you may pass ChatStreamingConfiguration
|
702
|
-
# data as a hash:
|
703
|
-
#
|
704
|
-
# {
|
705
|
-
# streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
|
706
|
-
# }
|
707
|
-
#
|
708
584
|
# @!attribute [rw] streaming_endpoint_arn
|
709
585
|
# The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The
|
710
586
|
# Amazon Resource Name (ARN) of the streaming endpoint that is used to
|
@@ -719,19 +595,6 @@ module Aws::Connect
|
|
719
595
|
include Aws::Structure
|
720
596
|
end
|
721
597
|
|
722
|
-
# @note When making an API call, you may pass ClaimPhoneNumberRequest
|
723
|
-
# data as a hash:
|
724
|
-
#
|
725
|
-
# {
|
726
|
-
# target_arn: "ARN", # required
|
727
|
-
# phone_number: "PhoneNumber", # required
|
728
|
-
# phone_number_description: "PhoneNumberDescription",
|
729
|
-
# tags: {
|
730
|
-
# "TagKey" => "TagValue",
|
731
|
-
# },
|
732
|
-
# client_token: "ClientToken",
|
733
|
-
# }
|
734
|
-
#
|
735
598
|
# @!attribute [rw] target_arn
|
736
599
|
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
737
600
|
# traffic distribution groups that phone numbers are claimed to.
|
@@ -982,13 +845,6 @@ module Aws::Connect
|
|
982
845
|
#
|
983
846
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
984
847
|
#
|
985
|
-
# @note When making an API call, you may pass ContactFilter
|
986
|
-
# data as a hash:
|
987
|
-
#
|
988
|
-
# {
|
989
|
-
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
990
|
-
# }
|
991
|
-
#
|
992
848
|
# @!attribute [rw] contact_states
|
993
849
|
# A list of up to 9 [contact states][1].
|
994
850
|
#
|
@@ -1220,30 +1076,6 @@ module Aws::Connect
|
|
1220
1076
|
# * Inner list specifies conditions that need to be applied with `AND`
|
1221
1077
|
# operator.
|
1222
1078
|
#
|
1223
|
-
# @note When making an API call, you may pass ControlPlaneTagFilter
|
1224
|
-
# data as a hash:
|
1225
|
-
#
|
1226
|
-
# {
|
1227
|
-
# or_conditions: [
|
1228
|
-
# [
|
1229
|
-
# {
|
1230
|
-
# tag_key: "String",
|
1231
|
-
# tag_value: "String",
|
1232
|
-
# },
|
1233
|
-
# ],
|
1234
|
-
# ],
|
1235
|
-
# and_conditions: [
|
1236
|
-
# {
|
1237
|
-
# tag_key: "String",
|
1238
|
-
# tag_value: "String",
|
1239
|
-
# },
|
1240
|
-
# ],
|
1241
|
-
# tag_condition: {
|
1242
|
-
# tag_key: "String",
|
1243
|
-
# tag_value: "String",
|
1244
|
-
# },
|
1245
|
-
# }
|
1246
|
-
#
|
1247
1079
|
# @!attribute [rw] or_conditions
|
1248
1080
|
# A list of conditions which would be applied together with an `OR`
|
1249
1081
|
# condition.
|
@@ -1268,20 +1100,6 @@ module Aws::Connect
|
|
1268
1100
|
include Aws::Structure
|
1269
1101
|
end
|
1270
1102
|
|
1271
|
-
# @note When making an API call, you may pass CreateAgentStatusRequest
|
1272
|
-
# data as a hash:
|
1273
|
-
#
|
1274
|
-
# {
|
1275
|
-
# instance_id: "InstanceId", # required
|
1276
|
-
# name: "AgentStatusName", # required
|
1277
|
-
# description: "AgentStatusDescription",
|
1278
|
-
# state: "ENABLED", # required, accepts ENABLED, DISABLED
|
1279
|
-
# display_order: 1,
|
1280
|
-
# tags: {
|
1281
|
-
# "TagKey" => "TagValue",
|
1282
|
-
# },
|
1283
|
-
# }
|
1284
|
-
#
|
1285
1103
|
# @!attribute [rw] instance_id
|
1286
1104
|
# The identifier of the Amazon Connect instance. You can find the
|
1287
1105
|
# instanceId in the ARN of the instance.
|
@@ -1339,20 +1157,6 @@ module Aws::Connect
|
|
1339
1157
|
include Aws::Structure
|
1340
1158
|
end
|
1341
1159
|
|
1342
|
-
# @note When making an API call, you may pass CreateContactFlowModuleRequest
|
1343
|
-
# data as a hash:
|
1344
|
-
#
|
1345
|
-
# {
|
1346
|
-
# instance_id: "InstanceId", # required
|
1347
|
-
# name: "ContactFlowModuleName", # required
|
1348
|
-
# description: "ContactFlowModuleDescription",
|
1349
|
-
# content: "ContactFlowModuleContent", # required
|
1350
|
-
# tags: {
|
1351
|
-
# "TagKey" => "TagValue",
|
1352
|
-
# },
|
1353
|
-
# client_token: "ClientToken",
|
1354
|
-
# }
|
1355
|
-
#
|
1356
1160
|
# @!attribute [rw] instance_id
|
1357
1161
|
# The identifier of the Amazon Connect instance. You can find the
|
1358
1162
|
# instanceId in the ARN of the instance.
|
@@ -1420,20 +1224,6 @@ module Aws::Connect
|
|
1420
1224
|
include Aws::Structure
|
1421
1225
|
end
|
1422
1226
|
|
1423
|
-
# @note When making an API call, you may pass CreateContactFlowRequest
|
1424
|
-
# data as a hash:
|
1425
|
-
#
|
1426
|
-
# {
|
1427
|
-
# instance_id: "InstanceId", # required
|
1428
|
-
# name: "ContactFlowName", # required
|
1429
|
-
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
1430
|
-
# description: "ContactFlowDescription",
|
1431
|
-
# content: "ContactFlowContent", # required
|
1432
|
-
# tags: {
|
1433
|
-
# "TagKey" => "TagValue",
|
1434
|
-
# },
|
1435
|
-
# }
|
1436
|
-
#
|
1437
1227
|
# @!attribute [rw] instance_id
|
1438
1228
|
# The identifier of the Amazon Connect instance.
|
1439
1229
|
# @return [String]
|
@@ -1495,32 +1285,6 @@ module Aws::Connect
|
|
1495
1285
|
include Aws::Structure
|
1496
1286
|
end
|
1497
1287
|
|
1498
|
-
# @note When making an API call, you may pass CreateHoursOfOperationRequest
|
1499
|
-
# data as a hash:
|
1500
|
-
#
|
1501
|
-
# {
|
1502
|
-
# instance_id: "InstanceId", # required
|
1503
|
-
# name: "CommonNameLength127", # required
|
1504
|
-
# description: "HoursOfOperationDescription",
|
1505
|
-
# time_zone: "TimeZone", # required
|
1506
|
-
# config: [ # required
|
1507
|
-
# {
|
1508
|
-
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
1509
|
-
# start_time: { # required
|
1510
|
-
# hours: 1, # required
|
1511
|
-
# minutes: 1, # required
|
1512
|
-
# },
|
1513
|
-
# end_time: { # required
|
1514
|
-
# hours: 1, # required
|
1515
|
-
# minutes: 1, # required
|
1516
|
-
# },
|
1517
|
-
# },
|
1518
|
-
# ],
|
1519
|
-
# tags: {
|
1520
|
-
# "TagKey" => "TagValue",
|
1521
|
-
# },
|
1522
|
-
# }
|
1523
|
-
#
|
1524
1288
|
# @!attribute [rw] instance_id
|
1525
1289
|
# The identifier of the Amazon Connect instance. You can find the
|
1526
1290
|
# instanceId in the ARN of the instance.
|
@@ -1579,18 +1343,6 @@ module Aws::Connect
|
|
1579
1343
|
include Aws::Structure
|
1580
1344
|
end
|
1581
1345
|
|
1582
|
-
# @note When making an API call, you may pass CreateInstanceRequest
|
1583
|
-
# data as a hash:
|
1584
|
-
#
|
1585
|
-
# {
|
1586
|
-
# client_token: "ClientToken",
|
1587
|
-
# identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
|
1588
|
-
# instance_alias: "DirectoryAlias",
|
1589
|
-
# directory_id: "DirectoryId",
|
1590
|
-
# inbound_calls_enabled: false, # required
|
1591
|
-
# outbound_calls_enabled: false, # required
|
1592
|
-
# }
|
1593
|
-
#
|
1594
1346
|
# @!attribute [rw] client_token
|
1595
1347
|
# The idempotency token.
|
1596
1348
|
# @return [String]
|
@@ -1645,21 +1397,6 @@ module Aws::Connect
|
|
1645
1397
|
include Aws::Structure
|
1646
1398
|
end
|
1647
1399
|
|
1648
|
-
# @note When making an API call, you may pass CreateIntegrationAssociationRequest
|
1649
|
-
# data as a hash:
|
1650
|
-
#
|
1651
|
-
# {
|
1652
|
-
# instance_id: "InstanceId", # required
|
1653
|
-
# integration_type: "EVENT", # required, accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, CASES_DOMAIN
|
1654
|
-
# integration_arn: "ARN", # required
|
1655
|
-
# source_application_url: "URI",
|
1656
|
-
# source_application_name: "SourceApplicationName",
|
1657
|
-
# source_type: "SALESFORCE", # accepts SALESFORCE, ZENDESK
|
1658
|
-
# tags: {
|
1659
|
-
# "TagKey" => "TagValue",
|
1660
|
-
# },
|
1661
|
-
# }
|
1662
|
-
#
|
1663
1400
|
# @!attribute [rw] instance_id
|
1664
1401
|
# The identifier of the Amazon Connect instance. You can find the
|
1665
1402
|
# instanceId in the ARN of the instance.
|
@@ -1730,26 +1467,6 @@ module Aws::Connect
|
|
1730
1467
|
include Aws::Structure
|
1731
1468
|
end
|
1732
1469
|
|
1733
|
-
# @note When making an API call, you may pass CreateQueueRequest
|
1734
|
-
# data as a hash:
|
1735
|
-
#
|
1736
|
-
# {
|
1737
|
-
# instance_id: "InstanceId", # required
|
1738
|
-
# name: "CommonNameLength127", # required
|
1739
|
-
# description: "QueueDescription",
|
1740
|
-
# outbound_caller_config: {
|
1741
|
-
# outbound_caller_id_name: "OutboundCallerIdName",
|
1742
|
-
# outbound_caller_id_number_id: "PhoneNumberId",
|
1743
|
-
# outbound_flow_id: "ContactFlowId",
|
1744
|
-
# },
|
1745
|
-
# hours_of_operation_id: "HoursOfOperationId", # required
|
1746
|
-
# max_contacts: 1,
|
1747
|
-
# quick_connect_ids: ["QuickConnectId"],
|
1748
|
-
# tags: {
|
1749
|
-
# "TagKey" => "TagValue",
|
1750
|
-
# },
|
1751
|
-
# }
|
1752
|
-
#
|
1753
1470
|
# @!attribute [rw] instance_id
|
1754
1471
|
# The identifier of the Amazon Connect instance. You can find the
|
1755
1472
|
# instanceId in the ARN of the instance.
|
@@ -1818,32 +1535,6 @@ module Aws::Connect
|
|
1818
1535
|
include Aws::Structure
|
1819
1536
|
end
|
1820
1537
|
|
1821
|
-
# @note When making an API call, you may pass CreateQuickConnectRequest
|
1822
|
-
# data as a hash:
|
1823
|
-
#
|
1824
|
-
# {
|
1825
|
-
# instance_id: "InstanceId", # required
|
1826
|
-
# name: "QuickConnectName", # required
|
1827
|
-
# description: "QuickConnectDescription",
|
1828
|
-
# quick_connect_config: { # required
|
1829
|
-
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
1830
|
-
# user_config: {
|
1831
|
-
# user_id: "UserId", # required
|
1832
|
-
# contact_flow_id: "ContactFlowId", # required
|
1833
|
-
# },
|
1834
|
-
# queue_config: {
|
1835
|
-
# queue_id: "QueueId", # required
|
1836
|
-
# contact_flow_id: "ContactFlowId", # required
|
1837
|
-
# },
|
1838
|
-
# phone_config: {
|
1839
|
-
# phone_number: "PhoneNumber", # required
|
1840
|
-
# },
|
1841
|
-
# },
|
1842
|
-
# tags: {
|
1843
|
-
# "TagKey" => "TagValue",
|
1844
|
-
# },
|
1845
|
-
# }
|
1846
|
-
#
|
1847
1538
|
# @!attribute [rw] instance_id
|
1848
1539
|
# The identifier of the Amazon Connect instance. You can find the
|
1849
1540
|
# instanceId in the ARN of the instance.
|
@@ -1896,35 +1587,6 @@ module Aws::Connect
|
|
1896
1587
|
include Aws::Structure
|
1897
1588
|
end
|
1898
1589
|
|
1899
|
-
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
1900
|
-
# data as a hash:
|
1901
|
-
#
|
1902
|
-
# {
|
1903
|
-
# instance_id: "InstanceId", # required
|
1904
|
-
# name: "RoutingProfileName", # required
|
1905
|
-
# description: "RoutingProfileDescription", # required
|
1906
|
-
# default_outbound_queue_id: "QueueId", # required
|
1907
|
-
# queue_configs: [
|
1908
|
-
# {
|
1909
|
-
# queue_reference: { # required
|
1910
|
-
# queue_id: "QueueId", # required
|
1911
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1912
|
-
# },
|
1913
|
-
# priority: 1, # required
|
1914
|
-
# delay: 1, # required
|
1915
|
-
# },
|
1916
|
-
# ],
|
1917
|
-
# media_concurrencies: [ # required
|
1918
|
-
# {
|
1919
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1920
|
-
# concurrency: 1, # required
|
1921
|
-
# },
|
1922
|
-
# ],
|
1923
|
-
# tags: {
|
1924
|
-
# "TagKey" => "TagValue",
|
1925
|
-
# },
|
1926
|
-
# }
|
1927
|
-
#
|
1928
1590
|
# @!attribute [rw] instance_id
|
1929
1591
|
# The identifier of the Amazon Connect instance. You can find the
|
1930
1592
|
# instanceId in the ARN of the instance.
|
@@ -1991,23 +1653,76 @@ module Aws::Connect
|
|
1991
1653
|
include Aws::Structure
|
1992
1654
|
end
|
1993
1655
|
|
1994
|
-
#
|
1995
|
-
#
|
1656
|
+
# @!attribute [rw] instance_id
|
1657
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1658
|
+
# instanceId in the ARN of the instance.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] name
|
1662
|
+
# A unique name for the rule.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] trigger_event_source
|
1666
|
+
# The event source to trigger the rule.
|
1667
|
+
# @return [Types::RuleTriggerEventSource]
|
1668
|
+
#
|
1669
|
+
# @!attribute [rw] function
|
1670
|
+
# The conditions of the rule.
|
1671
|
+
# @return [String]
|
1672
|
+
#
|
1673
|
+
# @!attribute [rw] actions
|
1674
|
+
# A list of actions to be run when the rule is triggered.
|
1675
|
+
# @return [Array<Types::RuleAction>]
|
1676
|
+
#
|
1677
|
+
# @!attribute [rw] publish_status
|
1678
|
+
# The publish status of the rule.
|
1679
|
+
# @return [String]
|
1680
|
+
#
|
1681
|
+
# @!attribute [rw] client_token
|
1682
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1683
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1684
|
+
# SDK populates this field. For more information about idempotency,
|
1685
|
+
# see [Making retries safe with idempotent APIs][1].
|
1686
|
+
#
|
1687
|
+
# **A suitable default value is auto-generated.** You should normally
|
1688
|
+
# not need to pass this option.
|
1689
|
+
#
|
1690
|
+
#
|
1691
|
+
#
|
1692
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRuleRequest AWS API Documentation
|
1696
|
+
#
|
1697
|
+
class CreateRuleRequest < Struct.new(
|
1698
|
+
:instance_id,
|
1699
|
+
:name,
|
1700
|
+
:trigger_event_source,
|
1701
|
+
:function,
|
1702
|
+
:actions,
|
1703
|
+
:publish_status,
|
1704
|
+
:client_token)
|
1705
|
+
SENSITIVE = []
|
1706
|
+
include Aws::Structure
|
1707
|
+
end
|
1708
|
+
|
1709
|
+
# @!attribute [rw] rule_arn
|
1710
|
+
# The Amazon Resource Name (ARN) of the rule.
|
1711
|
+
# @return [String]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] rule_id
|
1714
|
+
# A unique identifier for the rule.
|
1715
|
+
# @return [String]
|
1996
1716
|
#
|
1997
|
-
#
|
1998
|
-
# security_profile_name: "CreateSecurityProfileName", # required
|
1999
|
-
# description: "SecurityProfileDescription",
|
2000
|
-
# permissions: ["SecurityProfilePermission"],
|
2001
|
-
# instance_id: "InstanceId", # required
|
2002
|
-
# tags: {
|
2003
|
-
# "TagKey" => "TagValue",
|
2004
|
-
# },
|
2005
|
-
# allowed_access_control_tags: {
|
2006
|
-
# "SecurityProfilePolicyKey" => "SecurityProfilePolicyValue",
|
2007
|
-
# },
|
2008
|
-
# tag_restricted_resources: ["TagRestrictedResourceName"],
|
2009
|
-
# }
|
1717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRuleResponse AWS API Documentation
|
2010
1718
|
#
|
1719
|
+
class CreateRuleResponse < Struct.new(
|
1720
|
+
:rule_arn,
|
1721
|
+
:rule_id)
|
1722
|
+
SENSITIVE = []
|
1723
|
+
include Aws::Structure
|
1724
|
+
end
|
1725
|
+
|
2011
1726
|
# @!attribute [rw] security_profile_name
|
2012
1727
|
# The name of the security profile.
|
2013
1728
|
# @return [String]
|
@@ -2077,61 +1792,6 @@ module Aws::Connect
|
|
2077
1792
|
include Aws::Structure
|
2078
1793
|
end
|
2079
1794
|
|
2080
|
-
# @note When making an API call, you may pass CreateTaskTemplateRequest
|
2081
|
-
# data as a hash:
|
2082
|
-
#
|
2083
|
-
# {
|
2084
|
-
# instance_id: "InstanceId", # required
|
2085
|
-
# name: "TaskTemplateName", # required
|
2086
|
-
# description: "TaskTemplateDescription",
|
2087
|
-
# contact_flow_id: "ContactFlowId",
|
2088
|
-
# constraints: {
|
2089
|
-
# required_fields: [
|
2090
|
-
# {
|
2091
|
-
# id: {
|
2092
|
-
# name: "TaskTemplateFieldName",
|
2093
|
-
# },
|
2094
|
-
# },
|
2095
|
-
# ],
|
2096
|
-
# read_only_fields: [
|
2097
|
-
# {
|
2098
|
-
# id: {
|
2099
|
-
# name: "TaskTemplateFieldName",
|
2100
|
-
# },
|
2101
|
-
# },
|
2102
|
-
# ],
|
2103
|
-
# invisible_fields: [
|
2104
|
-
# {
|
2105
|
-
# id: {
|
2106
|
-
# name: "TaskTemplateFieldName",
|
2107
|
-
# },
|
2108
|
-
# },
|
2109
|
-
# ],
|
2110
|
-
# },
|
2111
|
-
# defaults: {
|
2112
|
-
# default_field_values: [
|
2113
|
-
# {
|
2114
|
-
# id: {
|
2115
|
-
# name: "TaskTemplateFieldName",
|
2116
|
-
# },
|
2117
|
-
# default_value: "TaskTemplateFieldValue",
|
2118
|
-
# },
|
2119
|
-
# ],
|
2120
|
-
# },
|
2121
|
-
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
2122
|
-
# fields: [ # required
|
2123
|
-
# {
|
2124
|
-
# id: { # required
|
2125
|
-
# name: "TaskTemplateFieldName",
|
2126
|
-
# },
|
2127
|
-
# description: "TaskTemplateFieldDescription",
|
2128
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
2129
|
-
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
2130
|
-
# },
|
2131
|
-
# ],
|
2132
|
-
# client_token: "ClientToken",
|
2133
|
-
# }
|
2134
|
-
#
|
2135
1795
|
# @!attribute [rw] instance_id
|
2136
1796
|
# The identifier of the Amazon Connect instance. You can find the
|
2137
1797
|
# instanceId in the ARN of the instance.
|
@@ -2217,19 +1877,6 @@ module Aws::Connect
|
|
2217
1877
|
include Aws::Structure
|
2218
1878
|
end
|
2219
1879
|
|
2220
|
-
# @note When making an API call, you may pass CreateTrafficDistributionGroupRequest
|
2221
|
-
# data as a hash:
|
2222
|
-
#
|
2223
|
-
# {
|
2224
|
-
# name: "Name128", # required
|
2225
|
-
# description: "Description250",
|
2226
|
-
# instance_id: "InstanceIdOrArn", # required
|
2227
|
-
# client_token: "ClientToken",
|
2228
|
-
# tags: {
|
2229
|
-
# "TagKey" => "TagValue",
|
2230
|
-
# },
|
2231
|
-
# }
|
2232
|
-
#
|
2233
1880
|
# @!attribute [rw] name
|
2234
1881
|
# The name for the traffic distribution group.
|
2235
1882
|
# @return [String]
|
@@ -2296,18 +1943,6 @@ module Aws::Connect
|
|
2296
1943
|
include Aws::Structure
|
2297
1944
|
end
|
2298
1945
|
|
2299
|
-
# @note When making an API call, you may pass CreateUseCaseRequest
|
2300
|
-
# data as a hash:
|
2301
|
-
#
|
2302
|
-
# {
|
2303
|
-
# instance_id: "InstanceId", # required
|
2304
|
-
# integration_association_id: "IntegrationAssociationId", # required
|
2305
|
-
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION, CONNECT_CAMPAIGNS
|
2306
|
-
# tags: {
|
2307
|
-
# "TagKey" => "TagValue",
|
2308
|
-
# },
|
2309
|
-
# }
|
2310
|
-
#
|
2311
1946
|
# @!attribute [rw] instance_id
|
2312
1947
|
# The identifier of the Amazon Connect instance. You can find the
|
2313
1948
|
# instanceId in the ARN of the instance.
|
@@ -2357,18 +1992,6 @@ module Aws::Connect
|
|
2357
1992
|
include Aws::Structure
|
2358
1993
|
end
|
2359
1994
|
|
2360
|
-
# @note When making an API call, you may pass CreateUserHierarchyGroupRequest
|
2361
|
-
# data as a hash:
|
2362
|
-
#
|
2363
|
-
# {
|
2364
|
-
# name: "HierarchyGroupName", # required
|
2365
|
-
# parent_group_id: "HierarchyGroupId",
|
2366
|
-
# instance_id: "InstanceId", # required
|
2367
|
-
# tags: {
|
2368
|
-
# "TagKey" => "TagValue",
|
2369
|
-
# },
|
2370
|
-
# }
|
2371
|
-
#
|
2372
1995
|
# @!attribute [rw] name
|
2373
1996
|
# The name of the user hierarchy group. Must not be more than 100
|
2374
1997
|
# characters.
|
@@ -2418,35 +2041,6 @@ module Aws::Connect
|
|
2418
2041
|
include Aws::Structure
|
2419
2042
|
end
|
2420
2043
|
|
2421
|
-
# @note When making an API call, you may pass CreateUserRequest
|
2422
|
-
# data as a hash:
|
2423
|
-
#
|
2424
|
-
# {
|
2425
|
-
# username: "AgentUsername", # required
|
2426
|
-
# password: "Password",
|
2427
|
-
# identity_info: {
|
2428
|
-
# first_name: "AgentFirstName",
|
2429
|
-
# last_name: "AgentLastName",
|
2430
|
-
# email: "Email",
|
2431
|
-
# secondary_email: "Email",
|
2432
|
-
# mobile: "PhoneNumber",
|
2433
|
-
# },
|
2434
|
-
# phone_config: { # required
|
2435
|
-
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
2436
|
-
# auto_accept: false,
|
2437
|
-
# after_contact_work_time_limit: 1,
|
2438
|
-
# desk_phone_number: "PhoneNumber",
|
2439
|
-
# },
|
2440
|
-
# directory_user_id: "DirectoryUserId",
|
2441
|
-
# security_profile_ids: ["SecurityProfileId"], # required
|
2442
|
-
# routing_profile_id: "RoutingProfileId", # required
|
2443
|
-
# hierarchy_group_id: "HierarchyGroupId",
|
2444
|
-
# instance_id: "InstanceId", # required
|
2445
|
-
# tags: {
|
2446
|
-
# "TagKey" => "TagValue",
|
2447
|
-
# },
|
2448
|
-
# }
|
2449
|
-
#
|
2450
2044
|
# @!attribute [rw] username
|
2451
2045
|
# The user name for the account. For instances not using SAML for
|
2452
2046
|
# identity management, the user name can include up to 20 characters.
|
@@ -2540,20 +2134,6 @@ module Aws::Connect
|
|
2540
2134
|
include Aws::Structure
|
2541
2135
|
end
|
2542
2136
|
|
2543
|
-
# @note When making an API call, you may pass CreateVocabularyRequest
|
2544
|
-
# data as a hash:
|
2545
|
-
#
|
2546
|
-
# {
|
2547
|
-
# client_token: "ClientToken",
|
2548
|
-
# instance_id: "InstanceId", # required
|
2549
|
-
# vocabulary_name: "VocabularyName", # required
|
2550
|
-
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
2551
|
-
# content: "VocabularyContent", # required
|
2552
|
-
# tags: {
|
2553
|
-
# "TagKey" => "TagValue",
|
2554
|
-
# },
|
2555
|
-
# }
|
2556
|
-
#
|
2557
2137
|
# @!attribute [rw] client_token
|
2558
2138
|
# A unique, case-sensitive identifier that you provide to ensure the
|
2559
2139
|
# idempotency of the request. If not provided, the Amazon Web Services
|
@@ -2684,14 +2264,6 @@ module Aws::Connect
|
|
2684
2264
|
#
|
2685
2265
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
2686
2266
|
#
|
2687
|
-
# @note When making an API call, you may pass CurrentMetric
|
2688
|
-
# data as a hash:
|
2689
|
-
#
|
2690
|
-
# {
|
2691
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
2692
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2693
|
-
# }
|
2694
|
-
#
|
2695
2267
|
# @!attribute [rw] name
|
2696
2268
|
# The name of the metric.
|
2697
2269
|
# @return [String]
|
@@ -2803,14 +2375,6 @@ module Aws::Connect
|
|
2803
2375
|
include Aws::Structure
|
2804
2376
|
end
|
2805
2377
|
|
2806
|
-
# @note When making an API call, you may pass DeleteContactFlowModuleRequest
|
2807
|
-
# data as a hash:
|
2808
|
-
#
|
2809
|
-
# {
|
2810
|
-
# instance_id: "InstanceId", # required
|
2811
|
-
# contact_flow_module_id: "ContactFlowModuleId", # required
|
2812
|
-
# }
|
2813
|
-
#
|
2814
2378
|
# @!attribute [rw] instance_id
|
2815
2379
|
# The identifier of the Amazon Connect instance. You can find the
|
2816
2380
|
# instanceId in the ARN of the instance.
|
@@ -2833,14 +2397,6 @@ module Aws::Connect
|
|
2833
2397
|
#
|
2834
2398
|
class DeleteContactFlowModuleResponse < Aws::EmptyStructure; end
|
2835
2399
|
|
2836
|
-
# @note When making an API call, you may pass DeleteContactFlowRequest
|
2837
|
-
# data as a hash:
|
2838
|
-
#
|
2839
|
-
# {
|
2840
|
-
# instance_id: "InstanceId", # required
|
2841
|
-
# contact_flow_id: "ContactFlowId", # required
|
2842
|
-
# }
|
2843
|
-
#
|
2844
2400
|
# @!attribute [rw] instance_id
|
2845
2401
|
# The identifier of the Amazon Connect instance. You can find the
|
2846
2402
|
# instanceId in the ARN of the instance.
|
@@ -2859,14 +2415,6 @@ module Aws::Connect
|
|
2859
2415
|
include Aws::Structure
|
2860
2416
|
end
|
2861
2417
|
|
2862
|
-
# @note When making an API call, you may pass DeleteHoursOfOperationRequest
|
2863
|
-
# data as a hash:
|
2864
|
-
#
|
2865
|
-
# {
|
2866
|
-
# instance_id: "InstanceId", # required
|
2867
|
-
# hours_of_operation_id: "HoursOfOperationId", # required
|
2868
|
-
# }
|
2869
|
-
#
|
2870
2418
|
# @!attribute [rw] instance_id
|
2871
2419
|
# The identifier of the Amazon Connect instance. You can find the
|
2872
2420
|
# instanceId in the ARN of the instance.
|
@@ -2885,13 +2433,6 @@ module Aws::Connect
|
|
2885
2433
|
include Aws::Structure
|
2886
2434
|
end
|
2887
2435
|
|
2888
|
-
# @note When making an API call, you may pass DeleteInstanceRequest
|
2889
|
-
# data as a hash:
|
2890
|
-
#
|
2891
|
-
# {
|
2892
|
-
# instance_id: "InstanceId", # required
|
2893
|
-
# }
|
2894
|
-
#
|
2895
2436
|
# @!attribute [rw] instance_id
|
2896
2437
|
# The identifier of the Amazon Connect instance. You can find the
|
2897
2438
|
# instanceId in the ARN of the instance.
|
@@ -2905,14 +2446,6 @@ module Aws::Connect
|
|
2905
2446
|
include Aws::Structure
|
2906
2447
|
end
|
2907
2448
|
|
2908
|
-
# @note When making an API call, you may pass DeleteIntegrationAssociationRequest
|
2909
|
-
# data as a hash:
|
2910
|
-
#
|
2911
|
-
# {
|
2912
|
-
# instance_id: "InstanceId", # required
|
2913
|
-
# integration_association_id: "IntegrationAssociationId", # required
|
2914
|
-
# }
|
2915
|
-
#
|
2916
2449
|
# @!attribute [rw] instance_id
|
2917
2450
|
# The identifier of the Amazon Connect instance. You can find the
|
2918
2451
|
# instanceId in the ARN of the instance.
|
@@ -2931,14 +2464,6 @@ module Aws::Connect
|
|
2931
2464
|
include Aws::Structure
|
2932
2465
|
end
|
2933
2466
|
|
2934
|
-
# @note When making an API call, you may pass DeleteQuickConnectRequest
|
2935
|
-
# data as a hash:
|
2936
|
-
#
|
2937
|
-
# {
|
2938
|
-
# instance_id: "InstanceId", # required
|
2939
|
-
# quick_connect_id: "QuickConnectId", # required
|
2940
|
-
# }
|
2941
|
-
#
|
2942
2467
|
# @!attribute [rw] instance_id
|
2943
2468
|
# The identifier of the Amazon Connect instance. You can find the
|
2944
2469
|
# instanceId in the ARN of the instance.
|
@@ -2957,14 +2482,24 @@ module Aws::Connect
|
|
2957
2482
|
include Aws::Structure
|
2958
2483
|
end
|
2959
2484
|
|
2960
|
-
#
|
2961
|
-
#
|
2485
|
+
# @!attribute [rw] instance_id
|
2486
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2487
|
+
# instanceId in the ARN of the instance.
|
2488
|
+
# @return [String]
|
2962
2489
|
#
|
2963
|
-
#
|
2964
|
-
#
|
2965
|
-
#
|
2966
|
-
#
|
2490
|
+
# @!attribute [rw] rule_id
|
2491
|
+
# A unique identifier for the rule.
|
2492
|
+
# @return [String]
|
2493
|
+
#
|
2494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteRuleRequest AWS API Documentation
|
2967
2495
|
#
|
2496
|
+
class DeleteRuleRequest < Struct.new(
|
2497
|
+
:instance_id,
|
2498
|
+
:rule_id)
|
2499
|
+
SENSITIVE = []
|
2500
|
+
include Aws::Structure
|
2501
|
+
end
|
2502
|
+
|
2968
2503
|
# @!attribute [rw] instance_id
|
2969
2504
|
# The identifier of the Amazon Connect instance. You can find the
|
2970
2505
|
# instanceId in the ARN of the instance.
|
@@ -2983,14 +2518,6 @@ module Aws::Connect
|
|
2983
2518
|
include Aws::Structure
|
2984
2519
|
end
|
2985
2520
|
|
2986
|
-
# @note When making an API call, you may pass DeleteTaskTemplateRequest
|
2987
|
-
# data as a hash:
|
2988
|
-
#
|
2989
|
-
# {
|
2990
|
-
# instance_id: "InstanceId", # required
|
2991
|
-
# task_template_id: "TaskTemplateId", # required
|
2992
|
-
# }
|
2993
|
-
#
|
2994
2521
|
# @!attribute [rw] instance_id
|
2995
2522
|
# The identifier of the Amazon Connect instance. You can find the
|
2996
2523
|
# instanceId in the ARN of the instance.
|
@@ -3013,13 +2540,6 @@ module Aws::Connect
|
|
3013
2540
|
#
|
3014
2541
|
class DeleteTaskTemplateResponse < Aws::EmptyStructure; end
|
3015
2542
|
|
3016
|
-
# @note When making an API call, you may pass DeleteTrafficDistributionGroupRequest
|
3017
|
-
# data as a hash:
|
3018
|
-
#
|
3019
|
-
# {
|
3020
|
-
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
3021
|
-
# }
|
3022
|
-
#
|
3023
2543
|
# @!attribute [rw] traffic_distribution_group_id
|
3024
2544
|
# The identifier of the traffic distribution group. This can be the ID
|
3025
2545
|
# or the ARN if the API is being called in the Region where the
|
@@ -3039,15 +2559,6 @@ module Aws::Connect
|
|
3039
2559
|
#
|
3040
2560
|
class DeleteTrafficDistributionGroupResponse < Aws::EmptyStructure; end
|
3041
2561
|
|
3042
|
-
# @note When making an API call, you may pass DeleteUseCaseRequest
|
3043
|
-
# data as a hash:
|
3044
|
-
#
|
3045
|
-
# {
|
3046
|
-
# instance_id: "InstanceId", # required
|
3047
|
-
# integration_association_id: "IntegrationAssociationId", # required
|
3048
|
-
# use_case_id: "UseCaseId", # required
|
3049
|
-
# }
|
3050
|
-
#
|
3051
2562
|
# @!attribute [rw] instance_id
|
3052
2563
|
# The identifier of the Amazon Connect instance. You can find the
|
3053
2564
|
# instanceId in the ARN of the instance.
|
@@ -3071,14 +2582,6 @@ module Aws::Connect
|
|
3071
2582
|
include Aws::Structure
|
3072
2583
|
end
|
3073
2584
|
|
3074
|
-
# @note When making an API call, you may pass DeleteUserHierarchyGroupRequest
|
3075
|
-
# data as a hash:
|
3076
|
-
#
|
3077
|
-
# {
|
3078
|
-
# hierarchy_group_id: "HierarchyGroupId", # required
|
3079
|
-
# instance_id: "InstanceId", # required
|
3080
|
-
# }
|
3081
|
-
#
|
3082
2585
|
# @!attribute [rw] hierarchy_group_id
|
3083
2586
|
# The identifier of the hierarchy group.
|
3084
2587
|
# @return [String]
|
@@ -3097,14 +2600,6 @@ module Aws::Connect
|
|
3097
2600
|
include Aws::Structure
|
3098
2601
|
end
|
3099
2602
|
|
3100
|
-
# @note When making an API call, you may pass DeleteUserRequest
|
3101
|
-
# data as a hash:
|
3102
|
-
#
|
3103
|
-
# {
|
3104
|
-
# instance_id: "InstanceId", # required
|
3105
|
-
# user_id: "UserId", # required
|
3106
|
-
# }
|
3107
|
-
#
|
3108
2603
|
# @!attribute [rw] instance_id
|
3109
2604
|
# The identifier of the Amazon Connect instance. You can find the
|
3110
2605
|
# instanceId in the ARN of the instance.
|
@@ -3123,14 +2618,6 @@ module Aws::Connect
|
|
3123
2618
|
include Aws::Structure
|
3124
2619
|
end
|
3125
2620
|
|
3126
|
-
# @note When making an API call, you may pass DeleteVocabularyRequest
|
3127
|
-
# data as a hash:
|
3128
|
-
#
|
3129
|
-
# {
|
3130
|
-
# instance_id: "InstanceId", # required
|
3131
|
-
# vocabulary_id: "VocabularyId", # required
|
3132
|
-
# }
|
3133
|
-
#
|
3134
2621
|
# @!attribute [rw] instance_id
|
3135
2622
|
# The identifier of the Amazon Connect instance. You can find the
|
3136
2623
|
# instanceId in the ARN of the instance.
|
@@ -3171,14 +2658,6 @@ module Aws::Connect
|
|
3171
2658
|
include Aws::Structure
|
3172
2659
|
end
|
3173
2660
|
|
3174
|
-
# @note When making an API call, you may pass DescribeAgentStatusRequest
|
3175
|
-
# data as a hash:
|
3176
|
-
#
|
3177
|
-
# {
|
3178
|
-
# instance_id: "InstanceId", # required
|
3179
|
-
# agent_status_id: "AgentStatusId", # required
|
3180
|
-
# }
|
3181
|
-
#
|
3182
2661
|
# @!attribute [rw] instance_id
|
3183
2662
|
# The identifier of the Amazon Connect instance. You can find the
|
3184
2663
|
# instanceId in the ARN of the instance.
|
@@ -3209,14 +2688,6 @@ module Aws::Connect
|
|
3209
2688
|
include Aws::Structure
|
3210
2689
|
end
|
3211
2690
|
|
3212
|
-
# @note When making an API call, you may pass DescribeContactFlowModuleRequest
|
3213
|
-
# data as a hash:
|
3214
|
-
#
|
3215
|
-
# {
|
3216
|
-
# instance_id: "InstanceId", # required
|
3217
|
-
# contact_flow_module_id: "ContactFlowModuleId", # required
|
3218
|
-
# }
|
3219
|
-
#
|
3220
2691
|
# @!attribute [rw] instance_id
|
3221
2692
|
# The identifier of the Amazon Connect instance. You can find the
|
3222
2693
|
# instanceId in the ARN of the instance.
|
@@ -3247,14 +2718,6 @@ module Aws::Connect
|
|
3247
2718
|
include Aws::Structure
|
3248
2719
|
end
|
3249
2720
|
|
3250
|
-
# @note When making an API call, you may pass DescribeContactFlowRequest
|
3251
|
-
# data as a hash:
|
3252
|
-
#
|
3253
|
-
# {
|
3254
|
-
# instance_id: "InstanceId", # required
|
3255
|
-
# contact_flow_id: "ContactFlowId", # required
|
3256
|
-
# }
|
3257
|
-
#
|
3258
2721
|
# @!attribute [rw] instance_id
|
3259
2722
|
# The identifier of the Amazon Connect instance.
|
3260
2723
|
# @return [String]
|
@@ -3284,14 +2747,6 @@ module Aws::Connect
|
|
3284
2747
|
include Aws::Structure
|
3285
2748
|
end
|
3286
2749
|
|
3287
|
-
# @note When making an API call, you may pass DescribeContactRequest
|
3288
|
-
# data as a hash:
|
3289
|
-
#
|
3290
|
-
# {
|
3291
|
-
# instance_id: "InstanceId", # required
|
3292
|
-
# contact_id: "ContactId", # required
|
3293
|
-
# }
|
3294
|
-
#
|
3295
2750
|
# @!attribute [rw] instance_id
|
3296
2751
|
# The identifier of the Amazon Connect instance. You can find the
|
3297
2752
|
# instanceId in the ARN of the instance.
|
@@ -3322,14 +2777,6 @@ module Aws::Connect
|
|
3322
2777
|
include Aws::Structure
|
3323
2778
|
end
|
3324
2779
|
|
3325
|
-
# @note When making an API call, you may pass DescribeHoursOfOperationRequest
|
3326
|
-
# data as a hash:
|
3327
|
-
#
|
3328
|
-
# {
|
3329
|
-
# instance_id: "InstanceId", # required
|
3330
|
-
# hours_of_operation_id: "HoursOfOperationId", # required
|
3331
|
-
# }
|
3332
|
-
#
|
3333
2780
|
# @!attribute [rw] instance_id
|
3334
2781
|
# The identifier of the Amazon Connect instance. You can find the
|
3335
2782
|
# instanceId in the ARN of the instance.
|
@@ -3360,14 +2807,6 @@ module Aws::Connect
|
|
3360
2807
|
include Aws::Structure
|
3361
2808
|
end
|
3362
2809
|
|
3363
|
-
# @note When making an API call, you may pass DescribeInstanceAttributeRequest
|
3364
|
-
# data as a hash:
|
3365
|
-
#
|
3366
|
-
# {
|
3367
|
-
# instance_id: "InstanceId", # required
|
3368
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING
|
3369
|
-
# }
|
3370
|
-
#
|
3371
2810
|
# @!attribute [rw] instance_id
|
3372
2811
|
# The identifier of the Amazon Connect instance. You can find the
|
3373
2812
|
# instanceId in the ARN of the instance.
|
@@ -3398,13 +2837,6 @@ module Aws::Connect
|
|
3398
2837
|
include Aws::Structure
|
3399
2838
|
end
|
3400
2839
|
|
3401
|
-
# @note When making an API call, you may pass DescribeInstanceRequest
|
3402
|
-
# data as a hash:
|
3403
|
-
#
|
3404
|
-
# {
|
3405
|
-
# instance_id: "InstanceId", # required
|
3406
|
-
# }
|
3407
|
-
#
|
3408
2840
|
# @!attribute [rw] instance_id
|
3409
2841
|
# The identifier of the Amazon Connect instance. You can find the
|
3410
2842
|
# instanceId in the ARN of the instance.
|
@@ -3430,15 +2862,6 @@ module Aws::Connect
|
|
3430
2862
|
include Aws::Structure
|
3431
2863
|
end
|
3432
2864
|
|
3433
|
-
# @note When making an API call, you may pass DescribeInstanceStorageConfigRequest
|
3434
|
-
# data as a hash:
|
3435
|
-
#
|
3436
|
-
# {
|
3437
|
-
# instance_id: "InstanceId", # required
|
3438
|
-
# association_id: "AssociationId", # required
|
3439
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
|
3440
|
-
# }
|
3441
|
-
#
|
3442
2865
|
# @!attribute [rw] instance_id
|
3443
2866
|
# The identifier of the Amazon Connect instance. You can find the
|
3444
2867
|
# instanceId in the ARN of the instance.
|
@@ -3475,13 +2898,6 @@ module Aws::Connect
|
|
3475
2898
|
include Aws::Structure
|
3476
2899
|
end
|
3477
2900
|
|
3478
|
-
# @note When making an API call, you may pass DescribePhoneNumberRequest
|
3479
|
-
# data as a hash:
|
3480
|
-
#
|
3481
|
-
# {
|
3482
|
-
# phone_number_id: "PhoneNumberId", # required
|
3483
|
-
# }
|
3484
|
-
#
|
3485
2901
|
# @!attribute [rw] phone_number_id
|
3486
2902
|
# A unique identifier for the phone number.
|
3487
2903
|
# @return [String]
|
@@ -3507,14 +2923,6 @@ module Aws::Connect
|
|
3507
2923
|
include Aws::Structure
|
3508
2924
|
end
|
3509
2925
|
|
3510
|
-
# @note When making an API call, you may pass DescribeQueueRequest
|
3511
|
-
# data as a hash:
|
3512
|
-
#
|
3513
|
-
# {
|
3514
|
-
# instance_id: "InstanceId", # required
|
3515
|
-
# queue_id: "QueueId", # required
|
3516
|
-
# }
|
3517
|
-
#
|
3518
2926
|
# @!attribute [rw] instance_id
|
3519
2927
|
# The identifier of the Amazon Connect instance. You can find the
|
3520
2928
|
# instanceId in the ARN of the instance.
|
@@ -3545,14 +2953,6 @@ module Aws::Connect
|
|
3545
2953
|
include Aws::Structure
|
3546
2954
|
end
|
3547
2955
|
|
3548
|
-
# @note When making an API call, you may pass DescribeQuickConnectRequest
|
3549
|
-
# data as a hash:
|
3550
|
-
#
|
3551
|
-
# {
|
3552
|
-
# instance_id: "InstanceId", # required
|
3553
|
-
# quick_connect_id: "QuickConnectId", # required
|
3554
|
-
# }
|
3555
|
-
#
|
3556
2956
|
# @!attribute [rw] instance_id
|
3557
2957
|
# The identifier of the Amazon Connect instance. You can find the
|
3558
2958
|
# instanceId in the ARN of the instance.
|
@@ -3583,14 +2983,6 @@ module Aws::Connect
|
|
3583
2983
|
include Aws::Structure
|
3584
2984
|
end
|
3585
2985
|
|
3586
|
-
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
3587
|
-
# data as a hash:
|
3588
|
-
#
|
3589
|
-
# {
|
3590
|
-
# instance_id: "InstanceId", # required
|
3591
|
-
# routing_profile_id: "RoutingProfileId", # required
|
3592
|
-
# }
|
3593
|
-
#
|
3594
2986
|
# @!attribute [rw] instance_id
|
3595
2987
|
# The identifier of the Amazon Connect instance. You can find the
|
3596
2988
|
# instanceId in the ARN of the instance.
|
@@ -3621,14 +3013,36 @@ module Aws::Connect
|
|
3621
3013
|
include Aws::Structure
|
3622
3014
|
end
|
3623
3015
|
|
3624
|
-
#
|
3625
|
-
#
|
3016
|
+
# @!attribute [rw] instance_id
|
3017
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3018
|
+
# instanceId in the ARN of the instance.
|
3019
|
+
# @return [String]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] rule_id
|
3022
|
+
# A unique identifier for the rule.
|
3023
|
+
# @return [String]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRuleRequest AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class DescribeRuleRequest < Struct.new(
|
3028
|
+
:instance_id,
|
3029
|
+
:rule_id)
|
3030
|
+
SENSITIVE = []
|
3031
|
+
include Aws::Structure
|
3032
|
+
end
|
3033
|
+
|
3034
|
+
# @!attribute [rw] rule
|
3035
|
+
# Information about the rule.
|
3036
|
+
# @return [Types::Rule]
|
3626
3037
|
#
|
3627
|
-
#
|
3628
|
-
# security_profile_id: "SecurityProfileId", # required
|
3629
|
-
# instance_id: "InstanceId", # required
|
3630
|
-
# }
|
3038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRuleResponse AWS API Documentation
|
3631
3039
|
#
|
3040
|
+
class DescribeRuleResponse < Struct.new(
|
3041
|
+
:rule)
|
3042
|
+
SENSITIVE = []
|
3043
|
+
include Aws::Structure
|
3044
|
+
end
|
3045
|
+
|
3632
3046
|
# @!attribute [rw] security_profile_id
|
3633
3047
|
# The identifier for the security profle.
|
3634
3048
|
# @return [String]
|
@@ -3659,13 +3073,6 @@ module Aws::Connect
|
|
3659
3073
|
include Aws::Structure
|
3660
3074
|
end
|
3661
3075
|
|
3662
|
-
# @note When making an API call, you may pass DescribeTrafficDistributionGroupRequest
|
3663
|
-
# data as a hash:
|
3664
|
-
#
|
3665
|
-
# {
|
3666
|
-
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
3667
|
-
# }
|
3668
|
-
#
|
3669
3076
|
# @!attribute [rw] traffic_distribution_group_id
|
3670
3077
|
# The identifier of the traffic distribution group. This can be the ID
|
3671
3078
|
# or the ARN if the API is being called in the Region where the
|
@@ -3693,14 +3100,6 @@ module Aws::Connect
|
|
3693
3100
|
include Aws::Structure
|
3694
3101
|
end
|
3695
3102
|
|
3696
|
-
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
3697
|
-
# data as a hash:
|
3698
|
-
#
|
3699
|
-
# {
|
3700
|
-
# hierarchy_group_id: "HierarchyGroupId", # required
|
3701
|
-
# instance_id: "InstanceId", # required
|
3702
|
-
# }
|
3703
|
-
#
|
3704
3103
|
# @!attribute [rw] hierarchy_group_id
|
3705
3104
|
# The identifier of the hierarchy group.
|
3706
3105
|
# @return [String]
|
@@ -3731,13 +3130,6 @@ module Aws::Connect
|
|
3731
3130
|
include Aws::Structure
|
3732
3131
|
end
|
3733
3132
|
|
3734
|
-
# @note When making an API call, you may pass DescribeUserHierarchyStructureRequest
|
3735
|
-
# data as a hash:
|
3736
|
-
#
|
3737
|
-
# {
|
3738
|
-
# instance_id: "InstanceId", # required
|
3739
|
-
# }
|
3740
|
-
#
|
3741
3133
|
# @!attribute [rw] instance_id
|
3742
3134
|
# The identifier of the Amazon Connect instance. You can find the
|
3743
3135
|
# instanceId in the ARN of the instance.
|
@@ -3763,14 +3155,6 @@ module Aws::Connect
|
|
3763
3155
|
include Aws::Structure
|
3764
3156
|
end
|
3765
3157
|
|
3766
|
-
# @note When making an API call, you may pass DescribeUserRequest
|
3767
|
-
# data as a hash:
|
3768
|
-
#
|
3769
|
-
# {
|
3770
|
-
# user_id: "UserId", # required
|
3771
|
-
# instance_id: "InstanceId", # required
|
3772
|
-
# }
|
3773
|
-
#
|
3774
3158
|
# @!attribute [rw] user_id
|
3775
3159
|
# The identifier of the user account.
|
3776
3160
|
# @return [String]
|
@@ -3801,14 +3185,6 @@ module Aws::Connect
|
|
3801
3185
|
include Aws::Structure
|
3802
3186
|
end
|
3803
3187
|
|
3804
|
-
# @note When making an API call, you may pass DescribeVocabularyRequest
|
3805
|
-
# data as a hash:
|
3806
|
-
#
|
3807
|
-
# {
|
3808
|
-
# instance_id: "InstanceId", # required
|
3809
|
-
# vocabulary_id: "VocabularyId", # required
|
3810
|
-
# }
|
3811
|
-
#
|
3812
3188
|
# @!attribute [rw] instance_id
|
3813
3189
|
# The identifier of the Amazon Connect instance. You can find the
|
3814
3190
|
# instanceId in the ARN of the instance.
|
@@ -3875,14 +3251,6 @@ module Aws::Connect
|
|
3875
3251
|
include Aws::Structure
|
3876
3252
|
end
|
3877
3253
|
|
3878
|
-
# @note When making an API call, you may pass DisassociateApprovedOriginRequest
|
3879
|
-
# data as a hash:
|
3880
|
-
#
|
3881
|
-
# {
|
3882
|
-
# instance_id: "InstanceId", # required
|
3883
|
-
# origin: "Origin", # required
|
3884
|
-
# }
|
3885
|
-
#
|
3886
3254
|
# @!attribute [rw] instance_id
|
3887
3255
|
# The identifier of the Amazon Connect instance. You can find the
|
3888
3256
|
# instanceId in the ARN of the instance.
|
@@ -3901,20 +3269,6 @@ module Aws::Connect
|
|
3901
3269
|
include Aws::Structure
|
3902
3270
|
end
|
3903
3271
|
|
3904
|
-
# @note When making an API call, you may pass DisassociateBotRequest
|
3905
|
-
# data as a hash:
|
3906
|
-
#
|
3907
|
-
# {
|
3908
|
-
# instance_id: "InstanceId", # required
|
3909
|
-
# lex_bot: {
|
3910
|
-
# name: "BotName",
|
3911
|
-
# lex_region: "LexRegion",
|
3912
|
-
# },
|
3913
|
-
# lex_v2_bot: {
|
3914
|
-
# alias_arn: "AliasArn",
|
3915
|
-
# },
|
3916
|
-
# }
|
3917
|
-
#
|
3918
3272
|
# @!attribute [rw] instance_id
|
3919
3273
|
# The identifier of the Amazon Connect instance. You can find the
|
3920
3274
|
# instanceId in the ARN of the instance.
|
@@ -3938,15 +3292,6 @@ module Aws::Connect
|
|
3938
3292
|
include Aws::Structure
|
3939
3293
|
end
|
3940
3294
|
|
3941
|
-
# @note When making an API call, you may pass DisassociateInstanceStorageConfigRequest
|
3942
|
-
# data as a hash:
|
3943
|
-
#
|
3944
|
-
# {
|
3945
|
-
# instance_id: "InstanceId", # required
|
3946
|
-
# association_id: "AssociationId", # required
|
3947
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
|
3948
|
-
# }
|
3949
|
-
#
|
3950
3295
|
# @!attribute [rw] instance_id
|
3951
3296
|
# The identifier of the Amazon Connect instance. You can find the
|
3952
3297
|
# instanceId in the ARN of the instance.
|
@@ -3971,14 +3316,6 @@ module Aws::Connect
|
|
3971
3316
|
include Aws::Structure
|
3972
3317
|
end
|
3973
3318
|
|
3974
|
-
# @note When making an API call, you may pass DisassociateLambdaFunctionRequest
|
3975
|
-
# data as a hash:
|
3976
|
-
#
|
3977
|
-
# {
|
3978
|
-
# instance_id: "InstanceId", # required
|
3979
|
-
# function_arn: "FunctionArn", # required
|
3980
|
-
# }
|
3981
|
-
#
|
3982
3319
|
# @!attribute [rw] instance_id
|
3983
3320
|
# The identifier of the Amazon Connect instance. You can find the
|
3984
3321
|
# instanceId in the ARN of the instance..
|
@@ -3998,15 +3335,6 @@ module Aws::Connect
|
|
3998
3335
|
include Aws::Structure
|
3999
3336
|
end
|
4000
3337
|
|
4001
|
-
# @note When making an API call, you may pass DisassociateLexBotRequest
|
4002
|
-
# data as a hash:
|
4003
|
-
#
|
4004
|
-
# {
|
4005
|
-
# instance_id: "InstanceId", # required
|
4006
|
-
# bot_name: "BotName", # required
|
4007
|
-
# lex_region: "LexRegion", # required
|
4008
|
-
# }
|
4009
|
-
#
|
4010
3338
|
# @!attribute [rw] instance_id
|
4011
3339
|
# The identifier of the Amazon Connect instance. You can find the
|
4012
3340
|
# instanceId in the ARN of the instance.
|
@@ -4031,14 +3359,6 @@ module Aws::Connect
|
|
4031
3359
|
include Aws::Structure
|
4032
3360
|
end
|
4033
3361
|
|
4034
|
-
# @note When making an API call, you may pass DisassociatePhoneNumberContactFlowRequest
|
4035
|
-
# data as a hash:
|
4036
|
-
#
|
4037
|
-
# {
|
4038
|
-
# phone_number_id: "PhoneNumberId", # required
|
4039
|
-
# instance_id: "InstanceId", # required
|
4040
|
-
# }
|
4041
|
-
#
|
4042
3362
|
# @!attribute [rw] phone_number_id
|
4043
3363
|
# A unique identifier for the phone number.
|
4044
3364
|
# @return [String]
|
@@ -4057,15 +3377,6 @@ module Aws::Connect
|
|
4057
3377
|
include Aws::Structure
|
4058
3378
|
end
|
4059
3379
|
|
4060
|
-
# @note When making an API call, you may pass DisassociateQueueQuickConnectsRequest
|
4061
|
-
# data as a hash:
|
4062
|
-
#
|
4063
|
-
# {
|
4064
|
-
# instance_id: "InstanceId", # required
|
4065
|
-
# queue_id: "QueueId", # required
|
4066
|
-
# quick_connect_ids: ["QuickConnectId"], # required
|
4067
|
-
# }
|
4068
|
-
#
|
4069
3380
|
# @!attribute [rw] instance_id
|
4070
3381
|
# The identifier of the Amazon Connect instance. You can find the
|
4071
3382
|
# instanceId in the ARN of the instance.
|
@@ -4089,20 +3400,6 @@ module Aws::Connect
|
|
4089
3400
|
include Aws::Structure
|
4090
3401
|
end
|
4091
3402
|
|
4092
|
-
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
4093
|
-
# data as a hash:
|
4094
|
-
#
|
4095
|
-
# {
|
4096
|
-
# instance_id: "InstanceId", # required
|
4097
|
-
# routing_profile_id: "RoutingProfileId", # required
|
4098
|
-
# queue_references: [ # required
|
4099
|
-
# {
|
4100
|
-
# queue_id: "QueueId", # required
|
4101
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
4102
|
-
# },
|
4103
|
-
# ],
|
4104
|
-
# }
|
4105
|
-
#
|
4106
3403
|
# @!attribute [rw] instance_id
|
4107
3404
|
# The identifier of the Amazon Connect instance. You can find the
|
4108
3405
|
# instanceId in the ARN of the instance.
|
@@ -4126,14 +3423,6 @@ module Aws::Connect
|
|
4126
3423
|
include Aws::Structure
|
4127
3424
|
end
|
4128
3425
|
|
4129
|
-
# @note When making an API call, you may pass DisassociateSecurityKeyRequest
|
4130
|
-
# data as a hash:
|
4131
|
-
#
|
4132
|
-
# {
|
4133
|
-
# instance_id: "InstanceId", # required
|
4134
|
-
# association_id: "AssociationId", # required
|
4135
|
-
# }
|
4136
|
-
#
|
4137
3426
|
# @!attribute [rw] instance_id
|
4138
3427
|
# The identifier of the Amazon Connect instance. You can find the
|
4139
3428
|
# instanceId in the ARN of the instance.
|
@@ -4153,15 +3442,6 @@ module Aws::Connect
|
|
4153
3442
|
include Aws::Structure
|
4154
3443
|
end
|
4155
3444
|
|
4156
|
-
# @note When making an API call, you may pass DismissUserContactRequest
|
4157
|
-
# data as a hash:
|
4158
|
-
#
|
4159
|
-
# {
|
4160
|
-
# user_id: "UserId", # required
|
4161
|
-
# instance_id: "InstanceId", # required
|
4162
|
-
# contact_id: "ContactId", # required
|
4163
|
-
# }
|
4164
|
-
#
|
4165
3445
|
# @!attribute [rw] user_id
|
4166
3446
|
# The identifier of the user account.
|
4167
3447
|
# @return [String]
|
@@ -4191,14 +3471,6 @@ module Aws::Connect
|
|
4191
3471
|
|
4192
3472
|
# Information about a traffic distribution.
|
4193
3473
|
#
|
4194
|
-
# @note When making an API call, you may pass Distribution
|
4195
|
-
# data as a hash:
|
4196
|
-
#
|
4197
|
-
# {
|
4198
|
-
# region: "AwsRegion", # required
|
4199
|
-
# percentage: 1, # required
|
4200
|
-
# }
|
4201
|
-
#
|
4202
3474
|
# @!attribute [rw] region
|
4203
3475
|
# The Amazon Web Services Region where the traffic is distributed.
|
4204
3476
|
# @return [String]
|
@@ -4252,14 +3524,6 @@ module Aws::Connect
|
|
4252
3524
|
|
4253
3525
|
# The encryption configuration.
|
4254
3526
|
#
|
4255
|
-
# @note When making an API call, you may pass EncryptionConfig
|
4256
|
-
# data as a hash:
|
4257
|
-
#
|
4258
|
-
# {
|
4259
|
-
# encryption_type: "KMS", # required, accepts KMS
|
4260
|
-
# key_id: "KeyId", # required
|
4261
|
-
# }
|
4262
|
-
#
|
4263
3527
|
# @!attribute [rw] encryption_type
|
4264
3528
|
# The type of encryption.
|
4265
3529
|
# @return [String]
|
@@ -4282,15 +3546,21 @@ module Aws::Connect
|
|
4282
3546
|
include Aws::Structure
|
4283
3547
|
end
|
4284
3548
|
|
4285
|
-
#
|
3549
|
+
# The EventBridge action definition.
|
3550
|
+
#
|
3551
|
+
# @!attribute [rw] name
|
3552
|
+
# The name.
|
3553
|
+
# @return [String]
|
4286
3554
|
#
|
4287
|
-
# @
|
4288
|
-
# data as a hash:
|
3555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EventBridgeActionDefinition AWS API Documentation
|
4289
3556
|
#
|
4290
|
-
|
4291
|
-
|
4292
|
-
|
4293
|
-
|
3557
|
+
class EventBridgeActionDefinition < Struct.new(
|
3558
|
+
:name)
|
3559
|
+
SENSITIVE = []
|
3560
|
+
include Aws::Structure
|
3561
|
+
end
|
3562
|
+
|
3563
|
+
# Contains the filter to apply when retrieving metrics.
|
4294
3564
|
#
|
4295
3565
|
# @!attribute [rw] queues
|
4296
3566
|
# The queues to use to filter the metrics. You should specify at least
|
@@ -4312,14 +3582,6 @@ module Aws::Connect
|
|
4312
3582
|
include Aws::Structure
|
4313
3583
|
end
|
4314
3584
|
|
4315
|
-
# @note When making an API call, you may pass GetContactAttributesRequest
|
4316
|
-
# data as a hash:
|
4317
|
-
#
|
4318
|
-
# {
|
4319
|
-
# instance_id: "InstanceId", # required
|
4320
|
-
# initial_contact_id: "ContactId", # required
|
4321
|
-
# }
|
4322
|
-
#
|
4323
3585
|
# @!attribute [rw] instance_id
|
4324
3586
|
# The identifier of the Amazon Connect instance.
|
4325
3587
|
# @return [String]
|
@@ -4349,26 +3611,6 @@ module Aws::Connect
|
|
4349
3611
|
include Aws::Structure
|
4350
3612
|
end
|
4351
3613
|
|
4352
|
-
# @note When making an API call, you may pass GetCurrentMetricDataRequest
|
4353
|
-
# data as a hash:
|
4354
|
-
#
|
4355
|
-
# {
|
4356
|
-
# instance_id: "InstanceId", # required
|
4357
|
-
# filters: { # required
|
4358
|
-
# queues: ["QueueId"],
|
4359
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
4360
|
-
# },
|
4361
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
4362
|
-
# current_metrics: [ # required
|
4363
|
-
# {
|
4364
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
4365
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
4366
|
-
# },
|
4367
|
-
# ],
|
4368
|
-
# next_token: "NextToken",
|
4369
|
-
# max_results: 1,
|
4370
|
-
# }
|
4371
|
-
#
|
4372
3614
|
# @!attribute [rw] instance_id
|
4373
3615
|
# The identifier of the Amazon Connect instance. You can find the
|
4374
3616
|
# instanceId in the ARN of the instance.
|
@@ -4565,21 +3807,6 @@ module Aws::Connect
|
|
4565
3807
|
include Aws::Structure
|
4566
3808
|
end
|
4567
3809
|
|
4568
|
-
# @note When making an API call, you may pass GetCurrentUserDataRequest
|
4569
|
-
# data as a hash:
|
4570
|
-
#
|
4571
|
-
# {
|
4572
|
-
# instance_id: "InstanceId", # required
|
4573
|
-
# filters: { # required
|
4574
|
-
# queues: ["QueueId"],
|
4575
|
-
# contact_filter: {
|
4576
|
-
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
4577
|
-
# },
|
4578
|
-
# },
|
4579
|
-
# next_token: "NextToken",
|
4580
|
-
# max_results: 1,
|
4581
|
-
# }
|
4582
|
-
#
|
4583
3810
|
# @!attribute [rw] instance_id
|
4584
3811
|
# The identifier of the Amazon Connect instance. You can find the
|
4585
3812
|
# instanceId in the ARN of the instance.
|
@@ -4630,13 +3857,6 @@ module Aws::Connect
|
|
4630
3857
|
include Aws::Structure
|
4631
3858
|
end
|
4632
3859
|
|
4633
|
-
# @note When making an API call, you may pass GetFederationTokenRequest
|
4634
|
-
# data as a hash:
|
4635
|
-
#
|
4636
|
-
# {
|
4637
|
-
# instance_id: "InstanceId", # required
|
4638
|
-
# }
|
4639
|
-
#
|
4640
3860
|
# @!attribute [rw] instance_id
|
4641
3861
|
# The identifier of the Amazon Connect instance. You can find the
|
4642
3862
|
# instanceId in the ARN of the instance.
|
@@ -4677,33 +3897,6 @@ module Aws::Connect
|
|
4677
3897
|
include Aws::Structure
|
4678
3898
|
end
|
4679
3899
|
|
4680
|
-
# @note When making an API call, you may pass GetMetricDataRequest
|
4681
|
-
# data as a hash:
|
4682
|
-
#
|
4683
|
-
# {
|
4684
|
-
# instance_id: "InstanceId", # required
|
4685
|
-
# start_time: Time.now, # required
|
4686
|
-
# end_time: Time.now, # required
|
4687
|
-
# filters: { # required
|
4688
|
-
# queues: ["QueueId"],
|
4689
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
4690
|
-
# },
|
4691
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
4692
|
-
# historical_metrics: [ # required
|
4693
|
-
# {
|
4694
|
-
# 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
|
4695
|
-
# threshold: {
|
4696
|
-
# comparison: "LT", # accepts LT
|
4697
|
-
# threshold_value: 1.0,
|
4698
|
-
# },
|
4699
|
-
# statistic: "SUM", # accepts SUM, MAX, AVG
|
4700
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
4701
|
-
# },
|
4702
|
-
# ],
|
4703
|
-
# next_token: "NextToken",
|
4704
|
-
# max_results: 1,
|
4705
|
-
# }
|
4706
|
-
#
|
4707
3900
|
# @!attribute [rw] instance_id
|
4708
3901
|
# The identifier of the Amazon Connect instance. You can find the
|
4709
3902
|
# instanceId in the ARN of the instance.
|
@@ -4974,15 +4167,6 @@ module Aws::Connect
|
|
4974
4167
|
include Aws::Structure
|
4975
4168
|
end
|
4976
4169
|
|
4977
|
-
# @note When making an API call, you may pass GetTaskTemplateRequest
|
4978
|
-
# data as a hash:
|
4979
|
-
#
|
4980
|
-
# {
|
4981
|
-
# instance_id: "InstanceId", # required
|
4982
|
-
# task_template_id: "TaskTemplateId", # required
|
4983
|
-
# snapshot_version: "SnapshotVersion",
|
4984
|
-
# }
|
4985
|
-
#
|
4986
4170
|
# @!attribute [rw] instance_id
|
4987
4171
|
# The identifier of the Amazon Connect instance. You can find the
|
4988
4172
|
# instanceId in the ARN of the instance.
|
@@ -5087,13 +4271,6 @@ module Aws::Connect
|
|
5087
4271
|
include Aws::Structure
|
5088
4272
|
end
|
5089
4273
|
|
5090
|
-
# @note When making an API call, you may pass GetTrafficDistributionRequest
|
5091
|
-
# data as a hash:
|
5092
|
-
#
|
5093
|
-
# {
|
5094
|
-
# id: "TrafficDistributionGroupIdOrArn", # required
|
5095
|
-
# }
|
5096
|
-
#
|
5097
4274
|
# @!attribute [rw] id
|
5098
4275
|
# The identifier of the traffic distribution group.
|
5099
4276
|
# @return [String]
|
@@ -5175,14 +4352,6 @@ module Aws::Connect
|
|
5175
4352
|
# A leaf node condition which can be used to specify a hierarchy group
|
5176
4353
|
# condition.
|
5177
4354
|
#
|
5178
|
-
# @note When making an API call, you may pass HierarchyGroupCondition
|
5179
|
-
# data as a hash:
|
5180
|
-
#
|
5181
|
-
# {
|
5182
|
-
# value: "String",
|
5183
|
-
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
5184
|
-
# }
|
5185
|
-
#
|
5186
4355
|
# @!attribute [rw] value
|
5187
4356
|
# The value in the hierarchy group condition.
|
5188
4357
|
# @return [String]
|
@@ -5269,13 +4438,6 @@ module Aws::Connect
|
|
5269
4438
|
|
5270
4439
|
# Contains information about the hierarchy level to update.
|
5271
4440
|
#
|
5272
|
-
# @note When making an API call, you may pass HierarchyLevelUpdate
|
5273
|
-
# data as a hash:
|
5274
|
-
#
|
5275
|
-
# {
|
5276
|
-
# name: "HierarchyLevelName", # required
|
5277
|
-
# }
|
5278
|
-
#
|
5279
4441
|
# @!attribute [rw] name
|
5280
4442
|
# The name of the user hierarchy level. Must not be more than 50
|
5281
4443
|
# characters.
|
@@ -5393,27 +4555,6 @@ module Aws::Connect
|
|
5393
4555
|
|
5394
4556
|
# Contains information about the level hierarchy to update.
|
5395
4557
|
#
|
5396
|
-
# @note When making an API call, you may pass HierarchyStructureUpdate
|
5397
|
-
# data as a hash:
|
5398
|
-
#
|
5399
|
-
# {
|
5400
|
-
# level_one: {
|
5401
|
-
# name: "HierarchyLevelName", # required
|
5402
|
-
# },
|
5403
|
-
# level_two: {
|
5404
|
-
# name: "HierarchyLevelName", # required
|
5405
|
-
# },
|
5406
|
-
# level_three: {
|
5407
|
-
# name: "HierarchyLevelName", # required
|
5408
|
-
# },
|
5409
|
-
# level_four: {
|
5410
|
-
# name: "HierarchyLevelName", # required
|
5411
|
-
# },
|
5412
|
-
# level_five: {
|
5413
|
-
# name: "HierarchyLevelName", # required
|
5414
|
-
# },
|
5415
|
-
# }
|
5416
|
-
#
|
5417
4558
|
# @!attribute [rw] level_one
|
5418
4559
|
# The update for level one.
|
5419
4560
|
# @return [Types::HierarchyLevelUpdate]
|
@@ -5454,19 +4595,6 @@ module Aws::Connect
|
|
5454
4595
|
#
|
5455
4596
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
5456
4597
|
#
|
5457
|
-
# @note When making an API call, you may pass HistoricalMetric
|
5458
|
-
# data as a hash:
|
5459
|
-
#
|
5460
|
-
# {
|
5461
|
-
# 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
|
5462
|
-
# threshold: {
|
5463
|
-
# comparison: "LT", # accepts LT
|
5464
|
-
# threshold_value: 1.0,
|
5465
|
-
# },
|
5466
|
-
# statistic: "SUM", # accepts SUM, MAX, AVG
|
5467
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
5468
|
-
# }
|
5469
|
-
#
|
5470
4598
|
# @!attribute [rw] name
|
5471
4599
|
# The name of the metric.
|
5472
4600
|
# @return [String]
|
@@ -5580,21 +4708,6 @@ module Aws::Connect
|
|
5580
4708
|
|
5581
4709
|
# Contains information about the hours of operation.
|
5582
4710
|
#
|
5583
|
-
# @note When making an API call, you may pass HoursOfOperationConfig
|
5584
|
-
# data as a hash:
|
5585
|
-
#
|
5586
|
-
# {
|
5587
|
-
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
5588
|
-
# start_time: { # required
|
5589
|
-
# hours: 1, # required
|
5590
|
-
# minutes: 1, # required
|
5591
|
-
# },
|
5592
|
-
# end_time: { # required
|
5593
|
-
# hours: 1, # required
|
5594
|
-
# minutes: 1, # required
|
5595
|
-
# },
|
5596
|
-
# }
|
5597
|
-
#
|
5598
4711
|
# @!attribute [rw] day
|
5599
4712
|
# The day that the hours of operation applies to.
|
5600
4713
|
# @return [String]
|
@@ -5644,14 +4757,6 @@ module Aws::Connect
|
|
5644
4757
|
|
5645
4758
|
# The start time or end time for an hours of operation.
|
5646
4759
|
#
|
5647
|
-
# @note When making an API call, you may pass HoursOfOperationTimeSlice
|
5648
|
-
# data as a hash:
|
5649
|
-
#
|
5650
|
-
# {
|
5651
|
-
# hours: 1, # required
|
5652
|
-
# minutes: 1, # required
|
5653
|
-
# }
|
5654
|
-
#
|
5655
4760
|
# @!attribute [rw] hours
|
5656
4761
|
# The hours.
|
5657
4762
|
# @return [Integer]
|
@@ -5758,36 +4863,6 @@ module Aws::Connect
|
|
5758
4863
|
|
5759
4864
|
# The storage configuration for the instance.
|
5760
4865
|
#
|
5761
|
-
# @note When making an API call, you may pass InstanceStorageConfig
|
5762
|
-
# data as a hash:
|
5763
|
-
#
|
5764
|
-
# {
|
5765
|
-
# association_id: "AssociationId",
|
5766
|
-
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
5767
|
-
# s3_config: {
|
5768
|
-
# bucket_name: "BucketName", # required
|
5769
|
-
# bucket_prefix: "Prefix", # required
|
5770
|
-
# encryption_config: {
|
5771
|
-
# encryption_type: "KMS", # required, accepts KMS
|
5772
|
-
# key_id: "KeyId", # required
|
5773
|
-
# },
|
5774
|
-
# },
|
5775
|
-
# kinesis_video_stream_config: {
|
5776
|
-
# prefix: "Prefix", # required
|
5777
|
-
# retention_period_hours: 1, # required
|
5778
|
-
# encryption_config: { # required
|
5779
|
-
# encryption_type: "KMS", # required, accepts KMS
|
5780
|
-
# key_id: "KeyId", # required
|
5781
|
-
# },
|
5782
|
-
# },
|
5783
|
-
# kinesis_stream_config: {
|
5784
|
-
# stream_arn: "ARN", # required
|
5785
|
-
# },
|
5786
|
-
# kinesis_firehose_config: {
|
5787
|
-
# firehose_arn: "ARN", # required
|
5788
|
-
# },
|
5789
|
-
# }
|
5790
|
-
#
|
5791
4866
|
# @!attribute [rw] association_id
|
5792
4867
|
# The existing association identifier that uniquely identifies the
|
5793
4868
|
# resource type and storage config for the given instance ID.
|
@@ -6002,15 +5077,6 @@ module Aws::Connect
|
|
6002
5077
|
|
6003
5078
|
# A field that is invisible to an agent.
|
6004
5079
|
#
|
6005
|
-
# @note When making an API call, you may pass InvisibleFieldInfo
|
6006
|
-
# data as a hash:
|
6007
|
-
#
|
6008
|
-
# {
|
6009
|
-
# id: {
|
6010
|
-
# name: "TaskTemplateFieldName",
|
6011
|
-
# },
|
6012
|
-
# }
|
6013
|
-
#
|
6014
5080
|
# @!attribute [rw] id
|
6015
5081
|
# Identifier of the invisible field.
|
6016
5082
|
# @return [Types::TaskTemplateFieldIdentifier]
|
@@ -6025,13 +5091,6 @@ module Aws::Connect
|
|
6025
5091
|
|
6026
5092
|
# Configuration information of a Kinesis Data Firehose delivery stream.
|
6027
5093
|
#
|
6028
|
-
# @note When making an API call, you may pass KinesisFirehoseConfig
|
6029
|
-
# data as a hash:
|
6030
|
-
#
|
6031
|
-
# {
|
6032
|
-
# firehose_arn: "ARN", # required
|
6033
|
-
# }
|
6034
|
-
#
|
6035
5094
|
# @!attribute [rw] firehose_arn
|
6036
5095
|
# The Amazon Resource Name (ARN) of the delivery stream.
|
6037
5096
|
# @return [String]
|
@@ -6046,13 +5105,6 @@ module Aws::Connect
|
|
6046
5105
|
|
6047
5106
|
# Configuration information of a Kinesis data stream.
|
6048
5107
|
#
|
6049
|
-
# @note When making an API call, you may pass KinesisStreamConfig
|
6050
|
-
# data as a hash:
|
6051
|
-
#
|
6052
|
-
# {
|
6053
|
-
# stream_arn: "ARN", # required
|
6054
|
-
# }
|
6055
|
-
#
|
6056
5108
|
# @!attribute [rw] stream_arn
|
6057
5109
|
# The Amazon Resource Name (ARN) of the data stream.
|
6058
5110
|
# @return [String]
|
@@ -6067,18 +5119,6 @@ module Aws::Connect
|
|
6067
5119
|
|
6068
5120
|
# Configuration information of a Kinesis video stream.
|
6069
5121
|
#
|
6070
|
-
# @note When making an API call, you may pass KinesisVideoStreamConfig
|
6071
|
-
# data as a hash:
|
6072
|
-
#
|
6073
|
-
# {
|
6074
|
-
# prefix: "Prefix", # required
|
6075
|
-
# retention_period_hours: 1, # required
|
6076
|
-
# encryption_config: { # required
|
6077
|
-
# encryption_type: "KMS", # required, accepts KMS
|
6078
|
-
# key_id: "KeyId", # required
|
6079
|
-
# },
|
6080
|
-
# }
|
6081
|
-
#
|
6082
5122
|
# @!attribute [rw] prefix
|
6083
5123
|
# The prefix of the video stream.
|
6084
5124
|
# @return [String]
|
@@ -6108,14 +5148,6 @@ module Aws::Connect
|
|
6108
5148
|
|
6109
5149
|
# Configuration information of an Amazon Lex bot.
|
6110
5150
|
#
|
6111
|
-
# @note When making an API call, you may pass LexBot
|
6112
|
-
# data as a hash:
|
6113
|
-
#
|
6114
|
-
# {
|
6115
|
-
# name: "BotName",
|
6116
|
-
# lex_region: "LexRegion",
|
6117
|
-
# }
|
6118
|
-
#
|
6119
5151
|
# @!attribute [rw] name
|
6120
5152
|
# The name of the Amazon Lex bot.
|
6121
5153
|
# @return [String]
|
@@ -6154,13 +5186,6 @@ module Aws::Connect
|
|
6154
5186
|
|
6155
5187
|
# Configuration information of an Amazon Lex V2 bot.
|
6156
5188
|
#
|
6157
|
-
# @note When making an API call, you may pass LexV2Bot
|
6158
|
-
# data as a hash:
|
6159
|
-
#
|
6160
|
-
# {
|
6161
|
-
# alias_arn: "AliasArn",
|
6162
|
-
# }
|
6163
|
-
#
|
6164
5189
|
# @!attribute [rw] alias_arn
|
6165
5190
|
# The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
|
6166
5191
|
# @return [String]
|
@@ -6187,16 +5212,6 @@ module Aws::Connect
|
|
6187
5212
|
include Aws::Structure
|
6188
5213
|
end
|
6189
5214
|
|
6190
|
-
# @note When making an API call, you may pass ListAgentStatusRequest
|
6191
|
-
# data as a hash:
|
6192
|
-
#
|
6193
|
-
# {
|
6194
|
-
# instance_id: "InstanceId", # required
|
6195
|
-
# next_token: "NextToken",
|
6196
|
-
# max_results: 1,
|
6197
|
-
# agent_status_types: ["ROUTABLE"], # accepts ROUTABLE, CUSTOM, OFFLINE
|
6198
|
-
# }
|
6199
|
-
#
|
6200
5215
|
# @!attribute [rw] instance_id
|
6201
5216
|
# The identifier of the Amazon Connect instance. You can find the
|
6202
5217
|
# instanceId in the ARN of the instance.
|
@@ -6245,15 +5260,6 @@ module Aws::Connect
|
|
6245
5260
|
include Aws::Structure
|
6246
5261
|
end
|
6247
5262
|
|
6248
|
-
# @note When making an API call, you may pass ListApprovedOriginsRequest
|
6249
|
-
# data as a hash:
|
6250
|
-
#
|
6251
|
-
# {
|
6252
|
-
# instance_id: "InstanceId", # required
|
6253
|
-
# next_token: "NextToken",
|
6254
|
-
# max_results: 1,
|
6255
|
-
# }
|
6256
|
-
#
|
6257
5263
|
# @!attribute [rw] instance_id
|
6258
5264
|
# The identifier of the Amazon Connect instance. You can find the
|
6259
5265
|
# instanceId in the ARN of the instance.
|
@@ -6297,16 +5303,6 @@ module Aws::Connect
|
|
6297
5303
|
include Aws::Structure
|
6298
5304
|
end
|
6299
5305
|
|
6300
|
-
# @note When making an API call, you may pass ListBotsRequest
|
6301
|
-
# data as a hash:
|
6302
|
-
#
|
6303
|
-
# {
|
6304
|
-
# instance_id: "InstanceId", # required
|
6305
|
-
# next_token: "NextToken",
|
6306
|
-
# max_results: 1,
|
6307
|
-
# lex_version: "V1", # required, accepts V1, V2
|
6308
|
-
# }
|
6309
|
-
#
|
6310
5306
|
# @!attribute [rw] instance_id
|
6311
5307
|
# The identifier of the Amazon Connect instance. You can find the
|
6312
5308
|
# instanceId in the ARN of the instance.
|
@@ -6356,16 +5352,6 @@ module Aws::Connect
|
|
6356
5352
|
include Aws::Structure
|
6357
5353
|
end
|
6358
5354
|
|
6359
|
-
# @note When making an API call, you may pass ListContactFlowModulesRequest
|
6360
|
-
# data as a hash:
|
6361
|
-
#
|
6362
|
-
# {
|
6363
|
-
# instance_id: "InstanceId", # required
|
6364
|
-
# next_token: "NextToken",
|
6365
|
-
# max_results: 1,
|
6366
|
-
# contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
6367
|
-
# }
|
6368
|
-
#
|
6369
5355
|
# @!attribute [rw] instance_id
|
6370
5356
|
# The identifier of the Amazon Connect instance. You can find the
|
6371
5357
|
# instanceId in the ARN of the instance.
|
@@ -6414,16 +5400,6 @@ module Aws::Connect
|
|
6414
5400
|
include Aws::Structure
|
6415
5401
|
end
|
6416
5402
|
|
6417
|
-
# @note When making an API call, you may pass ListContactFlowsRequest
|
6418
|
-
# data as a hash:
|
6419
|
-
#
|
6420
|
-
# {
|
6421
|
-
# instance_id: "InstanceId", # required
|
6422
|
-
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
6423
|
-
# next_token: "NextToken",
|
6424
|
-
# max_results: 1,
|
6425
|
-
# }
|
6426
|
-
#
|
6427
5403
|
# @!attribute [rw] instance_id
|
6428
5404
|
# The identifier of the Amazon Connect instance. You can find the
|
6429
5405
|
# instanceId in the ARN of the instance.
|
@@ -6473,16 +5449,6 @@ module Aws::Connect
|
|
6473
5449
|
include Aws::Structure
|
6474
5450
|
end
|
6475
5451
|
|
6476
|
-
# @note When making an API call, you may pass ListContactReferencesRequest
|
6477
|
-
# data as a hash:
|
6478
|
-
#
|
6479
|
-
# {
|
6480
|
-
# instance_id: "InstanceId", # required
|
6481
|
-
# contact_id: "ContactId", # required
|
6482
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
6483
|
-
# next_token: "NextToken",
|
6484
|
-
# }
|
6485
|
-
#
|
6486
5452
|
# @!attribute [rw] instance_id
|
6487
5453
|
# The identifier of the Amazon Connect instance. You can find the
|
6488
5454
|
# instanceId in the ARN of the instance.
|
@@ -6536,16 +5502,6 @@ module Aws::Connect
|
|
6536
5502
|
include Aws::Structure
|
6537
5503
|
end
|
6538
5504
|
|
6539
|
-
# @note When making an API call, you may pass ListDefaultVocabulariesRequest
|
6540
|
-
# data as a hash:
|
6541
|
-
#
|
6542
|
-
# {
|
6543
|
-
# instance_id: "InstanceId", # required
|
6544
|
-
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
6545
|
-
# max_results: 1,
|
6546
|
-
# next_token: "VocabularyNextToken",
|
6547
|
-
# }
|
6548
|
-
#
|
6549
5505
|
# @!attribute [rw] instance_id
|
6550
5506
|
# The identifier of the Amazon Connect instance. You can find the
|
6551
5507
|
# instanceId in the ARN of the instance.
|
@@ -6600,15 +5556,6 @@ module Aws::Connect
|
|
6600
5556
|
include Aws::Structure
|
6601
5557
|
end
|
6602
5558
|
|
6603
|
-
# @note When making an API call, you may pass ListHoursOfOperationsRequest
|
6604
|
-
# data as a hash:
|
6605
|
-
#
|
6606
|
-
# {
|
6607
|
-
# instance_id: "InstanceId", # required
|
6608
|
-
# next_token: "NextToken",
|
6609
|
-
# max_results: 1,
|
6610
|
-
# }
|
6611
|
-
#
|
6612
5559
|
# @!attribute [rw] instance_id
|
6613
5560
|
# The identifier of the Amazon Connect instance. You can find the
|
6614
5561
|
# instanceId in the ARN of the instance.
|
@@ -6653,15 +5600,6 @@ module Aws::Connect
|
|
6653
5600
|
include Aws::Structure
|
6654
5601
|
end
|
6655
5602
|
|
6656
|
-
# @note When making an API call, you may pass ListInstanceAttributesRequest
|
6657
|
-
# data as a hash:
|
6658
|
-
#
|
6659
|
-
# {
|
6660
|
-
# instance_id: "InstanceId", # required
|
6661
|
-
# next_token: "NextToken",
|
6662
|
-
# max_results: 1,
|
6663
|
-
# }
|
6664
|
-
#
|
6665
5603
|
# @!attribute [rw] instance_id
|
6666
5604
|
# The identifier of the Amazon Connect instance. You can find the
|
6667
5605
|
# instanceId in the ARN of the instance.
|
@@ -6705,16 +5643,6 @@ module Aws::Connect
|
|
6705
5643
|
include Aws::Structure
|
6706
5644
|
end
|
6707
5645
|
|
6708
|
-
# @note When making an API call, you may pass ListInstanceStorageConfigsRequest
|
6709
|
-
# data as a hash:
|
6710
|
-
#
|
6711
|
-
# {
|
6712
|
-
# instance_id: "InstanceId", # required
|
6713
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
|
6714
|
-
# next_token: "NextToken",
|
6715
|
-
# max_results: 1,
|
6716
|
-
# }
|
6717
|
-
#
|
6718
5646
|
# @!attribute [rw] instance_id
|
6719
5647
|
# The identifier of the Amazon Connect instance. You can find the
|
6720
5648
|
# instanceId in the ARN of the instance.
|
@@ -6763,14 +5691,6 @@ module Aws::Connect
|
|
6763
5691
|
include Aws::Structure
|
6764
5692
|
end
|
6765
5693
|
|
6766
|
-
# @note When making an API call, you may pass ListInstancesRequest
|
6767
|
-
# data as a hash:
|
6768
|
-
#
|
6769
|
-
# {
|
6770
|
-
# next_token: "NextToken",
|
6771
|
-
# max_results: 1,
|
6772
|
-
# }
|
6773
|
-
#
|
6774
5694
|
# @!attribute [rw] next_token
|
6775
5695
|
# The token for the next set of results. Use the value returned in the
|
6776
5696
|
# previous response in the next request to retrieve the next set of
|
@@ -6808,16 +5728,6 @@ module Aws::Connect
|
|
6808
5728
|
include Aws::Structure
|
6809
5729
|
end
|
6810
5730
|
|
6811
|
-
# @note When making an API call, you may pass ListIntegrationAssociationsRequest
|
6812
|
-
# data as a hash:
|
6813
|
-
#
|
6814
|
-
# {
|
6815
|
-
# instance_id: "InstanceId", # required
|
6816
|
-
# integration_type: "EVENT", # accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, CASES_DOMAIN
|
6817
|
-
# next_token: "NextToken",
|
6818
|
-
# max_results: 1,
|
6819
|
-
# }
|
6820
|
-
#
|
6821
5731
|
# @!attribute [rw] instance_id
|
6822
5732
|
# The identifier of the Amazon Connect instance. You can find the
|
6823
5733
|
# instanceId in the ARN of the instance.
|
@@ -6866,15 +5776,6 @@ module Aws::Connect
|
|
6866
5776
|
include Aws::Structure
|
6867
5777
|
end
|
6868
5778
|
|
6869
|
-
# @note When making an API call, you may pass ListLambdaFunctionsRequest
|
6870
|
-
# data as a hash:
|
6871
|
-
#
|
6872
|
-
# {
|
6873
|
-
# instance_id: "InstanceId", # required
|
6874
|
-
# next_token: "NextToken",
|
6875
|
-
# max_results: 1,
|
6876
|
-
# }
|
6877
|
-
#
|
6878
5779
|
# @!attribute [rw] instance_id
|
6879
5780
|
# The identifier of the Amazon Connect instance. You can find the
|
6880
5781
|
# instanceId in the ARN of the instance.
|
@@ -6918,15 +5819,6 @@ module Aws::Connect
|
|
6918
5819
|
include Aws::Structure
|
6919
5820
|
end
|
6920
5821
|
|
6921
|
-
# @note When making an API call, you may pass ListLexBotsRequest
|
6922
|
-
# data as a hash:
|
6923
|
-
#
|
6924
|
-
# {
|
6925
|
-
# instance_id: "InstanceId", # required
|
6926
|
-
# next_token: "NextToken",
|
6927
|
-
# max_results: 1,
|
6928
|
-
# }
|
6929
|
-
#
|
6930
5822
|
# @!attribute [rw] instance_id
|
6931
5823
|
# The identifier of the Amazon Connect instance. You can find the
|
6932
5824
|
# instanceId in the ARN of the instance.
|
@@ -6972,17 +5864,6 @@ module Aws::Connect
|
|
6972
5864
|
include Aws::Structure
|
6973
5865
|
end
|
6974
5866
|
|
6975
|
-
# @note When making an API call, you may pass ListPhoneNumbersRequest
|
6976
|
-
# data as a hash:
|
6977
|
-
#
|
6978
|
-
# {
|
6979
|
-
# instance_id: "InstanceId", # required
|
6980
|
-
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
|
6981
|
-
# phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
|
6982
|
-
# next_token: "NextToken",
|
6983
|
-
# max_results: 1,
|
6984
|
-
# }
|
6985
|
-
#
|
6986
5867
|
# @!attribute [rw] instance_id
|
6987
5868
|
# The identifier of the Amazon Connect instance. You can find the
|
6988
5869
|
# instanceId in the ARN of the instance.
|
@@ -7079,18 +5960,6 @@ module Aws::Connect
|
|
7079
5960
|
include Aws::Structure
|
7080
5961
|
end
|
7081
5962
|
|
7082
|
-
# @note When making an API call, you may pass ListPhoneNumbersV2Request
|
7083
|
-
# data as a hash:
|
7084
|
-
#
|
7085
|
-
# {
|
7086
|
-
# target_arn: "ARN",
|
7087
|
-
# max_results: 1,
|
7088
|
-
# next_token: "LargeNextToken",
|
7089
|
-
# phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
|
7090
|
-
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
|
7091
|
-
# phone_number_prefix: "PhoneNumberPrefix",
|
7092
|
-
# }
|
7093
|
-
#
|
7094
5963
|
# @!attribute [rw] target_arn
|
7095
5964
|
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
7096
5965
|
# traffic distribution groups that phone numbers are claimed to. If
|
@@ -7154,15 +6023,6 @@ module Aws::Connect
|
|
7154
6023
|
include Aws::Structure
|
7155
6024
|
end
|
7156
6025
|
|
7157
|
-
# @note When making an API call, you may pass ListPromptsRequest
|
7158
|
-
# data as a hash:
|
7159
|
-
#
|
7160
|
-
# {
|
7161
|
-
# instance_id: "InstanceId", # required
|
7162
|
-
# next_token: "NextToken",
|
7163
|
-
# max_results: 1,
|
7164
|
-
# }
|
7165
|
-
#
|
7166
6026
|
# @!attribute [rw] instance_id
|
7167
6027
|
# The identifier of the Amazon Connect instance.
|
7168
6028
|
# @return [String]
|
@@ -7206,16 +6066,6 @@ module Aws::Connect
|
|
7206
6066
|
include Aws::Structure
|
7207
6067
|
end
|
7208
6068
|
|
7209
|
-
# @note When making an API call, you may pass ListQueueQuickConnectsRequest
|
7210
|
-
# data as a hash:
|
7211
|
-
#
|
7212
|
-
# {
|
7213
|
-
# instance_id: "InstanceId", # required
|
7214
|
-
# queue_id: "QueueId", # required
|
7215
|
-
# next_token: "NextToken",
|
7216
|
-
# max_results: 1,
|
7217
|
-
# }
|
7218
|
-
#
|
7219
6069
|
# @!attribute [rw] instance_id
|
7220
6070
|
# The identifier of the Amazon Connect instance. You can find the
|
7221
6071
|
# instanceId in the ARN of the instance.
|
@@ -7265,16 +6115,6 @@ module Aws::Connect
|
|
7265
6115
|
include Aws::Structure
|
7266
6116
|
end
|
7267
6117
|
|
7268
|
-
# @note When making an API call, you may pass ListQueuesRequest
|
7269
|
-
# data as a hash:
|
7270
|
-
#
|
7271
|
-
# {
|
7272
|
-
# instance_id: "InstanceId", # required
|
7273
|
-
# queue_types: ["STANDARD"], # accepts STANDARD, AGENT
|
7274
|
-
# next_token: "NextToken",
|
7275
|
-
# max_results: 1,
|
7276
|
-
# }
|
7277
|
-
#
|
7278
6118
|
# @!attribute [rw] instance_id
|
7279
6119
|
# The identifier of the Amazon Connect instance. You can find the
|
7280
6120
|
# instanceId in the ARN of the instance.
|
@@ -7324,16 +6164,6 @@ module Aws::Connect
|
|
7324
6164
|
include Aws::Structure
|
7325
6165
|
end
|
7326
6166
|
|
7327
|
-
# @note When making an API call, you may pass ListQuickConnectsRequest
|
7328
|
-
# data as a hash:
|
7329
|
-
#
|
7330
|
-
# {
|
7331
|
-
# instance_id: "InstanceId", # required
|
7332
|
-
# next_token: "NextToken",
|
7333
|
-
# max_results: 1,
|
7334
|
-
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
7335
|
-
# }
|
7336
|
-
#
|
7337
6167
|
# @!attribute [rw] instance_id
|
7338
6168
|
# The identifier of the Amazon Connect instance. You can find the
|
7339
6169
|
# instanceId in the ARN of the instance.
|
@@ -7386,16 +6216,6 @@ module Aws::Connect
|
|
7386
6216
|
include Aws::Structure
|
7387
6217
|
end
|
7388
6218
|
|
7389
|
-
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
7390
|
-
# data as a hash:
|
7391
|
-
#
|
7392
|
-
# {
|
7393
|
-
# instance_id: "InstanceId", # required
|
7394
|
-
# routing_profile_id: "RoutingProfileId", # required
|
7395
|
-
# next_token: "NextToken",
|
7396
|
-
# max_results: 1,
|
7397
|
-
# }
|
7398
|
-
#
|
7399
6219
|
# @!attribute [rw] instance_id
|
7400
6220
|
# The identifier of the Amazon Connect instance. You can find the
|
7401
6221
|
# instanceId in the ARN of the instance.
|
@@ -7445,15 +6265,6 @@ module Aws::Connect
|
|
7445
6265
|
include Aws::Structure
|
7446
6266
|
end
|
7447
6267
|
|
7448
|
-
# @note When making an API call, you may pass ListRoutingProfilesRequest
|
7449
|
-
# data as a hash:
|
7450
|
-
#
|
7451
|
-
# {
|
7452
|
-
# instance_id: "InstanceId", # required
|
7453
|
-
# next_token: "NextToken",
|
7454
|
-
# max_results: 1,
|
7455
|
-
# }
|
7456
|
-
#
|
7457
6268
|
# @!attribute [rw] instance_id
|
7458
6269
|
# The identifier of the Amazon Connect instance. You can find the
|
7459
6270
|
# instanceId in the ARN of the instance.
|
@@ -7498,15 +6309,59 @@ module Aws::Connect
|
|
7498
6309
|
include Aws::Structure
|
7499
6310
|
end
|
7500
6311
|
|
7501
|
-
#
|
7502
|
-
#
|
6312
|
+
# @!attribute [rw] instance_id
|
6313
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6314
|
+
# instanceId in the ARN of the instance.
|
6315
|
+
# @return [String]
|
6316
|
+
#
|
6317
|
+
# @!attribute [rw] publish_status
|
6318
|
+
# The publish status of the rule.
|
6319
|
+
# @return [String]
|
6320
|
+
#
|
6321
|
+
# @!attribute [rw] event_source_name
|
6322
|
+
# The name of the event source.
|
6323
|
+
# @return [String]
|
6324
|
+
#
|
6325
|
+
# @!attribute [rw] max_results
|
6326
|
+
# The maximum number of results to return per page.
|
6327
|
+
# @return [Integer]
|
6328
|
+
#
|
6329
|
+
# @!attribute [rw] next_token
|
6330
|
+
# The token for the next set of results. Use the value returned in the
|
6331
|
+
# previous response in the next request to retrieve the next set of
|
6332
|
+
# results.
|
6333
|
+
# @return [String]
|
6334
|
+
#
|
6335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRulesRequest AWS API Documentation
|
6336
|
+
#
|
6337
|
+
class ListRulesRequest < Struct.new(
|
6338
|
+
:instance_id,
|
6339
|
+
:publish_status,
|
6340
|
+
:event_source_name,
|
6341
|
+
:max_results,
|
6342
|
+
:next_token)
|
6343
|
+
SENSITIVE = []
|
6344
|
+
include Aws::Structure
|
6345
|
+
end
|
6346
|
+
|
6347
|
+
# @!attribute [rw] rule_summary_list
|
6348
|
+
# Summary information about a rule.
|
6349
|
+
# @return [Array<Types::RuleSummary>]
|
7503
6350
|
#
|
7504
|
-
#
|
7505
|
-
#
|
7506
|
-
#
|
7507
|
-
#
|
7508
|
-
# }
|
6351
|
+
# @!attribute [rw] next_token
|
6352
|
+
# If there are additional results, this is the token for the next set
|
6353
|
+
# of results.
|
6354
|
+
# @return [String]
|
7509
6355
|
#
|
6356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRulesResponse AWS API Documentation
|
6357
|
+
#
|
6358
|
+
class ListRulesResponse < Struct.new(
|
6359
|
+
:rule_summary_list,
|
6360
|
+
:next_token)
|
6361
|
+
SENSITIVE = []
|
6362
|
+
include Aws::Structure
|
6363
|
+
end
|
6364
|
+
|
7510
6365
|
# @!attribute [rw] instance_id
|
7511
6366
|
# The identifier of the Amazon Connect instance. You can find the
|
7512
6367
|
# instanceId in the ARN of the instance.
|
@@ -7550,16 +6405,6 @@ module Aws::Connect
|
|
7550
6405
|
include Aws::Structure
|
7551
6406
|
end
|
7552
6407
|
|
7553
|
-
# @note When making an API call, you may pass ListSecurityProfilePermissionsRequest
|
7554
|
-
# data as a hash:
|
7555
|
-
#
|
7556
|
-
# {
|
7557
|
-
# security_profile_id: "SecurityProfileId", # required
|
7558
|
-
# instance_id: "InstanceId", # required
|
7559
|
-
# next_token: "NextToken",
|
7560
|
-
# max_results: 1,
|
7561
|
-
# }
|
7562
|
-
#
|
7563
6408
|
# @!attribute [rw] security_profile_id
|
7564
6409
|
# The identifier for the security profle.
|
7565
6410
|
# @return [String]
|
@@ -7613,15 +6458,6 @@ module Aws::Connect
|
|
7613
6458
|
include Aws::Structure
|
7614
6459
|
end
|
7615
6460
|
|
7616
|
-
# @note When making an API call, you may pass ListSecurityProfilesRequest
|
7617
|
-
# data as a hash:
|
7618
|
-
#
|
7619
|
-
# {
|
7620
|
-
# instance_id: "InstanceId", # required
|
7621
|
-
# next_token: "NextToken",
|
7622
|
-
# max_results: 1,
|
7623
|
-
# }
|
7624
|
-
#
|
7625
6461
|
# @!attribute [rw] instance_id
|
7626
6462
|
# The identifier of the Amazon Connect instance. You can find the
|
7627
6463
|
# instanceId in the ARN of the instance.
|
@@ -7666,13 +6502,6 @@ module Aws::Connect
|
|
7666
6502
|
include Aws::Structure
|
7667
6503
|
end
|
7668
6504
|
|
7669
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
7670
|
-
# data as a hash:
|
7671
|
-
#
|
7672
|
-
# {
|
7673
|
-
# resource_arn: "ARN", # required
|
7674
|
-
# }
|
7675
|
-
#
|
7676
6505
|
# @!attribute [rw] resource_arn
|
7677
6506
|
# The Amazon Resource Name (ARN) of the resource.
|
7678
6507
|
# @return [String]
|
@@ -7697,17 +6526,6 @@ module Aws::Connect
|
|
7697
6526
|
include Aws::Structure
|
7698
6527
|
end
|
7699
6528
|
|
7700
|
-
# @note When making an API call, you may pass ListTaskTemplatesRequest
|
7701
|
-
# data as a hash:
|
7702
|
-
#
|
7703
|
-
# {
|
7704
|
-
# instance_id: "InstanceId", # required
|
7705
|
-
# next_token: "NextToken",
|
7706
|
-
# max_results: 1,
|
7707
|
-
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
7708
|
-
# name: "TaskTemplateName",
|
7709
|
-
# }
|
7710
|
-
#
|
7711
6529
|
# @!attribute [rw] instance_id
|
7712
6530
|
# The identifier of the Amazon Connect instance. You can find the
|
7713
6531
|
# instanceId in the ARN of the instance.
|
@@ -7772,15 +6590,6 @@ module Aws::Connect
|
|
7772
6590
|
include Aws::Structure
|
7773
6591
|
end
|
7774
6592
|
|
7775
|
-
# @note When making an API call, you may pass ListTrafficDistributionGroupsRequest
|
7776
|
-
# data as a hash:
|
7777
|
-
#
|
7778
|
-
# {
|
7779
|
-
# max_results: 1,
|
7780
|
-
# next_token: "NextToken",
|
7781
|
-
# instance_id: "InstanceIdOrArn",
|
7782
|
-
# }
|
7783
|
-
#
|
7784
6593
|
# @!attribute [rw] max_results
|
7785
6594
|
# The maximum number of results to return per page.
|
7786
6595
|
# @return [Integer]
|
@@ -7827,16 +6636,6 @@ module Aws::Connect
|
|
7827
6636
|
# Provides summary information about the use cases for the specified
|
7828
6637
|
# integration association.
|
7829
6638
|
#
|
7830
|
-
# @note When making an API call, you may pass ListUseCasesRequest
|
7831
|
-
# data as a hash:
|
7832
|
-
#
|
7833
|
-
# {
|
7834
|
-
# instance_id: "InstanceId", # required
|
7835
|
-
# integration_association_id: "IntegrationAssociationId", # required
|
7836
|
-
# next_token: "NextToken",
|
7837
|
-
# max_results: 1,
|
7838
|
-
# }
|
7839
|
-
#
|
7840
6639
|
# @!attribute [rw] instance_id
|
7841
6640
|
# The identifier of the Amazon Connect instance. You can find the
|
7842
6641
|
# instanceId in the ARN of the instance.
|
@@ -7885,15 +6684,6 @@ module Aws::Connect
|
|
7885
6684
|
include Aws::Structure
|
7886
6685
|
end
|
7887
6686
|
|
7888
|
-
# @note When making an API call, you may pass ListUserHierarchyGroupsRequest
|
7889
|
-
# data as a hash:
|
7890
|
-
#
|
7891
|
-
# {
|
7892
|
-
# instance_id: "InstanceId", # required
|
7893
|
-
# next_token: "NextToken",
|
7894
|
-
# max_results: 1,
|
7895
|
-
# }
|
7896
|
-
#
|
7897
6687
|
# @!attribute [rw] instance_id
|
7898
6688
|
# The identifier of the Amazon Connect instance. You can find the
|
7899
6689
|
# instanceId in the ARN of the instance.
|
@@ -7938,15 +6728,6 @@ module Aws::Connect
|
|
7938
6728
|
include Aws::Structure
|
7939
6729
|
end
|
7940
6730
|
|
7941
|
-
# @note When making an API call, you may pass ListUsersRequest
|
7942
|
-
# data as a hash:
|
7943
|
-
#
|
7944
|
-
# {
|
7945
|
-
# instance_id: "InstanceId", # required
|
7946
|
-
# next_token: "NextToken",
|
7947
|
-
# max_results: 1,
|
7948
|
-
# }
|
7949
|
-
#
|
7950
6731
|
# @!attribute [rw] instance_id
|
7951
6732
|
# The identifier of the Amazon Connect instance. You can find the
|
7952
6733
|
# instanceId in the ARN of the instance.
|
@@ -7994,14 +6775,6 @@ module Aws::Connect
|
|
7994
6775
|
# Contains information about which channels are supported, and how many
|
7995
6776
|
# contacts an agent can have on a channel simultaneously.
|
7996
6777
|
#
|
7997
|
-
# @note When making an API call, you may pass MediaConcurrency
|
7998
|
-
# data as a hash:
|
7999
|
-
#
|
8000
|
-
# {
|
8001
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
8002
|
-
# concurrency: 1, # required
|
8003
|
-
# }
|
8004
|
-
#
|
8005
6778
|
# @!attribute [rw] channel
|
8006
6779
|
# The channels that agents can handle in the Contact Control Panel
|
8007
6780
|
# (CCP).
|
@@ -8027,17 +6800,6 @@ module Aws::Connect
|
|
8027
6800
|
include Aws::Structure
|
8028
6801
|
end
|
8029
6802
|
|
8030
|
-
# @note When making an API call, you may pass MonitorContactRequest
|
8031
|
-
# data as a hash:
|
8032
|
-
#
|
8033
|
-
# {
|
8034
|
-
# instance_id: "InstanceId", # required
|
8035
|
-
# contact_id: "ContactId", # required
|
8036
|
-
# user_id: "AgentResourceId", # required
|
8037
|
-
# allowed_monitor_capabilities: ["SILENT_MONITOR"], # accepts SILENT_MONITOR, BARGE
|
8038
|
-
# client_token: "ClientToken",
|
8039
|
-
# }
|
8040
|
-
#
|
8041
6803
|
# @!attribute [rw] instance_id
|
8042
6804
|
# The identifier of the Amazon Connect instance. You can find the
|
8043
6805
|
# instanceId in the ARN of the instance.
|
@@ -8100,6 +6862,28 @@ module Aws::Connect
|
|
8100
6862
|
include Aws::Structure
|
8101
6863
|
end
|
8102
6864
|
|
6865
|
+
# The type of notification recipient.
|
6866
|
+
#
|
6867
|
+
# @!attribute [rw] user_tags
|
6868
|
+
# The tags used to organize, track, or control access for this
|
6869
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
6870
|
+
# "key2":"value2"\\} \\}. Amazon Connect users with the specified
|
6871
|
+
# tags will be notified.
|
6872
|
+
# @return [Hash<String,String>]
|
6873
|
+
#
|
6874
|
+
# @!attribute [rw] user_ids
|
6875
|
+
# A list of user IDs.
|
6876
|
+
# @return [Array<String>]
|
6877
|
+
#
|
6878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NotificationRecipientType AWS API Documentation
|
6879
|
+
#
|
6880
|
+
class NotificationRecipientType < Struct.new(
|
6881
|
+
:user_tags,
|
6882
|
+
:user_ids)
|
6883
|
+
SENSITIVE = []
|
6884
|
+
include Aws::Structure
|
6885
|
+
end
|
6886
|
+
|
8103
6887
|
# Information about a reference when the `referenceType` is `NUMBER`.
|
8104
6888
|
# Otherwise, null.
|
8105
6889
|
#
|
@@ -8122,15 +6906,6 @@ module Aws::Connect
|
|
8122
6906
|
|
8123
6907
|
# The outbound caller ID name, number, and outbound whisper flow.
|
8124
6908
|
#
|
8125
|
-
# @note When making an API call, you may pass OutboundCallerConfig
|
8126
|
-
# data as a hash:
|
8127
|
-
#
|
8128
|
-
# {
|
8129
|
-
# outbound_caller_id_name: "OutboundCallerIdName",
|
8130
|
-
# outbound_caller_id_number_id: "PhoneNumberId",
|
8131
|
-
# outbound_flow_id: "ContactFlowId",
|
8132
|
-
# }
|
8133
|
-
#
|
8134
6909
|
# @!attribute [rw] outbound_caller_id_name
|
8135
6910
|
# The caller ID name.
|
8136
6911
|
# @return [String]
|
@@ -8169,13 +6944,6 @@ module Aws::Connect
|
|
8169
6944
|
|
8170
6945
|
# The customer's details.
|
8171
6946
|
#
|
8172
|
-
# @note When making an API call, you may pass ParticipantDetails
|
8173
|
-
# data as a hash:
|
8174
|
-
#
|
8175
|
-
# {
|
8176
|
-
# display_name: "DisplayName", # required
|
8177
|
-
# }
|
8178
|
-
#
|
8179
6947
|
# @!attribute [rw] display_name
|
8180
6948
|
# Display name of the participant.
|
8181
6949
|
# @return [String]
|
@@ -8190,13 +6958,6 @@ module Aws::Connect
|
|
8190
6958
|
|
8191
6959
|
# Contains information about a phone number for a quick connect.
|
8192
6960
|
#
|
8193
|
-
# @note When making an API call, you may pass PhoneNumberQuickConnectConfig
|
8194
|
-
# data as a hash:
|
8195
|
-
#
|
8196
|
-
# {
|
8197
|
-
# phone_number: "PhoneNumber", # required
|
8198
|
-
# }
|
8199
|
-
#
|
8200
6961
|
# @!attribute [rw] phone_number
|
8201
6962
|
# The phone number in E.164 format.
|
8202
6963
|
# @return [String]
|
@@ -8366,15 +7127,6 @@ module Aws::Connect
|
|
8366
7127
|
include Aws::Structure
|
8367
7128
|
end
|
8368
7129
|
|
8369
|
-
# @note When making an API call, you may pass PutUserStatusRequest
|
8370
|
-
# data as a hash:
|
8371
|
-
#
|
8372
|
-
# {
|
8373
|
-
# user_id: "UserId", # required
|
8374
|
-
# instance_id: "InstanceId", # required
|
8375
|
-
# agent_status_id: "AgentStatusId", # required
|
8376
|
-
# }
|
8377
|
-
#
|
8378
7130
|
# @!attribute [rw] user_id
|
8379
7131
|
# The identifier of the user.
|
8380
7132
|
# @return [String]
|
@@ -8481,14 +7233,6 @@ module Aws::Connect
|
|
8481
7233
|
# Contains information about a queue for a quick connect. The flow must
|
8482
7234
|
# be of type Transfer to Queue.
|
8483
7235
|
#
|
8484
|
-
# @note When making an API call, you may pass QueueQuickConnectConfig
|
8485
|
-
# data as a hash:
|
8486
|
-
#
|
8487
|
-
# {
|
8488
|
-
# queue_id: "QueueId", # required
|
8489
|
-
# contact_flow_id: "ContactFlowId", # required
|
8490
|
-
# }
|
8491
|
-
#
|
8492
7236
|
# @!attribute [rw] queue_id
|
8493
7237
|
# The identifier for the queue.
|
8494
7238
|
# @return [String]
|
@@ -8535,50 +7279,6 @@ module Aws::Connect
|
|
8535
7279
|
#
|
8536
7280
|
# </note>
|
8537
7281
|
#
|
8538
|
-
# @note When making an API call, you may pass QueueSearchCriteria
|
8539
|
-
# data as a hash:
|
8540
|
-
#
|
8541
|
-
# {
|
8542
|
-
# or_conditions: [
|
8543
|
-
# {
|
8544
|
-
# or_conditions: {
|
8545
|
-
# # recursive QueueSearchConditionList
|
8546
|
-
# },
|
8547
|
-
# and_conditions: {
|
8548
|
-
# # recursive QueueSearchConditionList
|
8549
|
-
# },
|
8550
|
-
# string_condition: {
|
8551
|
-
# field_name: "String",
|
8552
|
-
# value: "String",
|
8553
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
8554
|
-
# },
|
8555
|
-
# queue_type_condition: "STANDARD", # accepts STANDARD
|
8556
|
-
# },
|
8557
|
-
# ],
|
8558
|
-
# and_conditions: [
|
8559
|
-
# {
|
8560
|
-
# or_conditions: {
|
8561
|
-
# # recursive QueueSearchConditionList
|
8562
|
-
# },
|
8563
|
-
# and_conditions: {
|
8564
|
-
# # recursive QueueSearchConditionList
|
8565
|
-
# },
|
8566
|
-
# string_condition: {
|
8567
|
-
# field_name: "String",
|
8568
|
-
# value: "String",
|
8569
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
8570
|
-
# },
|
8571
|
-
# queue_type_condition: "STANDARD", # accepts STANDARD
|
8572
|
-
# },
|
8573
|
-
# ],
|
8574
|
-
# string_condition: {
|
8575
|
-
# field_name: "String",
|
8576
|
-
# value: "String",
|
8577
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
8578
|
-
# },
|
8579
|
-
# queue_type_condition: "STANDARD", # accepts STANDARD
|
8580
|
-
# }
|
8581
|
-
#
|
8582
7282
|
# @!attribute [rw] or_conditions
|
8583
7283
|
# A list of conditions which would be applied together with an OR
|
8584
7284
|
# condition.
|
@@ -8615,32 +7315,6 @@ module Aws::Connect
|
|
8615
7315
|
|
8616
7316
|
# Filters to be applied to search results.
|
8617
7317
|
#
|
8618
|
-
# @note When making an API call, you may pass QueueSearchFilter
|
8619
|
-
# data as a hash:
|
8620
|
-
#
|
8621
|
-
# {
|
8622
|
-
# tag_filter: {
|
8623
|
-
# or_conditions: [
|
8624
|
-
# [
|
8625
|
-
# {
|
8626
|
-
# tag_key: "String",
|
8627
|
-
# tag_value: "String",
|
8628
|
-
# },
|
8629
|
-
# ],
|
8630
|
-
# ],
|
8631
|
-
# and_conditions: [
|
8632
|
-
# {
|
8633
|
-
# tag_key: "String",
|
8634
|
-
# tag_value: "String",
|
8635
|
-
# },
|
8636
|
-
# ],
|
8637
|
-
# tag_condition: {
|
8638
|
-
# tag_key: "String",
|
8639
|
-
# tag_value: "String",
|
8640
|
-
# },
|
8641
|
-
# },
|
8642
|
-
# }
|
8643
|
-
#
|
8644
7318
|
# @!attribute [rw] tag_filter
|
8645
7319
|
# An object that can be used to specify Tag conditions inside the
|
8646
7320
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
@@ -8733,24 +7407,6 @@ module Aws::Connect
|
|
8733
7407
|
|
8734
7408
|
# Contains configuration settings for a quick connect.
|
8735
7409
|
#
|
8736
|
-
# @note When making an API call, you may pass QuickConnectConfig
|
8737
|
-
# data as a hash:
|
8738
|
-
#
|
8739
|
-
# {
|
8740
|
-
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
8741
|
-
# user_config: {
|
8742
|
-
# user_id: "UserId", # required
|
8743
|
-
# contact_flow_id: "ContactFlowId", # required
|
8744
|
-
# },
|
8745
|
-
# queue_config: {
|
8746
|
-
# queue_id: "QueueId", # required
|
8747
|
-
# contact_flow_id: "ContactFlowId", # required
|
8748
|
-
# },
|
8749
|
-
# phone_config: {
|
8750
|
-
# phone_number: "PhoneNumber", # required
|
8751
|
-
# },
|
8752
|
-
# }
|
8753
|
-
#
|
8754
7410
|
# @!attribute [rw] quick_connect_type
|
8755
7411
|
# The type of quick connect. In the Amazon Connect console, when you
|
8756
7412
|
# create a quick connect, you are prompted to assign one of the
|
@@ -8818,15 +7474,6 @@ module Aws::Connect
|
|
8818
7474
|
|
8819
7475
|
# Indicates a field that is read-only to an agent.
|
8820
7476
|
#
|
8821
|
-
# @note When making an API call, you may pass ReadOnlyFieldInfo
|
8822
|
-
# data as a hash:
|
8823
|
-
#
|
8824
|
-
# {
|
8825
|
-
# id: {
|
8826
|
-
# name: "TaskTemplateFieldName",
|
8827
|
-
# },
|
8828
|
-
# }
|
8829
|
-
#
|
8830
7477
|
# @!attribute [rw] id
|
8831
7478
|
# Identifier of the read-only field.
|
8832
7479
|
# @return [Types::TaskTemplateFieldIdentifier]
|
@@ -8843,14 +7490,6 @@ module Aws::Connect
|
|
8843
7490
|
# request. You can have up to 4,096 UTF-8 bytes across all references
|
8844
7491
|
# for a contact.
|
8845
7492
|
#
|
8846
|
-
# @note When making an API call, you may pass Reference
|
8847
|
-
# data as a hash:
|
8848
|
-
#
|
8849
|
-
# {
|
8850
|
-
# value: "ReferenceValue", # required
|
8851
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
8852
|
-
# }
|
8853
|
-
#
|
8854
7493
|
# @!attribute [rw] value
|
8855
7494
|
# A valid value for the reference. For example, for a URL reference, a
|
8856
7495
|
# formatted URL that is displayed to an agent in the Contact Control
|
@@ -8929,14 +7568,6 @@ module Aws::Connect
|
|
8929
7568
|
class Unknown < ReferenceSummary; end
|
8930
7569
|
end
|
8931
7570
|
|
8932
|
-
# @note When making an API call, you may pass ReleasePhoneNumberRequest
|
8933
|
-
# data as a hash:
|
8934
|
-
#
|
8935
|
-
# {
|
8936
|
-
# phone_number_id: "PhoneNumberId", # required
|
8937
|
-
# client_token: "ClientToken",
|
8938
|
-
# }
|
8939
|
-
#
|
8940
7571
|
# @!attribute [rw] phone_number_id
|
8941
7572
|
# A unique identifier for the phone number.
|
8942
7573
|
# @return [String]
|
@@ -8964,16 +7595,6 @@ module Aws::Connect
|
|
8964
7595
|
include Aws::Structure
|
8965
7596
|
end
|
8966
7597
|
|
8967
|
-
# @note When making an API call, you may pass ReplicateInstanceRequest
|
8968
|
-
# data as a hash:
|
8969
|
-
#
|
8970
|
-
# {
|
8971
|
-
# instance_id: "InstanceIdOrArn", # required
|
8972
|
-
# replica_region: "AwsRegion", # required
|
8973
|
-
# client_token: "ClientToken",
|
8974
|
-
# replica_alias: "DirectoryAlias", # required
|
8975
|
-
# }
|
8976
|
-
#
|
8977
7598
|
# @!attribute [rw] instance_id
|
8978
7599
|
# The identifier of the Amazon Connect instance. You can find the
|
8979
7600
|
# instanceId in the ARN of the instance. You can provide the
|
@@ -9036,15 +7657,6 @@ module Aws::Connect
|
|
9036
7657
|
|
9037
7658
|
# Information about a required field.
|
9038
7659
|
#
|
9039
|
-
# @note When making an API call, you may pass RequiredFieldInfo
|
9040
|
-
# data as a hash:
|
9041
|
-
#
|
9042
|
-
# {
|
9043
|
-
# id: {
|
9044
|
-
# name: "TaskTemplateFieldName",
|
9045
|
-
# },
|
9046
|
-
# }
|
9047
|
-
#
|
9048
7660
|
# @!attribute [rw] id
|
9049
7661
|
# The unique identifier for the field.
|
9050
7662
|
# @return [Types::TaskTemplateFieldIdentifier]
|
@@ -9120,15 +7732,6 @@ module Aws::Connect
|
|
9120
7732
|
include Aws::Structure
|
9121
7733
|
end
|
9122
7734
|
|
9123
|
-
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
9124
|
-
# data as a hash:
|
9125
|
-
#
|
9126
|
-
# {
|
9127
|
-
# instance_id: "InstanceId", # required
|
9128
|
-
# contact_id: "ContactId", # required
|
9129
|
-
# initial_contact_id: "ContactId", # required
|
9130
|
-
# }
|
9131
|
-
#
|
9132
7735
|
# @!attribute [rw] instance_id
|
9133
7736
|
# The identifier of the Amazon Connect instance. You can find the
|
9134
7737
|
# instanceId in the ARN of the instance.
|
@@ -9224,18 +7827,6 @@ module Aws::Connect
|
|
9224
7827
|
# Contains information about the queue and channel for which priority
|
9225
7828
|
# and delay can be set.
|
9226
7829
|
#
|
9227
|
-
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
9228
|
-
# data as a hash:
|
9229
|
-
#
|
9230
|
-
# {
|
9231
|
-
# queue_reference: { # required
|
9232
|
-
# queue_id: "QueueId", # required
|
9233
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
9234
|
-
# },
|
9235
|
-
# priority: 1, # required
|
9236
|
-
# delay: 1, # required
|
9237
|
-
# }
|
9238
|
-
#
|
9239
7830
|
# @!attribute [rw] queue_reference
|
9240
7831
|
# Contains information about a queue resource.
|
9241
7832
|
# @return [Types::RoutingProfileQueueReference]
|
@@ -9322,14 +7913,6 @@ module Aws::Connect
|
|
9322
7913
|
|
9323
7914
|
# Contains the channel and queue identifier for a routing profile.
|
9324
7915
|
#
|
9325
|
-
# @note When making an API call, you may pass RoutingProfileQueueReference
|
9326
|
-
# data as a hash:
|
9327
|
-
#
|
9328
|
-
# {
|
9329
|
-
# queue_id: "QueueId", # required
|
9330
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
9331
|
-
# }
|
9332
|
-
#
|
9333
7916
|
# @!attribute [rw] queue_id
|
9334
7917
|
# The identifier for the queue.
|
9335
7918
|
# @return [String]
|
@@ -9376,47 +7959,6 @@ module Aws::Connect
|
|
9376
7959
|
#
|
9377
7960
|
# </note>
|
9378
7961
|
#
|
9379
|
-
# @note When making an API call, you may pass RoutingProfileSearchCriteria
|
9380
|
-
# data as a hash:
|
9381
|
-
#
|
9382
|
-
# {
|
9383
|
-
# or_conditions: [
|
9384
|
-
# {
|
9385
|
-
# or_conditions: {
|
9386
|
-
# # recursive RoutingProfileSearchConditionList
|
9387
|
-
# },
|
9388
|
-
# and_conditions: {
|
9389
|
-
# # recursive RoutingProfileSearchConditionList
|
9390
|
-
# },
|
9391
|
-
# string_condition: {
|
9392
|
-
# field_name: "String",
|
9393
|
-
# value: "String",
|
9394
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9395
|
-
# },
|
9396
|
-
# },
|
9397
|
-
# ],
|
9398
|
-
# and_conditions: [
|
9399
|
-
# {
|
9400
|
-
# or_conditions: {
|
9401
|
-
# # recursive RoutingProfileSearchConditionList
|
9402
|
-
# },
|
9403
|
-
# and_conditions: {
|
9404
|
-
# # recursive RoutingProfileSearchConditionList
|
9405
|
-
# },
|
9406
|
-
# string_condition: {
|
9407
|
-
# field_name: "String",
|
9408
|
-
# value: "String",
|
9409
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9410
|
-
# },
|
9411
|
-
# },
|
9412
|
-
# ],
|
9413
|
-
# string_condition: {
|
9414
|
-
# field_name: "String",
|
9415
|
-
# value: "String",
|
9416
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9417
|
-
# },
|
9418
|
-
# }
|
9419
|
-
#
|
9420
7962
|
# @!attribute [rw] or_conditions
|
9421
7963
|
# A list of conditions which would be applied together with an OR
|
9422
7964
|
# condition.
|
@@ -9448,32 +7990,6 @@ module Aws::Connect
|
|
9448
7990
|
|
9449
7991
|
# Filters to be applied to search results.
|
9450
7992
|
#
|
9451
|
-
# @note When making an API call, you may pass RoutingProfileSearchFilter
|
9452
|
-
# data as a hash:
|
9453
|
-
#
|
9454
|
-
# {
|
9455
|
-
# tag_filter: {
|
9456
|
-
# or_conditions: [
|
9457
|
-
# [
|
9458
|
-
# {
|
9459
|
-
# tag_key: "String",
|
9460
|
-
# tag_value: "String",
|
9461
|
-
# },
|
9462
|
-
# ],
|
9463
|
-
# ],
|
9464
|
-
# and_conditions: [
|
9465
|
-
# {
|
9466
|
-
# tag_key: "String",
|
9467
|
-
# tag_value: "String",
|
9468
|
-
# },
|
9469
|
-
# ],
|
9470
|
-
# tag_condition: {
|
9471
|
-
# tag_key: "String",
|
9472
|
-
# tag_value: "String",
|
9473
|
-
# },
|
9474
|
-
# },
|
9475
|
-
# }
|
9476
|
-
#
|
9477
7993
|
# @!attribute [rw] tag_filter
|
9478
7994
|
# An object that can be used to specify Tag conditions inside the
|
9479
7995
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
@@ -9518,20 +8034,183 @@ module Aws::Connect
|
|
9518
8034
|
include Aws::Structure
|
9519
8035
|
end
|
9520
8036
|
|
9521
|
-
# Information about
|
9522
|
-
#
|
8037
|
+
# Information about a rule.
|
8038
|
+
#
|
8039
|
+
# @!attribute [rw] name
|
8040
|
+
# The name of the rule.
|
8041
|
+
# @return [String]
|
8042
|
+
#
|
8043
|
+
# @!attribute [rw] rule_id
|
8044
|
+
# A unique identifier for the rule.
|
8045
|
+
# @return [String]
|
8046
|
+
#
|
8047
|
+
# @!attribute [rw] rule_arn
|
8048
|
+
# The Amazon Resource Name (ARN) of the rule.
|
8049
|
+
# @return [String]
|
8050
|
+
#
|
8051
|
+
# @!attribute [rw] trigger_event_source
|
8052
|
+
# The event source to trigger the rule.
|
8053
|
+
# @return [Types::RuleTriggerEventSource]
|
8054
|
+
#
|
8055
|
+
# @!attribute [rw] function
|
8056
|
+
# The conditions of the rule.
|
8057
|
+
# @return [String]
|
8058
|
+
#
|
8059
|
+
# @!attribute [rw] actions
|
8060
|
+
# A list of actions to be run when the rule is triggered.
|
8061
|
+
# @return [Array<Types::RuleAction>]
|
8062
|
+
#
|
8063
|
+
# @!attribute [rw] publish_status
|
8064
|
+
# The publish status of the rule.
|
8065
|
+
# @return [String]
|
8066
|
+
#
|
8067
|
+
# @!attribute [rw] created_time
|
8068
|
+
# The timestamp for when the rule was created.
|
8069
|
+
# @return [Time]
|
8070
|
+
#
|
8071
|
+
# @!attribute [rw] last_updated_time
|
8072
|
+
# The timestamp for the when the rule was last updated.
|
8073
|
+
# @return [Time]
|
8074
|
+
#
|
8075
|
+
# @!attribute [rw] last_updated_by
|
8076
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
8077
|
+
# rule.
|
8078
|
+
# @return [String]
|
8079
|
+
#
|
8080
|
+
# @!attribute [rw] tags
|
8081
|
+
# The tags used to organize, track, or control access for this
|
8082
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
8083
|
+
# "key2":"value2"\\} \\}.
|
8084
|
+
# @return [Hash<String,String>]
|
8085
|
+
#
|
8086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Rule AWS API Documentation
|
8087
|
+
#
|
8088
|
+
class Rule < Struct.new(
|
8089
|
+
:name,
|
8090
|
+
:rule_id,
|
8091
|
+
:rule_arn,
|
8092
|
+
:trigger_event_source,
|
8093
|
+
:function,
|
8094
|
+
:actions,
|
8095
|
+
:publish_status,
|
8096
|
+
:created_time,
|
8097
|
+
:last_updated_time,
|
8098
|
+
:last_updated_by,
|
8099
|
+
:tags)
|
8100
|
+
SENSITIVE = []
|
8101
|
+
include Aws::Structure
|
8102
|
+
end
|
8103
|
+
|
8104
|
+
# Information about the action to be performed when a rule is triggered.
|
8105
|
+
#
|
8106
|
+
# @!attribute [rw] action_type
|
8107
|
+
# The type of action that creates a rule.
|
8108
|
+
# @return [String]
|
8109
|
+
#
|
8110
|
+
# @!attribute [rw] task_action
|
8111
|
+
# Information about the task action. This field is required if
|
8112
|
+
# `TriggerEventSource` is one of the following values:
|
8113
|
+
# `OnZendeskTicketCreate` \| `OnZendeskTicketStatusUpdate` \|
|
8114
|
+
# `OnSalesforceCaseCreate`
|
8115
|
+
# @return [Types::TaskActionDefinition]
|
8116
|
+
#
|
8117
|
+
# @!attribute [rw] event_bridge_action
|
8118
|
+
# Information about the EventBridge action.
|
8119
|
+
# @return [Types::EventBridgeActionDefinition]
|
8120
|
+
#
|
8121
|
+
# @!attribute [rw] assign_contact_category_action
|
8122
|
+
# Information about the contact category action.
|
8123
|
+
# @return [Types::AssignContactCategoryActionDefinition]
|
8124
|
+
#
|
8125
|
+
# @!attribute [rw] send_notification_action
|
8126
|
+
# Information about the send notification action.
|
8127
|
+
# @return [Types::SendNotificationActionDefinition]
|
8128
|
+
#
|
8129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RuleAction AWS API Documentation
|
8130
|
+
#
|
8131
|
+
class RuleAction < Struct.new(
|
8132
|
+
:action_type,
|
8133
|
+
:task_action,
|
8134
|
+
:event_bridge_action,
|
8135
|
+
:assign_contact_category_action,
|
8136
|
+
:send_notification_action)
|
8137
|
+
SENSITIVE = []
|
8138
|
+
include Aws::Structure
|
8139
|
+
end
|
8140
|
+
|
8141
|
+
# A list of `ActionTypes` associated with a rule.
|
8142
|
+
#
|
8143
|
+
# @!attribute [rw] name
|
8144
|
+
# The name of the rule.
|
8145
|
+
# @return [String]
|
8146
|
+
#
|
8147
|
+
# @!attribute [rw] rule_id
|
8148
|
+
# A unique identifier for the rule.
|
8149
|
+
# @return [String]
|
8150
|
+
#
|
8151
|
+
# @!attribute [rw] rule_arn
|
8152
|
+
# The Amazon Resource Name (ARN) of the rule.
|
8153
|
+
# @return [String]
|
8154
|
+
#
|
8155
|
+
# @!attribute [rw] event_source_name
|
8156
|
+
# The name of the event source.
|
8157
|
+
# @return [String]
|
8158
|
+
#
|
8159
|
+
# @!attribute [rw] publish_status
|
8160
|
+
# The publish status of the rule.
|
8161
|
+
# @return [String]
|
8162
|
+
#
|
8163
|
+
# @!attribute [rw] action_summaries
|
8164
|
+
# A list of ActionTypes associated with a rule.
|
8165
|
+
# @return [Array<Types::ActionSummary>]
|
8166
|
+
#
|
8167
|
+
# @!attribute [rw] created_time
|
8168
|
+
# The timestamp for when the rule was created.
|
8169
|
+
# @return [Time]
|
8170
|
+
#
|
8171
|
+
# @!attribute [rw] last_updated_time
|
8172
|
+
# The timestamp for when the rule was last updated.
|
8173
|
+
# @return [Time]
|
8174
|
+
#
|
8175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RuleSummary AWS API Documentation
|
9523
8176
|
#
|
9524
|
-
|
9525
|
-
|
8177
|
+
class RuleSummary < Struct.new(
|
8178
|
+
:name,
|
8179
|
+
:rule_id,
|
8180
|
+
:rule_arn,
|
8181
|
+
:event_source_name,
|
8182
|
+
:publish_status,
|
8183
|
+
:action_summaries,
|
8184
|
+
:created_time,
|
8185
|
+
:last_updated_time)
|
8186
|
+
SENSITIVE = []
|
8187
|
+
include Aws::Structure
|
8188
|
+
end
|
8189
|
+
|
8190
|
+
# The name of the event source. This field is required if
|
8191
|
+
# `TriggerEventSource` is one of the following values:
|
8192
|
+
# `OnZendeskTicketCreate` \| `OnZendeskTicketStatusUpdate` \|
|
8193
|
+
# `OnSalesforceCaseCreate`
|
8194
|
+
#
|
8195
|
+
# @!attribute [rw] event_source_name
|
8196
|
+
# The name of the event source.
|
8197
|
+
# @return [String]
|
9526
8198
|
#
|
9527
|
-
#
|
9528
|
-
#
|
9529
|
-
#
|
9530
|
-
#
|
9531
|
-
#
|
9532
|
-
#
|
9533
|
-
|
9534
|
-
|
8199
|
+
# @!attribute [rw] integration_association_id
|
8200
|
+
# The identifier for the integration association.
|
8201
|
+
# @return [String]
|
8202
|
+
#
|
8203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RuleTriggerEventSource AWS API Documentation
|
8204
|
+
#
|
8205
|
+
class RuleTriggerEventSource < Struct.new(
|
8206
|
+
:event_source_name,
|
8207
|
+
:integration_association_id)
|
8208
|
+
SENSITIVE = []
|
8209
|
+
include Aws::Structure
|
8210
|
+
end
|
8211
|
+
|
8212
|
+
# Information about the Amazon Simple Storage Service (Amazon S3)
|
8213
|
+
# storage type.
|
9535
8214
|
#
|
9536
8215
|
# @!attribute [rw] bucket_name
|
9537
8216
|
# The S3 bucket name.
|
@@ -9555,18 +8234,6 @@ module Aws::Connect
|
|
9555
8234
|
include Aws::Structure
|
9556
8235
|
end
|
9557
8236
|
|
9558
|
-
# @note When making an API call, you may pass SearchAvailablePhoneNumbersRequest
|
9559
|
-
# data as a hash:
|
9560
|
-
#
|
9561
|
-
# {
|
9562
|
-
# target_arn: "ARN", # required
|
9563
|
-
# phone_number_country_code: "AF", # required, accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
|
9564
|
-
# phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID
|
9565
|
-
# phone_number_prefix: "PhoneNumberPrefix",
|
9566
|
-
# max_results: 1,
|
9567
|
-
# next_token: "LargeNextToken",
|
9568
|
-
# }
|
9569
|
-
#
|
9570
8237
|
# @!attribute [rw] target_arn
|
9571
8238
|
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
9572
8239
|
# traffic distribution groups that phone numbers are claimed to.
|
@@ -9627,55 +8294,6 @@ module Aws::Connect
|
|
9627
8294
|
include Aws::Structure
|
9628
8295
|
end
|
9629
8296
|
|
9630
|
-
# @note When making an API call, you may pass SearchQueuesRequest
|
9631
|
-
# data as a hash:
|
9632
|
-
#
|
9633
|
-
# {
|
9634
|
-
# instance_id: "InstanceId", # required
|
9635
|
-
# next_token: "NextToken2500",
|
9636
|
-
# max_results: 1,
|
9637
|
-
# search_filter: {
|
9638
|
-
# tag_filter: {
|
9639
|
-
# or_conditions: [
|
9640
|
-
# [
|
9641
|
-
# {
|
9642
|
-
# tag_key: "String",
|
9643
|
-
# tag_value: "String",
|
9644
|
-
# },
|
9645
|
-
# ],
|
9646
|
-
# ],
|
9647
|
-
# and_conditions: [
|
9648
|
-
# {
|
9649
|
-
# tag_key: "String",
|
9650
|
-
# tag_value: "String",
|
9651
|
-
# },
|
9652
|
-
# ],
|
9653
|
-
# tag_condition: {
|
9654
|
-
# tag_key: "String",
|
9655
|
-
# tag_value: "String",
|
9656
|
-
# },
|
9657
|
-
# },
|
9658
|
-
# },
|
9659
|
-
# search_criteria: {
|
9660
|
-
# or_conditions: [
|
9661
|
-
# {
|
9662
|
-
# # recursive QueueSearchCriteria
|
9663
|
-
# },
|
9664
|
-
# ],
|
9665
|
-
# and_conditions: [
|
9666
|
-
# {
|
9667
|
-
# # recursive QueueSearchCriteria
|
9668
|
-
# },
|
9669
|
-
# ],
|
9670
|
-
# string_condition: {
|
9671
|
-
# field_name: "String",
|
9672
|
-
# value: "String",
|
9673
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9674
|
-
# },
|
9675
|
-
# queue_type_condition: "STANDARD", # accepts STANDARD
|
9676
|
-
# },
|
9677
|
-
# }
|
9678
|
-
#
|
9679
8297
|
# @!attribute [rw] instance_id
|
9680
8298
|
# The identifier of the Amazon Connect instance. You can find the
|
9681
8299
|
# instanceId in the ARN of the instance.
|
@@ -9741,54 +8359,6 @@ module Aws::Connect
|
|
9741
8359
|
include Aws::Structure
|
9742
8360
|
end
|
9743
8361
|
|
9744
|
-
# @note When making an API call, you may pass SearchRoutingProfilesRequest
|
9745
|
-
# data as a hash:
|
9746
|
-
#
|
9747
|
-
# {
|
9748
|
-
# instance_id: "InstanceId", # required
|
9749
|
-
# next_token: "NextToken2500",
|
9750
|
-
# max_results: 1,
|
9751
|
-
# search_filter: {
|
9752
|
-
# tag_filter: {
|
9753
|
-
# or_conditions: [
|
9754
|
-
# [
|
9755
|
-
# {
|
9756
|
-
# tag_key: "String",
|
9757
|
-
# tag_value: "String",
|
9758
|
-
# },
|
9759
|
-
# ],
|
9760
|
-
# ],
|
9761
|
-
# and_conditions: [
|
9762
|
-
# {
|
9763
|
-
# tag_key: "String",
|
9764
|
-
# tag_value: "String",
|
9765
|
-
# },
|
9766
|
-
# ],
|
9767
|
-
# tag_condition: {
|
9768
|
-
# tag_key: "String",
|
9769
|
-
# tag_value: "String",
|
9770
|
-
# },
|
9771
|
-
# },
|
9772
|
-
# },
|
9773
|
-
# search_criteria: {
|
9774
|
-
# or_conditions: [
|
9775
|
-
# {
|
9776
|
-
# # recursive RoutingProfileSearchCriteria
|
9777
|
-
# },
|
9778
|
-
# ],
|
9779
|
-
# and_conditions: [
|
9780
|
-
# {
|
9781
|
-
# # recursive RoutingProfileSearchCriteria
|
9782
|
-
# },
|
9783
|
-
# ],
|
9784
|
-
# string_condition: {
|
9785
|
-
# field_name: "String",
|
9786
|
-
# value: "String",
|
9787
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9788
|
-
# },
|
9789
|
-
# },
|
9790
|
-
# }
|
9791
|
-
#
|
9792
8362
|
# @!attribute [rw] instance_id
|
9793
8363
|
# The identifier of the Amazon Connect instance. You can find the
|
9794
8364
|
# instanceId in the ARN of the instance.
|
@@ -9855,54 +8425,6 @@ module Aws::Connect
|
|
9855
8425
|
include Aws::Structure
|
9856
8426
|
end
|
9857
8427
|
|
9858
|
-
# @note When making an API call, you may pass SearchSecurityProfilesRequest
|
9859
|
-
# data as a hash:
|
9860
|
-
#
|
9861
|
-
# {
|
9862
|
-
# instance_id: "InstanceId", # required
|
9863
|
-
# next_token: "NextToken2500",
|
9864
|
-
# max_results: 1,
|
9865
|
-
# search_criteria: {
|
9866
|
-
# or_conditions: [
|
9867
|
-
# {
|
9868
|
-
# # recursive SecurityProfileSearchCriteria
|
9869
|
-
# },
|
9870
|
-
# ],
|
9871
|
-
# and_conditions: [
|
9872
|
-
# {
|
9873
|
-
# # recursive SecurityProfileSearchCriteria
|
9874
|
-
# },
|
9875
|
-
# ],
|
9876
|
-
# string_condition: {
|
9877
|
-
# field_name: "String",
|
9878
|
-
# value: "String",
|
9879
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9880
|
-
# },
|
9881
|
-
# },
|
9882
|
-
# search_filter: {
|
9883
|
-
# tag_filter: {
|
9884
|
-
# or_conditions: [
|
9885
|
-
# [
|
9886
|
-
# {
|
9887
|
-
# tag_key: "String",
|
9888
|
-
# tag_value: "String",
|
9889
|
-
# },
|
9890
|
-
# ],
|
9891
|
-
# ],
|
9892
|
-
# and_conditions: [
|
9893
|
-
# {
|
9894
|
-
# tag_key: "String",
|
9895
|
-
# tag_value: "String",
|
9896
|
-
# },
|
9897
|
-
# ],
|
9898
|
-
# tag_condition: {
|
9899
|
-
# tag_key: "String",
|
9900
|
-
# tag_value: "String",
|
9901
|
-
# },
|
9902
|
-
# },
|
9903
|
-
# },
|
9904
|
-
# }
|
9905
|
-
#
|
9906
8428
|
# @!attribute [rw] instance_id
|
9907
8429
|
# The identifier of the Amazon Connect instance. You can find the
|
9908
8430
|
# instanceId in the ARN of the instance.
|
@@ -9972,58 +8494,6 @@ module Aws::Connect
|
|
9972
8494
|
include Aws::Structure
|
9973
8495
|
end
|
9974
8496
|
|
9975
|
-
# @note When making an API call, you may pass SearchUsersRequest
|
9976
|
-
# data as a hash:
|
9977
|
-
#
|
9978
|
-
# {
|
9979
|
-
# instance_id: "InstanceId",
|
9980
|
-
# next_token: "NextToken2500",
|
9981
|
-
# max_results: 1,
|
9982
|
-
# search_filter: {
|
9983
|
-
# tag_filter: {
|
9984
|
-
# or_conditions: [
|
9985
|
-
# [
|
9986
|
-
# {
|
9987
|
-
# tag_key: "String",
|
9988
|
-
# tag_value: "String",
|
9989
|
-
# },
|
9990
|
-
# ],
|
9991
|
-
# ],
|
9992
|
-
# and_conditions: [
|
9993
|
-
# {
|
9994
|
-
# tag_key: "String",
|
9995
|
-
# tag_value: "String",
|
9996
|
-
# },
|
9997
|
-
# ],
|
9998
|
-
# tag_condition: {
|
9999
|
-
# tag_key: "String",
|
10000
|
-
# tag_value: "String",
|
10001
|
-
# },
|
10002
|
-
# },
|
10003
|
-
# },
|
10004
|
-
# search_criteria: {
|
10005
|
-
# or_conditions: [
|
10006
|
-
# {
|
10007
|
-
# # recursive UserSearchCriteria
|
10008
|
-
# },
|
10009
|
-
# ],
|
10010
|
-
# and_conditions: [
|
10011
|
-
# {
|
10012
|
-
# # recursive UserSearchCriteria
|
10013
|
-
# },
|
10014
|
-
# ],
|
10015
|
-
# string_condition: {
|
10016
|
-
# field_name: "String",
|
10017
|
-
# value: "String",
|
10018
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10019
|
-
# },
|
10020
|
-
# hierarchy_group_condition: {
|
10021
|
-
# value: "String",
|
10022
|
-
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
10023
|
-
# },
|
10024
|
-
# },
|
10025
|
-
# }
|
10026
|
-
#
|
10027
8497
|
# @!attribute [rw] instance_id
|
10028
8498
|
# The identifier of the Amazon Connect instance. You can find the
|
10029
8499
|
# instanceId in the ARN of the instance.
|
@@ -10089,18 +8559,6 @@ module Aws::Connect
|
|
10089
8559
|
include Aws::Structure
|
10090
8560
|
end
|
10091
8561
|
|
10092
|
-
# @note When making an API call, you may pass SearchVocabulariesRequest
|
10093
|
-
# data as a hash:
|
10094
|
-
#
|
10095
|
-
# {
|
10096
|
-
# instance_id: "InstanceId", # required
|
10097
|
-
# max_results: 1,
|
10098
|
-
# next_token: "VocabularyNextToken",
|
10099
|
-
# state: "CREATION_IN_PROGRESS", # accepts CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
|
10100
|
-
# name_starts_with: "VocabularyName",
|
10101
|
-
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
10102
|
-
# }
|
10103
|
-
#
|
10104
8562
|
# @!attribute [rw] instance_id
|
10105
8563
|
# The identifier of the Amazon Connect instance. You can find the
|
10106
8564
|
# instanceId in the ARN of the instance.
|
@@ -10251,47 +8709,6 @@ module Aws::Connect
|
|
10251
8709
|
#
|
10252
8710
|
# </note>
|
10253
8711
|
#
|
10254
|
-
# @note When making an API call, you may pass SecurityProfileSearchCriteria
|
10255
|
-
# data as a hash:
|
10256
|
-
#
|
10257
|
-
# {
|
10258
|
-
# or_conditions: [
|
10259
|
-
# {
|
10260
|
-
# or_conditions: {
|
10261
|
-
# # recursive SecurityProfileSearchConditionList
|
10262
|
-
# },
|
10263
|
-
# and_conditions: {
|
10264
|
-
# # recursive SecurityProfileSearchConditionList
|
10265
|
-
# },
|
10266
|
-
# string_condition: {
|
10267
|
-
# field_name: "String",
|
10268
|
-
# value: "String",
|
10269
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10270
|
-
# },
|
10271
|
-
# },
|
10272
|
-
# ],
|
10273
|
-
# and_conditions: [
|
10274
|
-
# {
|
10275
|
-
# or_conditions: {
|
10276
|
-
# # recursive SecurityProfileSearchConditionList
|
10277
|
-
# },
|
10278
|
-
# and_conditions: {
|
10279
|
-
# # recursive SecurityProfileSearchConditionList
|
10280
|
-
# },
|
10281
|
-
# string_condition: {
|
10282
|
-
# field_name: "String",
|
10283
|
-
# value: "String",
|
10284
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10285
|
-
# },
|
10286
|
-
# },
|
10287
|
-
# ],
|
10288
|
-
# string_condition: {
|
10289
|
-
# field_name: "String",
|
10290
|
-
# value: "String",
|
10291
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10292
|
-
# },
|
10293
|
-
# }
|
10294
|
-
#
|
10295
8712
|
# @!attribute [rw] or_conditions
|
10296
8713
|
# A list of conditions which would be applied together with an OR
|
10297
8714
|
# condition.
|
@@ -10388,32 +8805,6 @@ module Aws::Connect
|
|
10388
8805
|
|
10389
8806
|
# Filters to be applied to search results.
|
10390
8807
|
#
|
10391
|
-
# @note When making an API call, you may pass SecurityProfilesSearchFilter
|
10392
|
-
# data as a hash:
|
10393
|
-
#
|
10394
|
-
# {
|
10395
|
-
# tag_filter: {
|
10396
|
-
# or_conditions: [
|
10397
|
-
# [
|
10398
|
-
# {
|
10399
|
-
# tag_key: "String",
|
10400
|
-
# tag_value: "String",
|
10401
|
-
# },
|
10402
|
-
# ],
|
10403
|
-
# ],
|
10404
|
-
# and_conditions: [
|
10405
|
-
# {
|
10406
|
-
# tag_key: "String",
|
10407
|
-
# tag_value: "String",
|
10408
|
-
# },
|
10409
|
-
# ],
|
10410
|
-
# tag_condition: {
|
10411
|
-
# tag_key: "String",
|
10412
|
-
# tag_value: "String",
|
10413
|
-
# },
|
10414
|
-
# },
|
10415
|
-
# }
|
10416
|
-
#
|
10417
8808
|
# @!attribute [rw] tag_filter
|
10418
8809
|
# An object that can be used to specify Tag conditions inside the
|
10419
8810
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
@@ -10434,6 +8825,52 @@ module Aws::Connect
|
|
10434
8825
|
include Aws::Structure
|
10435
8826
|
end
|
10436
8827
|
|
8828
|
+
# Information about the send notification action.
|
8829
|
+
#
|
8830
|
+
# @!attribute [rw] delivery_method
|
8831
|
+
# Notification delivery method.
|
8832
|
+
# @return [String]
|
8833
|
+
#
|
8834
|
+
# @!attribute [rw] subject
|
8835
|
+
# The subject of the email if the delivery method is `EMAIL`. Supports
|
8836
|
+
# variable injection. For more information, see [JSONPath
|
8837
|
+
# reference][1] in the *Amazon Connect Administrators Guide*.
|
8838
|
+
#
|
8839
|
+
#
|
8840
|
+
#
|
8841
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
|
8842
|
+
# @return [String]
|
8843
|
+
#
|
8844
|
+
# @!attribute [rw] content
|
8845
|
+
# Notification content. Supports variable injection. For more
|
8846
|
+
# information, see [JSONPath reference][1] in the *Amazon Connect
|
8847
|
+
# Administrators Guide*.
|
8848
|
+
#
|
8849
|
+
#
|
8850
|
+
#
|
8851
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
|
8852
|
+
# @return [String]
|
8853
|
+
#
|
8854
|
+
# @!attribute [rw] content_type
|
8855
|
+
# Content type format.
|
8856
|
+
# @return [String]
|
8857
|
+
#
|
8858
|
+
# @!attribute [rw] recipient
|
8859
|
+
# Notification recipient.
|
8860
|
+
# @return [Types::NotificationRecipientType]
|
8861
|
+
#
|
8862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendNotificationActionDefinition AWS API Documentation
|
8863
|
+
#
|
8864
|
+
class SendNotificationActionDefinition < Struct.new(
|
8865
|
+
:delivery_method,
|
8866
|
+
:subject,
|
8867
|
+
:content,
|
8868
|
+
:content_type,
|
8869
|
+
:recipient)
|
8870
|
+
SENSITIVE = []
|
8871
|
+
include Aws::Structure
|
8872
|
+
end
|
8873
|
+
|
10437
8874
|
# The service quota has been exceeded.
|
10438
8875
|
#
|
10439
8876
|
# @!attribute [rw] message
|
@@ -10447,27 +8884,6 @@ module Aws::Connect
|
|
10447
8884
|
include Aws::Structure
|
10448
8885
|
end
|
10449
8886
|
|
10450
|
-
# @note When making an API call, you may pass StartChatContactRequest
|
10451
|
-
# data as a hash:
|
10452
|
-
#
|
10453
|
-
# {
|
10454
|
-
# instance_id: "InstanceId", # required
|
10455
|
-
# contact_flow_id: "ContactFlowId", # required
|
10456
|
-
# attributes: {
|
10457
|
-
# "AttributeName" => "AttributeValue",
|
10458
|
-
# },
|
10459
|
-
# participant_details: { # required
|
10460
|
-
# display_name: "DisplayName", # required
|
10461
|
-
# },
|
10462
|
-
# initial_message: {
|
10463
|
-
# content_type: "ChatContentType", # required
|
10464
|
-
# content: "ChatContent", # required
|
10465
|
-
# },
|
10466
|
-
# client_token: "ClientToken",
|
10467
|
-
# chat_duration_in_minutes: 1,
|
10468
|
-
# supported_messaging_content_types: ["SupportedMessagingContentType"],
|
10469
|
-
# }
|
10470
|
-
#
|
10471
8887
|
# @!attribute [rw] instance_id
|
10472
8888
|
# The identifier of the Amazon Connect instance. You can find the
|
10473
8889
|
# instanceId in the ARN of the instance.
|
@@ -10572,18 +8988,6 @@ module Aws::Connect
|
|
10572
8988
|
include Aws::Structure
|
10573
8989
|
end
|
10574
8990
|
|
10575
|
-
# @note When making an API call, you may pass StartContactRecordingRequest
|
10576
|
-
# data as a hash:
|
10577
|
-
#
|
10578
|
-
# {
|
10579
|
-
# instance_id: "InstanceId", # required
|
10580
|
-
# contact_id: "ContactId", # required
|
10581
|
-
# initial_contact_id: "ContactId", # required
|
10582
|
-
# voice_recording_configuration: { # required
|
10583
|
-
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
10584
|
-
# },
|
10585
|
-
# }
|
10586
|
-
#
|
10587
8991
|
# @!attribute [rw] instance_id
|
10588
8992
|
# The identifier of the Amazon Connect instance. You can find the
|
10589
8993
|
# instanceId in the ARN of the instance.
|
@@ -10617,18 +9021,6 @@ module Aws::Connect
|
|
10617
9021
|
#
|
10618
9022
|
class StartContactRecordingResponse < Aws::EmptyStructure; end
|
10619
9023
|
|
10620
|
-
# @note When making an API call, you may pass StartContactStreamingRequest
|
10621
|
-
# data as a hash:
|
10622
|
-
#
|
10623
|
-
# {
|
10624
|
-
# instance_id: "InstanceId", # required
|
10625
|
-
# contact_id: "ContactId", # required
|
10626
|
-
# chat_streaming_configuration: { # required
|
10627
|
-
# streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
|
10628
|
-
# },
|
10629
|
-
# client_token: "ClientToken", # required
|
10630
|
-
# }
|
10631
|
-
#
|
10632
9024
|
# @!attribute [rw] instance_id
|
10633
9025
|
# The identifier of the Amazon Connect instance. You can find the
|
10634
9026
|
# instanceId in the ARN of the instance.
|
@@ -10681,27 +9073,6 @@ module Aws::Connect
|
|
10681
9073
|
include Aws::Structure
|
10682
9074
|
end
|
10683
9075
|
|
10684
|
-
# @note When making an API call, you may pass StartOutboundVoiceContactRequest
|
10685
|
-
# data as a hash:
|
10686
|
-
#
|
10687
|
-
# {
|
10688
|
-
# destination_phone_number: "PhoneNumber", # required
|
10689
|
-
# contact_flow_id: "ContactFlowId", # required
|
10690
|
-
# instance_id: "InstanceId", # required
|
10691
|
-
# client_token: "ClientToken",
|
10692
|
-
# source_phone_number: "PhoneNumber",
|
10693
|
-
# queue_id: "QueueId",
|
10694
|
-
# attributes: {
|
10695
|
-
# "AttributeName" => "AttributeValue",
|
10696
|
-
# },
|
10697
|
-
# answer_machine_detection_config: {
|
10698
|
-
# enable_answer_machine_detection: false,
|
10699
|
-
# await_answer_machine_prompt: false,
|
10700
|
-
# },
|
10701
|
-
# campaign_id: "CampaignId",
|
10702
|
-
# traffic_type: "GENERAL", # accepts GENERAL, CAMPAIGN
|
10703
|
-
# }
|
10704
|
-
#
|
10705
9076
|
# @!attribute [rw] destination_phone_number
|
10706
9077
|
# The phone number of the customer, in E.164 format.
|
10707
9078
|
# @return [String]
|
@@ -10806,30 +9177,6 @@ module Aws::Connect
|
|
10806
9177
|
include Aws::Structure
|
10807
9178
|
end
|
10808
9179
|
|
10809
|
-
# @note When making an API call, you may pass StartTaskContactRequest
|
10810
|
-
# data as a hash:
|
10811
|
-
#
|
10812
|
-
# {
|
10813
|
-
# instance_id: "InstanceId", # required
|
10814
|
-
# previous_contact_id: "ContactId",
|
10815
|
-
# contact_flow_id: "ContactFlowId",
|
10816
|
-
# attributes: {
|
10817
|
-
# "AttributeName" => "AttributeValue",
|
10818
|
-
# },
|
10819
|
-
# name: "Name", # required
|
10820
|
-
# references: {
|
10821
|
-
# "ReferenceKey" => {
|
10822
|
-
# value: "ReferenceValue", # required
|
10823
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
10824
|
-
# },
|
10825
|
-
# },
|
10826
|
-
# description: "Description",
|
10827
|
-
# client_token: "ClientToken",
|
10828
|
-
# scheduled_time: Time.now,
|
10829
|
-
# task_template_id: "TaskTemplateId",
|
10830
|
-
# quick_connect_id: "QuickConnectId",
|
10831
|
-
# }
|
10832
|
-
#
|
10833
9180
|
# @!attribute [rw] instance_id
|
10834
9181
|
# The identifier of the Amazon Connect instance. You can find the
|
10835
9182
|
# instanceId in the ARN of the instance.
|
@@ -10933,15 +9280,6 @@ module Aws::Connect
|
|
10933
9280
|
include Aws::Structure
|
10934
9281
|
end
|
10935
9282
|
|
10936
|
-
# @note When making an API call, you may pass StopContactRecordingRequest
|
10937
|
-
# data as a hash:
|
10938
|
-
#
|
10939
|
-
# {
|
10940
|
-
# instance_id: "InstanceId", # required
|
10941
|
-
# contact_id: "ContactId", # required
|
10942
|
-
# initial_contact_id: "ContactId", # required
|
10943
|
-
# }
|
10944
|
-
#
|
10945
9283
|
# @!attribute [rw] instance_id
|
10946
9284
|
# The identifier of the Amazon Connect instance. You can find the
|
10947
9285
|
# instanceId in the ARN of the instance.
|
@@ -10970,14 +9308,6 @@ module Aws::Connect
|
|
10970
9308
|
#
|
10971
9309
|
class StopContactRecordingResponse < Aws::EmptyStructure; end
|
10972
9310
|
|
10973
|
-
# @note When making an API call, you may pass StopContactRequest
|
10974
|
-
# data as a hash:
|
10975
|
-
#
|
10976
|
-
# {
|
10977
|
-
# contact_id: "ContactId", # required
|
10978
|
-
# instance_id: "InstanceId", # required
|
10979
|
-
# }
|
10980
|
-
#
|
10981
9311
|
# @!attribute [rw] contact_id
|
10982
9312
|
# The ID of the contact.
|
10983
9313
|
# @return [String]
|
@@ -11000,15 +9330,6 @@ module Aws::Connect
|
|
11000
9330
|
#
|
11001
9331
|
class StopContactResponse < Aws::EmptyStructure; end
|
11002
9332
|
|
11003
|
-
# @note When making an API call, you may pass StopContactStreamingRequest
|
11004
|
-
# data as a hash:
|
11005
|
-
#
|
11006
|
-
# {
|
11007
|
-
# instance_id: "InstanceId", # required
|
11008
|
-
# contact_id: "ContactId", # required
|
11009
|
-
# streaming_id: "StreamingId", # required
|
11010
|
-
# }
|
11011
|
-
#
|
11012
9333
|
# @!attribute [rw] instance_id
|
11013
9334
|
# The identifier of the Amazon Connect instance. You can find the
|
11014
9335
|
# instanceId in the ARN of the instance.
|
@@ -11044,15 +9365,6 @@ module Aws::Connect
|
|
11044
9365
|
#
|
11045
9366
|
# </note>
|
11046
9367
|
#
|
11047
|
-
# @note When making an API call, you may pass StringCondition
|
11048
|
-
# data as a hash:
|
11049
|
-
#
|
11050
|
-
# {
|
11051
|
-
# field_name: "String",
|
11052
|
-
# value: "String",
|
11053
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
11054
|
-
# }
|
11055
|
-
#
|
11056
9368
|
# @!attribute [rw] field_name
|
11057
9369
|
# The name of the field in the string condition.
|
11058
9370
|
# @return [String]
|
@@ -11096,15 +9408,6 @@ module Aws::Connect
|
|
11096
9408
|
include Aws::Structure
|
11097
9409
|
end
|
11098
9410
|
|
11099
|
-
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
11100
|
-
# data as a hash:
|
11101
|
-
#
|
11102
|
-
# {
|
11103
|
-
# instance_id: "InstanceId", # required
|
11104
|
-
# contact_id: "ContactId", # required
|
11105
|
-
# initial_contact_id: "ContactId", # required
|
11106
|
-
# }
|
11107
|
-
#
|
11108
9411
|
# @!attribute [rw] instance_id
|
11109
9412
|
# The identifier of the Amazon Connect instance. You can find the
|
11110
9413
|
# instanceId in the ARN of the instance.
|
@@ -11136,14 +9439,6 @@ module Aws::Connect
|
|
11136
9439
|
# A leaf node condition which can be used to specify a tag condition,
|
11137
9440
|
# for example, `HAVE BPO = 123`.
|
11138
9441
|
#
|
11139
|
-
# @note When making an API call, you may pass TagCondition
|
11140
|
-
# data as a hash:
|
11141
|
-
#
|
11142
|
-
# {
|
11143
|
-
# tag_key: "String",
|
11144
|
-
# tag_value: "String",
|
11145
|
-
# }
|
11146
|
-
#
|
11147
9442
|
# @!attribute [rw] tag_key
|
11148
9443
|
# The tag key in the tag condition.
|
11149
9444
|
# @return [String]
|
@@ -11161,16 +9456,6 @@ module Aws::Connect
|
|
11161
9456
|
include Aws::Structure
|
11162
9457
|
end
|
11163
9458
|
|
11164
|
-
# @note When making an API call, you may pass TagResourceRequest
|
11165
|
-
# data as a hash:
|
11166
|
-
#
|
11167
|
-
# {
|
11168
|
-
# resource_arn: "ARN", # required
|
11169
|
-
# tags: { # required
|
11170
|
-
# "TagKey" => "TagValue",
|
11171
|
-
# },
|
11172
|
-
# }
|
11173
|
-
#
|
11174
9459
|
# @!attribute [rw] resource_arn
|
11175
9460
|
# The Amazon Resource Name (ARN) of the resource.
|
11176
9461
|
# @return [String]
|
@@ -11190,34 +9475,49 @@ module Aws::Connect
|
|
11190
9475
|
include Aws::Structure
|
11191
9476
|
end
|
11192
9477
|
|
11193
|
-
#
|
9478
|
+
# Information about the task action.
|
9479
|
+
#
|
9480
|
+
# @!attribute [rw] name
|
9481
|
+
# The name. Supports variable injection. For more information, see
|
9482
|
+
# [JSONPath reference][1] in the *Amazon Connect Administrators
|
9483
|
+
# Guide*.
|
9484
|
+
#
|
11194
9485
|
#
|
11195
|
-
#
|
11196
|
-
#
|
11197
|
-
#
|
11198
|
-
#
|
11199
|
-
#
|
11200
|
-
#
|
11201
|
-
#
|
11202
|
-
#
|
11203
|
-
#
|
11204
|
-
#
|
11205
|
-
#
|
11206
|
-
#
|
11207
|
-
#
|
11208
|
-
#
|
11209
|
-
#
|
11210
|
-
#
|
11211
|
-
#
|
11212
|
-
#
|
11213
|
-
#
|
11214
|
-
#
|
11215
|
-
#
|
11216
|
-
#
|
11217
|
-
#
|
11218
|
-
#
|
11219
|
-
#
|
11220
|
-
|
9486
|
+
#
|
9487
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
|
9488
|
+
# @return [String]
|
9489
|
+
#
|
9490
|
+
# @!attribute [rw] description
|
9491
|
+
# The description. Supports variable injection. For more information,
|
9492
|
+
# see [JSONPath reference][1] in the *Amazon Connect Administrators
|
9493
|
+
# Guide*.
|
9494
|
+
#
|
9495
|
+
#
|
9496
|
+
#
|
9497
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
|
9498
|
+
# @return [String]
|
9499
|
+
#
|
9500
|
+
# @!attribute [rw] contact_flow_id
|
9501
|
+
# The identifier of the flow.
|
9502
|
+
# @return [String]
|
9503
|
+
#
|
9504
|
+
# @!attribute [rw] references
|
9505
|
+
# Information about the reference when the `referenceType` is `URL`.
|
9506
|
+
# Otherwise, null. (Supports variable injection in the `Value` field.)
|
9507
|
+
# @return [Hash<String,Types::Reference>]
|
9508
|
+
#
|
9509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskActionDefinition AWS API Documentation
|
9510
|
+
#
|
9511
|
+
class TaskActionDefinition < Struct.new(
|
9512
|
+
:name,
|
9513
|
+
:description,
|
9514
|
+
:contact_flow_id,
|
9515
|
+
:references)
|
9516
|
+
SENSITIVE = []
|
9517
|
+
include Aws::Structure
|
9518
|
+
end
|
9519
|
+
|
9520
|
+
# Describes constraints that apply to the template fields.
|
11221
9521
|
#
|
11222
9522
|
# @!attribute [rw] required_fields
|
11223
9523
|
# Lists the fields that are required to be filled by agents.
|
@@ -11243,16 +9543,6 @@ module Aws::Connect
|
|
11243
9543
|
|
11244
9544
|
# Describes a default field and its corresponding value.
|
11245
9545
|
#
|
11246
|
-
# @note When making an API call, you may pass TaskTemplateDefaultFieldValue
|
11247
|
-
# data as a hash:
|
11248
|
-
#
|
11249
|
-
# {
|
11250
|
-
# id: {
|
11251
|
-
# name: "TaskTemplateFieldName",
|
11252
|
-
# },
|
11253
|
-
# default_value: "TaskTemplateFieldValue",
|
11254
|
-
# }
|
11255
|
-
#
|
11256
9546
|
# @!attribute [rw] id
|
11257
9547
|
# Identifier of a field.
|
11258
9548
|
# @return [Types::TaskTemplateFieldIdentifier]
|
@@ -11272,20 +9562,6 @@ module Aws::Connect
|
|
11272
9562
|
|
11273
9563
|
# Describes default values for fields on a template.
|
11274
9564
|
#
|
11275
|
-
# @note When making an API call, you may pass TaskTemplateDefaults
|
11276
|
-
# data as a hash:
|
11277
|
-
#
|
11278
|
-
# {
|
11279
|
-
# default_field_values: [
|
11280
|
-
# {
|
11281
|
-
# id: {
|
11282
|
-
# name: "TaskTemplateFieldName",
|
11283
|
-
# },
|
11284
|
-
# default_value: "TaskTemplateFieldValue",
|
11285
|
-
# },
|
11286
|
-
# ],
|
11287
|
-
# }
|
11288
|
-
#
|
11289
9565
|
# @!attribute [rw] default_field_values
|
11290
9566
|
# Default value for the field.
|
11291
9567
|
# @return [Array<Types::TaskTemplateDefaultFieldValue>]
|
@@ -11300,18 +9576,6 @@ module Aws::Connect
|
|
11300
9576
|
|
11301
9577
|
# Describes a single task template field.
|
11302
9578
|
#
|
11303
|
-
# @note When making an API call, you may pass TaskTemplateField
|
11304
|
-
# data as a hash:
|
11305
|
-
#
|
11306
|
-
# {
|
11307
|
-
# id: { # required
|
11308
|
-
# name: "TaskTemplateFieldName",
|
11309
|
-
# },
|
11310
|
-
# description: "TaskTemplateFieldDescription",
|
11311
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
11312
|
-
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
11313
|
-
# }
|
11314
|
-
#
|
11315
9579
|
# @!attribute [rw] id
|
11316
9580
|
# The unique identifier for the field.
|
11317
9581
|
# @return [Types::TaskTemplateFieldIdentifier]
|
@@ -11341,13 +9605,6 @@ module Aws::Connect
|
|
11341
9605
|
|
11342
9606
|
# The identifier of the task template field.
|
11343
9607
|
#
|
11344
|
-
# @note When making an API call, you may pass TaskTemplateFieldIdentifier
|
11345
|
-
# data as a hash:
|
11346
|
-
#
|
11347
|
-
# {
|
11348
|
-
# name: "TaskTemplateFieldName",
|
11349
|
-
# }
|
11350
|
-
#
|
11351
9608
|
# @!attribute [rw] name
|
11352
9609
|
# The name of the task template field.
|
11353
9610
|
# @return [String]
|
@@ -11409,18 +9666,6 @@ module Aws::Connect
|
|
11409
9666
|
|
11410
9667
|
# The distribution of traffic between the instance and its replicas.
|
11411
9668
|
#
|
11412
|
-
# @note When making an API call, you may pass TelephonyConfig
|
11413
|
-
# data as a hash:
|
11414
|
-
#
|
11415
|
-
# {
|
11416
|
-
# distributions: [ # required
|
11417
|
-
# {
|
11418
|
-
# region: "AwsRegion", # required
|
11419
|
-
# percentage: 1, # required
|
11420
|
-
# },
|
11421
|
-
# ],
|
11422
|
-
# }
|
11423
|
-
#
|
11424
9669
|
# @!attribute [rw] distributions
|
11425
9670
|
# Information about traffic distributions.
|
11426
9671
|
# @return [Array<Types::Distribution>]
|
@@ -11435,14 +9680,6 @@ module Aws::Connect
|
|
11435
9680
|
|
11436
9681
|
# Contains information about the threshold for service level metrics.
|
11437
9682
|
#
|
11438
|
-
# @note When making an API call, you may pass Threshold
|
11439
|
-
# data as a hash:
|
11440
|
-
#
|
11441
|
-
# {
|
11442
|
-
# comparison: "LT", # accepts LT
|
11443
|
-
# threshold_value: 1.0,
|
11444
|
-
# }
|
11445
|
-
#
|
11446
9683
|
# @!attribute [rw] comparison
|
11447
9684
|
# The type of comparison. Only "less than" (LT) comparisons are
|
11448
9685
|
# supported.
|
@@ -11614,18 +9851,6 @@ module Aws::Connect
|
|
11614
9851
|
include Aws::Structure
|
11615
9852
|
end
|
11616
9853
|
|
11617
|
-
# @note When making an API call, you may pass TransferContactRequest
|
11618
|
-
# data as a hash:
|
11619
|
-
#
|
11620
|
-
# {
|
11621
|
-
# instance_id: "InstanceId", # required
|
11622
|
-
# contact_id: "ContactId", # required
|
11623
|
-
# queue_id: "QueueId",
|
11624
|
-
# user_id: "AgentResourceId",
|
11625
|
-
# contact_flow_id: "ContactFlowId", # required
|
11626
|
-
# client_token: "ClientToken",
|
11627
|
-
# }
|
11628
|
-
#
|
11629
9854
|
# @!attribute [rw] instance_id
|
11630
9855
|
# The identifier of the Amazon Connect instance. You can find the
|
11631
9856
|
# instanceId in the ARN of the instance.
|
@@ -11691,14 +9916,6 @@ module Aws::Connect
|
|
11691
9916
|
include Aws::Structure
|
11692
9917
|
end
|
11693
9918
|
|
11694
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
11695
|
-
# data as a hash:
|
11696
|
-
#
|
11697
|
-
# {
|
11698
|
-
# resource_arn: "ARN", # required
|
11699
|
-
# tag_keys: ["TagKey"], # required
|
11700
|
-
# }
|
11701
|
-
#
|
11702
9919
|
# @!attribute [rw] resource_arn
|
11703
9920
|
# The Amazon Resource Name (ARN) of the resource.
|
11704
9921
|
# @return [String]
|
@@ -11716,19 +9933,6 @@ module Aws::Connect
|
|
11716
9933
|
include Aws::Structure
|
11717
9934
|
end
|
11718
9935
|
|
11719
|
-
# @note When making an API call, you may pass UpdateAgentStatusRequest
|
11720
|
-
# data as a hash:
|
11721
|
-
#
|
11722
|
-
# {
|
11723
|
-
# instance_id: "InstanceId", # required
|
11724
|
-
# agent_status_id: "AgentStatusId", # required
|
11725
|
-
# name: "AgentStatusName",
|
11726
|
-
# description: "UpdateAgentStatusDescription",
|
11727
|
-
# state: "ENABLED", # accepts ENABLED, DISABLED
|
11728
|
-
# display_order: 1,
|
11729
|
-
# reset_order_number: false,
|
11730
|
-
# }
|
11731
|
-
#
|
11732
9936
|
# @!attribute [rw] instance_id
|
11733
9937
|
# The identifier of the Amazon Connect instance. You can find the
|
11734
9938
|
# instanceId in the ARN of the instance.
|
@@ -11772,17 +9976,6 @@ module Aws::Connect
|
|
11772
9976
|
include Aws::Structure
|
11773
9977
|
end
|
11774
9978
|
|
11775
|
-
# @note When making an API call, you may pass UpdateContactAttributesRequest
|
11776
|
-
# data as a hash:
|
11777
|
-
#
|
11778
|
-
# {
|
11779
|
-
# initial_contact_id: "ContactId", # required
|
11780
|
-
# instance_id: "InstanceId", # required
|
11781
|
-
# attributes: { # required
|
11782
|
-
# "AttributeName" => "AttributeValue",
|
11783
|
-
# },
|
11784
|
-
# }
|
11785
|
-
#
|
11786
9979
|
# @!attribute [rw] initial_contact_id
|
11787
9980
|
# The identifier of the contact. This is the identifier of the contact
|
11788
9981
|
# associated with the first interaction with the contact center.
|
@@ -11816,15 +10009,6 @@ module Aws::Connect
|
|
11816
10009
|
#
|
11817
10010
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
11818
10011
|
|
11819
|
-
# @note When making an API call, you may pass UpdateContactFlowContentRequest
|
11820
|
-
# data as a hash:
|
11821
|
-
#
|
11822
|
-
# {
|
11823
|
-
# instance_id: "InstanceId", # required
|
11824
|
-
# contact_flow_id: "ContactFlowId", # required
|
11825
|
-
# content: "ContactFlowContent", # required
|
11826
|
-
# }
|
11827
|
-
#
|
11828
10012
|
# @!attribute [rw] instance_id
|
11829
10013
|
# The identifier of the Amazon Connect instance.
|
11830
10014
|
# @return [String]
|
@@ -11853,17 +10037,6 @@ module Aws::Connect
|
|
11853
10037
|
include Aws::Structure
|
11854
10038
|
end
|
11855
10039
|
|
11856
|
-
# @note When making an API call, you may pass UpdateContactFlowMetadataRequest
|
11857
|
-
# data as a hash:
|
11858
|
-
#
|
11859
|
-
# {
|
11860
|
-
# instance_id: "InstanceId", # required
|
11861
|
-
# contact_flow_id: "ContactFlowId", # required
|
11862
|
-
# name: "ContactFlowName",
|
11863
|
-
# description: "ContactFlowDescription",
|
11864
|
-
# contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
11865
|
-
# }
|
11866
|
-
#
|
11867
10040
|
# @!attribute [rw] instance_id
|
11868
10041
|
# The identifier of the Amazon Connect instance. You can find the
|
11869
10042
|
# instanceId in the ARN of the instance.
|
@@ -11897,15 +10070,6 @@ module Aws::Connect
|
|
11897
10070
|
include Aws::Structure
|
11898
10071
|
end
|
11899
10072
|
|
11900
|
-
# @note When making an API call, you may pass UpdateContactFlowModuleContentRequest
|
11901
|
-
# data as a hash:
|
11902
|
-
#
|
11903
|
-
# {
|
11904
|
-
# instance_id: "InstanceId", # required
|
11905
|
-
# contact_flow_module_id: "ContactFlowModuleId", # required
|
11906
|
-
# content: "ContactFlowModuleContent", # required
|
11907
|
-
# }
|
11908
|
-
#
|
11909
10073
|
# @!attribute [rw] instance_id
|
11910
10074
|
# The identifier of the Amazon Connect instance. You can find the
|
11911
10075
|
# instanceId in the ARN of the instance.
|
@@ -11933,17 +10097,6 @@ module Aws::Connect
|
|
11933
10097
|
#
|
11934
10098
|
class UpdateContactFlowModuleContentResponse < Aws::EmptyStructure; end
|
11935
10099
|
|
11936
|
-
# @note When making an API call, you may pass UpdateContactFlowModuleMetadataRequest
|
11937
|
-
# data as a hash:
|
11938
|
-
#
|
11939
|
-
# {
|
11940
|
-
# instance_id: "InstanceId", # required
|
11941
|
-
# contact_flow_module_id: "ContactFlowModuleId", # required
|
11942
|
-
# name: "ContactFlowModuleName",
|
11943
|
-
# description: "ContactFlowModuleDescription",
|
11944
|
-
# state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
11945
|
-
# }
|
11946
|
-
#
|
11947
10100
|
# @!attribute [rw] instance_id
|
11948
10101
|
# The identifier of the Amazon Connect instance. You can find the
|
11949
10102
|
# instanceId in the ARN of the instance.
|
@@ -11981,16 +10134,6 @@ module Aws::Connect
|
|
11981
10134
|
#
|
11982
10135
|
class UpdateContactFlowModuleMetadataResponse < Aws::EmptyStructure; end
|
11983
10136
|
|
11984
|
-
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
11985
|
-
# data as a hash:
|
11986
|
-
#
|
11987
|
-
# {
|
11988
|
-
# instance_id: "InstanceId", # required
|
11989
|
-
# contact_flow_id: "ContactFlowId", # required
|
11990
|
-
# name: "ContactFlowName",
|
11991
|
-
# description: "ContactFlowDescription",
|
11992
|
-
# }
|
11993
|
-
#
|
11994
10137
|
# @!attribute [rw] instance_id
|
11995
10138
|
# The identifier of the Amazon Connect instance.
|
11996
10139
|
# @return [String]
|
@@ -12018,22 +10161,6 @@ module Aws::Connect
|
|
12018
10161
|
include Aws::Structure
|
12019
10162
|
end
|
12020
10163
|
|
12021
|
-
# @note When making an API call, you may pass UpdateContactRequest
|
12022
|
-
# data as a hash:
|
12023
|
-
#
|
12024
|
-
# {
|
12025
|
-
# instance_id: "InstanceId", # required
|
12026
|
-
# contact_id: "ContactId", # required
|
12027
|
-
# name: "Name",
|
12028
|
-
# description: "Description",
|
12029
|
-
# references: {
|
12030
|
-
# "ReferenceKey" => {
|
12031
|
-
# value: "ReferenceValue", # required
|
12032
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
12033
|
-
# },
|
12034
|
-
# },
|
12035
|
-
# }
|
12036
|
-
#
|
12037
10164
|
# @!attribute [rw] instance_id
|
12038
10165
|
# The identifier of the Amazon Connect instance. You can find the
|
12039
10166
|
# instanceId in the ARN of the instance.
|
@@ -12073,15 +10200,6 @@ module Aws::Connect
|
|
12073
10200
|
#
|
12074
10201
|
class UpdateContactResponse < Aws::EmptyStructure; end
|
12075
10202
|
|
12076
|
-
# @note When making an API call, you may pass UpdateContactScheduleRequest
|
12077
|
-
# data as a hash:
|
12078
|
-
#
|
12079
|
-
# {
|
12080
|
-
# instance_id: "InstanceId", # required
|
12081
|
-
# contact_id: "ContactId", # required
|
12082
|
-
# scheduled_time: Time.now, # required
|
12083
|
-
# }
|
12084
|
-
#
|
12085
10203
|
# @!attribute [rw] instance_id
|
12086
10204
|
# The identifier of the Amazon Connect instance. You can find the
|
12087
10205
|
# instanceId in the ARN of the instance.
|
@@ -12111,30 +10229,6 @@ module Aws::Connect
|
|
12111
10229
|
#
|
12112
10230
|
class UpdateContactScheduleResponse < Aws::EmptyStructure; end
|
12113
10231
|
|
12114
|
-
# @note When making an API call, you may pass UpdateHoursOfOperationRequest
|
12115
|
-
# data as a hash:
|
12116
|
-
#
|
12117
|
-
# {
|
12118
|
-
# instance_id: "InstanceId", # required
|
12119
|
-
# hours_of_operation_id: "HoursOfOperationId", # required
|
12120
|
-
# name: "CommonNameLength127",
|
12121
|
-
# description: "UpdateHoursOfOperationDescription",
|
12122
|
-
# time_zone: "TimeZone",
|
12123
|
-
# config: [
|
12124
|
-
# {
|
12125
|
-
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
12126
|
-
# start_time: { # required
|
12127
|
-
# hours: 1, # required
|
12128
|
-
# minutes: 1, # required
|
12129
|
-
# },
|
12130
|
-
# end_time: { # required
|
12131
|
-
# hours: 1, # required
|
12132
|
-
# minutes: 1, # required
|
12133
|
-
# },
|
12134
|
-
# },
|
12135
|
-
# ],
|
12136
|
-
# }
|
12137
|
-
#
|
12138
10232
|
# @!attribute [rw] instance_id
|
12139
10233
|
# The identifier of the Amazon Connect instance. You can find the
|
12140
10234
|
# instanceId in the ARN of the instance.
|
@@ -12173,15 +10267,6 @@ module Aws::Connect
|
|
12173
10267
|
include Aws::Structure
|
12174
10268
|
end
|
12175
10269
|
|
12176
|
-
# @note When making an API call, you may pass UpdateInstanceAttributeRequest
|
12177
|
-
# data as a hash:
|
12178
|
-
#
|
12179
|
-
# {
|
12180
|
-
# instance_id: "InstanceId", # required
|
12181
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING
|
12182
|
-
# value: "InstanceAttributeValue", # required
|
12183
|
-
# }
|
12184
|
-
#
|
12185
10270
|
# @!attribute [rw] instance_id
|
12186
10271
|
# The identifier of the Amazon Connect instance. You can find the
|
12187
10272
|
# instanceId in the ARN of the instance.
|
@@ -12211,41 +10296,6 @@ module Aws::Connect
|
|
12211
10296
|
include Aws::Structure
|
12212
10297
|
end
|
12213
10298
|
|
12214
|
-
# @note When making an API call, you may pass UpdateInstanceStorageConfigRequest
|
12215
|
-
# data as a hash:
|
12216
|
-
#
|
12217
|
-
# {
|
12218
|
-
# instance_id: "InstanceId", # required
|
12219
|
-
# association_id: "AssociationId", # required
|
12220
|
-
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
|
12221
|
-
# storage_config: { # required
|
12222
|
-
# association_id: "AssociationId",
|
12223
|
-
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
12224
|
-
# s3_config: {
|
12225
|
-
# bucket_name: "BucketName", # required
|
12226
|
-
# bucket_prefix: "Prefix", # required
|
12227
|
-
# encryption_config: {
|
12228
|
-
# encryption_type: "KMS", # required, accepts KMS
|
12229
|
-
# key_id: "KeyId", # required
|
12230
|
-
# },
|
12231
|
-
# },
|
12232
|
-
# kinesis_video_stream_config: {
|
12233
|
-
# prefix: "Prefix", # required
|
12234
|
-
# retention_period_hours: 1, # required
|
12235
|
-
# encryption_config: { # required
|
12236
|
-
# encryption_type: "KMS", # required, accepts KMS
|
12237
|
-
# key_id: "KeyId", # required
|
12238
|
-
# },
|
12239
|
-
# },
|
12240
|
-
# kinesis_stream_config: {
|
12241
|
-
# stream_arn: "ARN", # required
|
12242
|
-
# },
|
12243
|
-
# kinesis_firehose_config: {
|
12244
|
-
# firehose_arn: "ARN", # required
|
12245
|
-
# },
|
12246
|
-
# },
|
12247
|
-
# }
|
12248
|
-
#
|
12249
10299
|
# @!attribute [rw] instance_id
|
12250
10300
|
# The identifier of the Amazon Connect instance. You can find the
|
12251
10301
|
# instanceId in the ARN of the instance.
|
@@ -12275,15 +10325,6 @@ module Aws::Connect
|
|
12275
10325
|
include Aws::Structure
|
12276
10326
|
end
|
12277
10327
|
|
12278
|
-
# @note When making an API call, you may pass UpdatePhoneNumberRequest
|
12279
|
-
# data as a hash:
|
12280
|
-
#
|
12281
|
-
# {
|
12282
|
-
# phone_number_id: "PhoneNumberId", # required
|
12283
|
-
# target_arn: "ARN", # required
|
12284
|
-
# client_token: "ClientToken",
|
12285
|
-
# }
|
12286
|
-
#
|
12287
10328
|
# @!attribute [rw] phone_number_id
|
12288
10329
|
# A unique identifier for the phone number.
|
12289
10330
|
# @return [String]
|
@@ -12334,15 +10375,6 @@ module Aws::Connect
|
|
12334
10375
|
include Aws::Structure
|
12335
10376
|
end
|
12336
10377
|
|
12337
|
-
# @note When making an API call, you may pass UpdateQueueHoursOfOperationRequest
|
12338
|
-
# data as a hash:
|
12339
|
-
#
|
12340
|
-
# {
|
12341
|
-
# instance_id: "InstanceId", # required
|
12342
|
-
# queue_id: "QueueId", # required
|
12343
|
-
# hours_of_operation_id: "HoursOfOperationId", # required
|
12344
|
-
# }
|
12345
|
-
#
|
12346
10378
|
# @!attribute [rw] instance_id
|
12347
10379
|
# The identifier of the Amazon Connect instance. You can find the
|
12348
10380
|
# instanceId in the ARN of the instance.
|
@@ -12366,15 +10398,6 @@ module Aws::Connect
|
|
12366
10398
|
include Aws::Structure
|
12367
10399
|
end
|
12368
10400
|
|
12369
|
-
# @note When making an API call, you may pass UpdateQueueMaxContactsRequest
|
12370
|
-
# data as a hash:
|
12371
|
-
#
|
12372
|
-
# {
|
12373
|
-
# instance_id: "InstanceId", # required
|
12374
|
-
# queue_id: "QueueId", # required
|
12375
|
-
# max_contacts: 1,
|
12376
|
-
# }
|
12377
|
-
#
|
12378
10401
|
# @!attribute [rw] instance_id
|
12379
10402
|
# The identifier of the Amazon Connect instance. You can find the
|
12380
10403
|
# instanceId in the ARN of the instance.
|
@@ -12399,16 +10422,6 @@ module Aws::Connect
|
|
12399
10422
|
include Aws::Structure
|
12400
10423
|
end
|
12401
10424
|
|
12402
|
-
# @note When making an API call, you may pass UpdateQueueNameRequest
|
12403
|
-
# data as a hash:
|
12404
|
-
#
|
12405
|
-
# {
|
12406
|
-
# instance_id: "InstanceId", # required
|
12407
|
-
# queue_id: "QueueId", # required
|
12408
|
-
# name: "CommonNameLength127",
|
12409
|
-
# description: "QueueDescription",
|
12410
|
-
# }
|
12411
|
-
#
|
12412
10425
|
# @!attribute [rw] instance_id
|
12413
10426
|
# The identifier of the Amazon Connect instance. You can find the
|
12414
10427
|
# instanceId in the ARN of the instance.
|
@@ -12437,19 +10450,6 @@ module Aws::Connect
|
|
12437
10450
|
include Aws::Structure
|
12438
10451
|
end
|
12439
10452
|
|
12440
|
-
# @note When making an API call, you may pass UpdateQueueOutboundCallerConfigRequest
|
12441
|
-
# data as a hash:
|
12442
|
-
#
|
12443
|
-
# {
|
12444
|
-
# instance_id: "InstanceId", # required
|
12445
|
-
# queue_id: "QueueId", # required
|
12446
|
-
# outbound_caller_config: { # required
|
12447
|
-
# outbound_caller_id_name: "OutboundCallerIdName",
|
12448
|
-
# outbound_caller_id_number_id: "PhoneNumberId",
|
12449
|
-
# outbound_flow_id: "ContactFlowId",
|
12450
|
-
# },
|
12451
|
-
# }
|
12452
|
-
#
|
12453
10453
|
# @!attribute [rw] instance_id
|
12454
10454
|
# The identifier of the Amazon Connect instance. You can find the
|
12455
10455
|
# instanceId in the ARN of the instance.
|
@@ -12473,15 +10473,6 @@ module Aws::Connect
|
|
12473
10473
|
include Aws::Structure
|
12474
10474
|
end
|
12475
10475
|
|
12476
|
-
# @note When making an API call, you may pass UpdateQueueStatusRequest
|
12477
|
-
# data as a hash:
|
12478
|
-
#
|
12479
|
-
# {
|
12480
|
-
# instance_id: "InstanceId", # required
|
12481
|
-
# queue_id: "QueueId", # required
|
12482
|
-
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
12483
|
-
# }
|
12484
|
-
#
|
12485
10476
|
# @!attribute [rw] instance_id
|
12486
10477
|
# The identifier of the Amazon Connect instance. You can find the
|
12487
10478
|
# instanceId in the ARN of the instance.
|
@@ -12505,28 +10496,6 @@ module Aws::Connect
|
|
12505
10496
|
include Aws::Structure
|
12506
10497
|
end
|
12507
10498
|
|
12508
|
-
# @note When making an API call, you may pass UpdateQuickConnectConfigRequest
|
12509
|
-
# data as a hash:
|
12510
|
-
#
|
12511
|
-
# {
|
12512
|
-
# instance_id: "InstanceId", # required
|
12513
|
-
# quick_connect_id: "QuickConnectId", # required
|
12514
|
-
# quick_connect_config: { # required
|
12515
|
-
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
12516
|
-
# user_config: {
|
12517
|
-
# user_id: "UserId", # required
|
12518
|
-
# contact_flow_id: "ContactFlowId", # required
|
12519
|
-
# },
|
12520
|
-
# queue_config: {
|
12521
|
-
# queue_id: "QueueId", # required
|
12522
|
-
# contact_flow_id: "ContactFlowId", # required
|
12523
|
-
# },
|
12524
|
-
# phone_config: {
|
12525
|
-
# phone_number: "PhoneNumber", # required
|
12526
|
-
# },
|
12527
|
-
# },
|
12528
|
-
# }
|
12529
|
-
#
|
12530
10499
|
# @!attribute [rw] instance_id
|
12531
10500
|
# The identifier of the Amazon Connect instance. You can find the
|
12532
10501
|
# instanceId in the ARN of the instance.
|
@@ -12550,16 +10519,6 @@ module Aws::Connect
|
|
12550
10519
|
include Aws::Structure
|
12551
10520
|
end
|
12552
10521
|
|
12553
|
-
# @note When making an API call, you may pass UpdateQuickConnectNameRequest
|
12554
|
-
# data as a hash:
|
12555
|
-
#
|
12556
|
-
# {
|
12557
|
-
# instance_id: "InstanceId", # required
|
12558
|
-
# quick_connect_id: "QuickConnectId", # required
|
12559
|
-
# name: "QuickConnectName",
|
12560
|
-
# description: "UpdateQuickConnectDescription",
|
12561
|
-
# }
|
12562
|
-
#
|
12563
10522
|
# @!attribute [rw] instance_id
|
12564
10523
|
# The identifier of the Amazon Connect instance. You can find the
|
12565
10524
|
# instanceId in the ARN of the instance.
|
@@ -12588,20 +10547,6 @@ module Aws::Connect
|
|
12588
10547
|
include Aws::Structure
|
12589
10548
|
end
|
12590
10549
|
|
12591
|
-
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
12592
|
-
# data as a hash:
|
12593
|
-
#
|
12594
|
-
# {
|
12595
|
-
# instance_id: "InstanceId", # required
|
12596
|
-
# routing_profile_id: "RoutingProfileId", # required
|
12597
|
-
# media_concurrencies: [ # required
|
12598
|
-
# {
|
12599
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
12600
|
-
# concurrency: 1, # required
|
12601
|
-
# },
|
12602
|
-
# ],
|
12603
|
-
# }
|
12604
|
-
#
|
12605
10550
|
# @!attribute [rw] instance_id
|
12606
10551
|
# The identifier of the Amazon Connect instance. You can find the
|
12607
10552
|
# instanceId in the ARN of the instance.
|
@@ -12626,15 +10571,6 @@ module Aws::Connect
|
|
12626
10571
|
include Aws::Structure
|
12627
10572
|
end
|
12628
10573
|
|
12629
|
-
# @note When making an API call, you may pass UpdateRoutingProfileDefaultOutboundQueueRequest
|
12630
|
-
# data as a hash:
|
12631
|
-
#
|
12632
|
-
# {
|
12633
|
-
# instance_id: "InstanceId", # required
|
12634
|
-
# routing_profile_id: "RoutingProfileId", # required
|
12635
|
-
# default_outbound_queue_id: "QueueId", # required
|
12636
|
-
# }
|
12637
|
-
#
|
12638
10574
|
# @!attribute [rw] instance_id
|
12639
10575
|
# The identifier of the Amazon Connect instance. You can find the
|
12640
10576
|
# instanceId in the ARN of the instance.
|
@@ -12658,16 +10594,6 @@ module Aws::Connect
|
|
12658
10594
|
include Aws::Structure
|
12659
10595
|
end
|
12660
10596
|
|
12661
|
-
# @note When making an API call, you may pass UpdateRoutingProfileNameRequest
|
12662
|
-
# data as a hash:
|
12663
|
-
#
|
12664
|
-
# {
|
12665
|
-
# instance_id: "InstanceId", # required
|
12666
|
-
# routing_profile_id: "RoutingProfileId", # required
|
12667
|
-
# name: "RoutingProfileName",
|
12668
|
-
# description: "RoutingProfileDescription",
|
12669
|
-
# }
|
12670
|
-
#
|
12671
10597
|
# @!attribute [rw] instance_id
|
12672
10598
|
# The identifier of the Amazon Connect instance. You can find the
|
12673
10599
|
# instanceId in the ARN of the instance.
|
@@ -12698,24 +10624,6 @@ module Aws::Connect
|
|
12698
10624
|
include Aws::Structure
|
12699
10625
|
end
|
12700
10626
|
|
12701
|
-
# @note When making an API call, you may pass UpdateRoutingProfileQueuesRequest
|
12702
|
-
# data as a hash:
|
12703
|
-
#
|
12704
|
-
# {
|
12705
|
-
# instance_id: "InstanceId", # required
|
12706
|
-
# routing_profile_id: "RoutingProfileId", # required
|
12707
|
-
# queue_configs: [ # required
|
12708
|
-
# {
|
12709
|
-
# queue_reference: { # required
|
12710
|
-
# queue_id: "QueueId", # required
|
12711
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
12712
|
-
# },
|
12713
|
-
# priority: 1, # required
|
12714
|
-
# delay: 1, # required
|
12715
|
-
# },
|
12716
|
-
# ],
|
12717
|
-
# }
|
12718
|
-
#
|
12719
10627
|
# @!attribute [rw] instance_id
|
12720
10628
|
# The identifier of the Amazon Connect instance. You can find the
|
12721
10629
|
# instanceId in the ARN of the instance.
|
@@ -12741,20 +10649,47 @@ module Aws::Connect
|
|
12741
10649
|
include Aws::Structure
|
12742
10650
|
end
|
12743
10651
|
|
12744
|
-
#
|
12745
|
-
#
|
10652
|
+
# @!attribute [rw] rule_id
|
10653
|
+
# A unique identifier for the rule.
|
10654
|
+
# @return [String]
|
10655
|
+
#
|
10656
|
+
# @!attribute [rw] instance_id
|
10657
|
+
# The identifier of the Amazon Connect instance. You can find the
|
10658
|
+
# instanceId in the ARN of the instance.
|
10659
|
+
# @return [String]
|
12746
10660
|
#
|
12747
|
-
#
|
12748
|
-
#
|
12749
|
-
#
|
12750
|
-
#
|
12751
|
-
#
|
12752
|
-
#
|
12753
|
-
#
|
12754
|
-
#
|
12755
|
-
#
|
12756
|
-
#
|
10661
|
+
# @!attribute [rw] name
|
10662
|
+
# The name of the rule. You can change the name only if
|
10663
|
+
# `TriggerEventSource` is one of the following values:
|
10664
|
+
# `OnZendeskTicketCreate` \| `OnZendeskTicketStatusUpdate` \|
|
10665
|
+
# `OnSalesforceCaseCreate`
|
10666
|
+
# @return [String]
|
10667
|
+
#
|
10668
|
+
# @!attribute [rw] function
|
10669
|
+
# The conditions of the rule.
|
10670
|
+
# @return [String]
|
10671
|
+
#
|
10672
|
+
# @!attribute [rw] actions
|
10673
|
+
# A list of actions to be run when the rule is triggered.
|
10674
|
+
# @return [Array<Types::RuleAction>]
|
10675
|
+
#
|
10676
|
+
# @!attribute [rw] publish_status
|
10677
|
+
# The publish status of the rule.
|
10678
|
+
# @return [String]
|
12757
10679
|
#
|
10680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRuleRequest AWS API Documentation
|
10681
|
+
#
|
10682
|
+
class UpdateRuleRequest < Struct.new(
|
10683
|
+
:rule_id,
|
10684
|
+
:instance_id,
|
10685
|
+
:name,
|
10686
|
+
:function,
|
10687
|
+
:actions,
|
10688
|
+
:publish_status)
|
10689
|
+
SENSITIVE = []
|
10690
|
+
include Aws::Structure
|
10691
|
+
end
|
10692
|
+
|
12758
10693
|
# @!attribute [rw] description
|
12759
10694
|
# The description of the security profile.
|
12760
10695
|
# @return [String]
|
@@ -12800,61 +10735,6 @@ module Aws::Connect
|
|
12800
10735
|
include Aws::Structure
|
12801
10736
|
end
|
12802
10737
|
|
12803
|
-
# @note When making an API call, you may pass UpdateTaskTemplateRequest
|
12804
|
-
# data as a hash:
|
12805
|
-
#
|
12806
|
-
# {
|
12807
|
-
# task_template_id: "TaskTemplateId", # required
|
12808
|
-
# instance_id: "InstanceId", # required
|
12809
|
-
# name: "TaskTemplateName",
|
12810
|
-
# description: "TaskTemplateDescription",
|
12811
|
-
# contact_flow_id: "ContactFlowId",
|
12812
|
-
# constraints: {
|
12813
|
-
# required_fields: [
|
12814
|
-
# {
|
12815
|
-
# id: {
|
12816
|
-
# name: "TaskTemplateFieldName",
|
12817
|
-
# },
|
12818
|
-
# },
|
12819
|
-
# ],
|
12820
|
-
# read_only_fields: [
|
12821
|
-
# {
|
12822
|
-
# id: {
|
12823
|
-
# name: "TaskTemplateFieldName",
|
12824
|
-
# },
|
12825
|
-
# },
|
12826
|
-
# ],
|
12827
|
-
# invisible_fields: [
|
12828
|
-
# {
|
12829
|
-
# id: {
|
12830
|
-
# name: "TaskTemplateFieldName",
|
12831
|
-
# },
|
12832
|
-
# },
|
12833
|
-
# ],
|
12834
|
-
# },
|
12835
|
-
# defaults: {
|
12836
|
-
# default_field_values: [
|
12837
|
-
# {
|
12838
|
-
# id: {
|
12839
|
-
# name: "TaskTemplateFieldName",
|
12840
|
-
# },
|
12841
|
-
# default_value: "TaskTemplateFieldValue",
|
12842
|
-
# },
|
12843
|
-
# ],
|
12844
|
-
# },
|
12845
|
-
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
12846
|
-
# fields: [
|
12847
|
-
# {
|
12848
|
-
# id: { # required
|
12849
|
-
# name: "TaskTemplateFieldName",
|
12850
|
-
# },
|
12851
|
-
# description: "TaskTemplateFieldDescription",
|
12852
|
-
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
12853
|
-
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
12854
|
-
# },
|
12855
|
-
# ],
|
12856
|
-
# }
|
12857
|
-
#
|
12858
10738
|
# @!attribute [rw] task_template_id
|
12859
10739
|
# A unique identifier for the task template.
|
12860
10740
|
# @return [String]
|
@@ -12986,21 +10866,6 @@ module Aws::Connect
|
|
12986
10866
|
include Aws::Structure
|
12987
10867
|
end
|
12988
10868
|
|
12989
|
-
# @note When making an API call, you may pass UpdateTrafficDistributionRequest
|
12990
|
-
# data as a hash:
|
12991
|
-
#
|
12992
|
-
# {
|
12993
|
-
# id: "TrafficDistributionGroupIdOrArn", # required
|
12994
|
-
# telephony_config: {
|
12995
|
-
# distributions: [ # required
|
12996
|
-
# {
|
12997
|
-
# region: "AwsRegion", # required
|
12998
|
-
# percentage: 1, # required
|
12999
|
-
# },
|
13000
|
-
# ],
|
13001
|
-
# },
|
13002
|
-
# }
|
13003
|
-
#
|
13004
10869
|
# @!attribute [rw] id
|
13005
10870
|
# The identifier of the traffic distribution group. This can be the ID
|
13006
10871
|
# or the ARN if the API is being called in the Region where the
|
@@ -13025,15 +10890,6 @@ module Aws::Connect
|
|
13025
10890
|
#
|
13026
10891
|
class UpdateTrafficDistributionResponse < Aws::EmptyStructure; end
|
13027
10892
|
|
13028
|
-
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
13029
|
-
# data as a hash:
|
13030
|
-
#
|
13031
|
-
# {
|
13032
|
-
# name: "HierarchyGroupName", # required
|
13033
|
-
# hierarchy_group_id: "HierarchyGroupId", # required
|
13034
|
-
# instance_id: "InstanceId", # required
|
13035
|
-
# }
|
13036
|
-
#
|
13037
10893
|
# @!attribute [rw] name
|
13038
10894
|
# The name of the hierarchy group. Must not be more than 100
|
13039
10895
|
# characters.
|
@@ -13058,15 +10914,6 @@ module Aws::Connect
|
|
13058
10914
|
include Aws::Structure
|
13059
10915
|
end
|
13060
10916
|
|
13061
|
-
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
13062
|
-
# data as a hash:
|
13063
|
-
#
|
13064
|
-
# {
|
13065
|
-
# hierarchy_group_id: "HierarchyGroupId",
|
13066
|
-
# user_id: "UserId", # required
|
13067
|
-
# instance_id: "InstanceId", # required
|
13068
|
-
# }
|
13069
|
-
#
|
13070
10917
|
# @!attribute [rw] hierarchy_group_id
|
13071
10918
|
# The identifier of the hierarchy group.
|
13072
10919
|
# @return [String]
|
@@ -13090,30 +10937,6 @@ module Aws::Connect
|
|
13090
10937
|
include Aws::Structure
|
13091
10938
|
end
|
13092
10939
|
|
13093
|
-
# @note When making an API call, you may pass UpdateUserHierarchyStructureRequest
|
13094
|
-
# data as a hash:
|
13095
|
-
#
|
13096
|
-
# {
|
13097
|
-
# hierarchy_structure: { # required
|
13098
|
-
# level_one: {
|
13099
|
-
# name: "HierarchyLevelName", # required
|
13100
|
-
# },
|
13101
|
-
# level_two: {
|
13102
|
-
# name: "HierarchyLevelName", # required
|
13103
|
-
# },
|
13104
|
-
# level_three: {
|
13105
|
-
# name: "HierarchyLevelName", # required
|
13106
|
-
# },
|
13107
|
-
# level_four: {
|
13108
|
-
# name: "HierarchyLevelName", # required
|
13109
|
-
# },
|
13110
|
-
# level_five: {
|
13111
|
-
# name: "HierarchyLevelName", # required
|
13112
|
-
# },
|
13113
|
-
# },
|
13114
|
-
# instance_id: "InstanceId", # required
|
13115
|
-
# }
|
13116
|
-
#
|
13117
10940
|
# @!attribute [rw] hierarchy_structure
|
13118
10941
|
# The hierarchy levels to update.
|
13119
10942
|
# @return [Types::HierarchyStructureUpdate]
|
@@ -13132,21 +10955,6 @@ module Aws::Connect
|
|
13132
10955
|
include Aws::Structure
|
13133
10956
|
end
|
13134
10957
|
|
13135
|
-
# @note When making an API call, you may pass UpdateUserIdentityInfoRequest
|
13136
|
-
# data as a hash:
|
13137
|
-
#
|
13138
|
-
# {
|
13139
|
-
# identity_info: { # required
|
13140
|
-
# first_name: "AgentFirstName",
|
13141
|
-
# last_name: "AgentLastName",
|
13142
|
-
# email: "Email",
|
13143
|
-
# secondary_email: "Email",
|
13144
|
-
# mobile: "PhoneNumber",
|
13145
|
-
# },
|
13146
|
-
# user_id: "UserId", # required
|
13147
|
-
# instance_id: "InstanceId", # required
|
13148
|
-
# }
|
13149
|
-
#
|
13150
10958
|
# @!attribute [rw] identity_info
|
13151
10959
|
# The identity information for the user.
|
13152
10960
|
# @return [Types::UserIdentityInfo]
|
@@ -13170,20 +10978,6 @@ module Aws::Connect
|
|
13170
10978
|
include Aws::Structure
|
13171
10979
|
end
|
13172
10980
|
|
13173
|
-
# @note When making an API call, you may pass UpdateUserPhoneConfigRequest
|
13174
|
-
# data as a hash:
|
13175
|
-
#
|
13176
|
-
# {
|
13177
|
-
# phone_config: { # required
|
13178
|
-
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
13179
|
-
# auto_accept: false,
|
13180
|
-
# after_contact_work_time_limit: 1,
|
13181
|
-
# desk_phone_number: "PhoneNumber",
|
13182
|
-
# },
|
13183
|
-
# user_id: "UserId", # required
|
13184
|
-
# instance_id: "InstanceId", # required
|
13185
|
-
# }
|
13186
|
-
#
|
13187
10981
|
# @!attribute [rw] phone_config
|
13188
10982
|
# Information about phone configuration settings for the user.
|
13189
10983
|
# @return [Types::UserPhoneConfig]
|
@@ -13207,15 +11001,6 @@ module Aws::Connect
|
|
13207
11001
|
include Aws::Structure
|
13208
11002
|
end
|
13209
11003
|
|
13210
|
-
# @note When making an API call, you may pass UpdateUserRoutingProfileRequest
|
13211
|
-
# data as a hash:
|
13212
|
-
#
|
13213
|
-
# {
|
13214
|
-
# routing_profile_id: "RoutingProfileId", # required
|
13215
|
-
# user_id: "UserId", # required
|
13216
|
-
# instance_id: "InstanceId", # required
|
13217
|
-
# }
|
13218
|
-
#
|
13219
11004
|
# @!attribute [rw] routing_profile_id
|
13220
11005
|
# The identifier of the routing profile for the user.
|
13221
11006
|
# @return [String]
|
@@ -13239,15 +11024,6 @@ module Aws::Connect
|
|
13239
11024
|
include Aws::Structure
|
13240
11025
|
end
|
13241
11026
|
|
13242
|
-
# @note When making an API call, you may pass UpdateUserSecurityProfilesRequest
|
13243
|
-
# data as a hash:
|
13244
|
-
#
|
13245
|
-
# {
|
13246
|
-
# security_profile_ids: ["SecurityProfileId"], # required
|
13247
|
-
# user_id: "UserId", # required
|
13248
|
-
# instance_id: "InstanceId", # required
|
13249
|
-
# }
|
13250
|
-
#
|
13251
11027
|
# @!attribute [rw] security_profile_ids
|
13252
11028
|
# The identifiers of the security profiles for the user.
|
13253
11029
|
# @return [Array<String>]
|
@@ -13441,16 +11217,6 @@ module Aws::Connect
|
|
13441
11217
|
|
13442
11218
|
# A filter for the user data.
|
13443
11219
|
#
|
13444
|
-
# @note When making an API call, you may pass UserDataFilters
|
13445
|
-
# data as a hash:
|
13446
|
-
#
|
13447
|
-
# {
|
13448
|
-
# queues: ["QueueId"],
|
13449
|
-
# contact_filter: {
|
13450
|
-
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
13451
|
-
# },
|
13452
|
-
# }
|
13453
|
-
#
|
13454
11220
|
# @!attribute [rw] queues
|
13455
11221
|
# Contains information about a queue resource for which metrics are
|
13456
11222
|
# returned.
|
@@ -13472,17 +11238,6 @@ module Aws::Connect
|
|
13472
11238
|
|
13473
11239
|
# Contains information about the identity of a user.
|
13474
11240
|
#
|
13475
|
-
# @note When making an API call, you may pass UserIdentityInfo
|
13476
|
-
# data as a hash:
|
13477
|
-
#
|
13478
|
-
# {
|
13479
|
-
# first_name: "AgentFirstName",
|
13480
|
-
# last_name: "AgentLastName",
|
13481
|
-
# email: "Email",
|
13482
|
-
# secondary_email: "Email",
|
13483
|
-
# mobile: "PhoneNumber",
|
13484
|
-
# }
|
13485
|
-
#
|
13486
11241
|
# @!attribute [rw] first_name
|
13487
11242
|
# The first name. This is required if you are using Amazon Connect or
|
13488
11243
|
# SAML for identity management.
|
@@ -13560,16 +11315,6 @@ module Aws::Connect
|
|
13560
11315
|
# Contains information about the phone configuration settings for a
|
13561
11316
|
# user.
|
13562
11317
|
#
|
13563
|
-
# @note When making an API call, you may pass UserPhoneConfig
|
13564
|
-
# data as a hash:
|
13565
|
-
#
|
13566
|
-
# {
|
13567
|
-
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
13568
|
-
# auto_accept: false,
|
13569
|
-
# after_contact_work_time_limit: 1,
|
13570
|
-
# desk_phone_number: "PhoneNumber",
|
13571
|
-
# }
|
13572
|
-
#
|
13573
11318
|
# @!attribute [rw] phone_type
|
13574
11319
|
# The phone type.
|
13575
11320
|
# @return [String]
|
@@ -13605,14 +11350,6 @@ module Aws::Connect
|
|
13605
11350
|
# Contains information about the quick connect configuration settings
|
13606
11351
|
# for a user. The contact flow must be of type Transfer to Agent.
|
13607
11352
|
#
|
13608
|
-
# @note When making an API call, you may pass UserQuickConnectConfig
|
13609
|
-
# data as a hash:
|
13610
|
-
#
|
13611
|
-
# {
|
13612
|
-
# user_id: "UserId", # required
|
13613
|
-
# contact_flow_id: "ContactFlowId", # required
|
13614
|
-
# }
|
13615
|
-
#
|
13616
11353
|
# @!attribute [rw] user_id
|
13617
11354
|
# The identifier of the user.
|
13618
11355
|
# @return [String]
|
@@ -13658,59 +11395,6 @@ module Aws::Connect
|
|
13658
11395
|
#
|
13659
11396
|
# </note>
|
13660
11397
|
#
|
13661
|
-
# @note When making an API call, you may pass UserSearchCriteria
|
13662
|
-
# data as a hash:
|
13663
|
-
#
|
13664
|
-
# {
|
13665
|
-
# or_conditions: [
|
13666
|
-
# {
|
13667
|
-
# or_conditions: {
|
13668
|
-
# # recursive UserSearchConditionList
|
13669
|
-
# },
|
13670
|
-
# and_conditions: {
|
13671
|
-
# # recursive UserSearchConditionList
|
13672
|
-
# },
|
13673
|
-
# string_condition: {
|
13674
|
-
# field_name: "String",
|
13675
|
-
# value: "String",
|
13676
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13677
|
-
# },
|
13678
|
-
# hierarchy_group_condition: {
|
13679
|
-
# value: "String",
|
13680
|
-
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
13681
|
-
# },
|
13682
|
-
# },
|
13683
|
-
# ],
|
13684
|
-
# and_conditions: [
|
13685
|
-
# {
|
13686
|
-
# or_conditions: {
|
13687
|
-
# # recursive UserSearchConditionList
|
13688
|
-
# },
|
13689
|
-
# and_conditions: {
|
13690
|
-
# # recursive UserSearchConditionList
|
13691
|
-
# },
|
13692
|
-
# string_condition: {
|
13693
|
-
# field_name: "String",
|
13694
|
-
# value: "String",
|
13695
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13696
|
-
# },
|
13697
|
-
# hierarchy_group_condition: {
|
13698
|
-
# value: "String",
|
13699
|
-
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
13700
|
-
# },
|
13701
|
-
# },
|
13702
|
-
# ],
|
13703
|
-
# string_condition: {
|
13704
|
-
# field_name: "String",
|
13705
|
-
# value: "String",
|
13706
|
-
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13707
|
-
# },
|
13708
|
-
# hierarchy_group_condition: {
|
13709
|
-
# value: "String",
|
13710
|
-
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
13711
|
-
# },
|
13712
|
-
# }
|
13713
|
-
#
|
13714
11398
|
# @!attribute [rw] or_conditions
|
13715
11399
|
# A list of conditions which would be applied together with an `OR`
|
13716
11400
|
# condition.
|
@@ -13744,32 +11428,6 @@ module Aws::Connect
|
|
13744
11428
|
|
13745
11429
|
# Filters to be applied to search results.
|
13746
11430
|
#
|
13747
|
-
# @note When making an API call, you may pass UserSearchFilter
|
13748
|
-
# data as a hash:
|
13749
|
-
#
|
13750
|
-
# {
|
13751
|
-
# tag_filter: {
|
13752
|
-
# or_conditions: [
|
13753
|
-
# [
|
13754
|
-
# {
|
13755
|
-
# tag_key: "String",
|
13756
|
-
# tag_value: "String",
|
13757
|
-
# },
|
13758
|
-
# ],
|
13759
|
-
# ],
|
13760
|
-
# and_conditions: [
|
13761
|
-
# {
|
13762
|
-
# tag_key: "String",
|
13763
|
-
# tag_value: "String",
|
13764
|
-
# },
|
13765
|
-
# ],
|
13766
|
-
# tag_condition: {
|
13767
|
-
# tag_key: "String",
|
13768
|
-
# tag_value: "String",
|
13769
|
-
# },
|
13770
|
-
# },
|
13771
|
-
# }
|
13772
|
-
#
|
13773
11431
|
# @!attribute [rw] tag_filter
|
13774
11432
|
# An object that can be used to specify Tag conditions inside the
|
13775
11433
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
@@ -13998,13 +11656,6 @@ module Aws::Connect
|
|
13998
11656
|
|
13999
11657
|
# Contains information about the recording configuration settings.
|
14000
11658
|
#
|
14001
|
-
# @note When making an API call, you may pass VoiceRecordingConfiguration
|
14002
|
-
# data as a hash:
|
14003
|
-
#
|
14004
|
-
# {
|
14005
|
-
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
14006
|
-
# }
|
14007
|
-
#
|
14008
11659
|
# @!attribute [rw] voice_recording_track
|
14009
11660
|
# Identifies which track is being recorded.
|
14010
11661
|
# @return [String]
|