@aws-sdk/client-connect 3.223.0 → 3.225.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/dist-cjs/Connect.js +75 -0
  2. package/dist-cjs/commands/CreateRuleCommand.js +46 -0
  3. package/dist-cjs/commands/DeleteRuleCommand.js +46 -0
  4. package/dist-cjs/commands/DescribeRuleCommand.js +46 -0
  5. package/dist-cjs/commands/ListContactReferencesCommand.js +2 -1
  6. package/dist-cjs/commands/ListDefaultVocabulariesCommand.js +3 -3
  7. package/dist-cjs/commands/ListHoursOfOperationsCommand.js +3 -3
  8. package/dist-cjs/commands/ListInstanceAttributesCommand.js +3 -3
  9. package/dist-cjs/commands/ListInstanceStorageConfigsCommand.js +3 -3
  10. package/dist-cjs/commands/ListInstancesCommand.js +3 -3
  11. package/dist-cjs/commands/ListIntegrationAssociationsCommand.js +3 -3
  12. package/dist-cjs/commands/ListRulesCommand.js +46 -0
  13. package/dist-cjs/commands/UpdateRuleCommand.js +46 -0
  14. package/dist-cjs/commands/index.js +5 -0
  15. package/dist-cjs/endpoint/ruleset.js +1 -10
  16. package/dist-cjs/models/models_0.js +104 -134
  17. package/dist-cjs/models/models_1.js +139 -8
  18. package/dist-cjs/pagination/ListRulesPaginator.js +36 -0
  19. package/dist-cjs/pagination/index.js +1 -0
  20. package/dist-cjs/protocols/Aws_restJson1.js +606 -7
  21. package/dist-es/Connect.js +75 -0
  22. package/dist-es/commands/CreateRuleCommand.js +42 -0
  23. package/dist-es/commands/DeleteRuleCommand.js +42 -0
  24. package/dist-es/commands/DescribeRuleCommand.js +42 -0
  25. package/dist-es/commands/ListContactReferencesCommand.js +2 -1
  26. package/dist-es/commands/ListDefaultVocabulariesCommand.js +1 -1
  27. package/dist-es/commands/ListHoursOfOperationsCommand.js +1 -1
  28. package/dist-es/commands/ListInstanceAttributesCommand.js +1 -1
  29. package/dist-es/commands/ListInstanceStorageConfigsCommand.js +1 -1
  30. package/dist-es/commands/ListInstancesCommand.js +1 -1
  31. package/dist-es/commands/ListIntegrationAssociationsCommand.js +1 -1
  32. package/dist-es/commands/ListRulesCommand.js +42 -0
  33. package/dist-es/commands/UpdateRuleCommand.js +42 -0
  34. package/dist-es/commands/index.js +5 -0
  35. package/dist-es/endpoint/ruleset.js +1 -10
  36. package/dist-es/models/models_0.js +83 -107
  37. package/dist-es/models/models_1.js +111 -3
  38. package/dist-es/pagination/ListRulesPaginator.js +32 -0
  39. package/dist-es/pagination/index.js +1 -0
  40. package/dist-es/protocols/Aws_restJson1.js +589 -0
  41. package/dist-types/Connect.d.ts +44 -4
  42. package/dist-types/ConnectClient.d.ts +7 -2
  43. package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +5 -1
  44. package/dist-types/commands/CreateRuleCommand.d.ts +37 -0
  45. package/dist-types/commands/DeleteRuleCommand.d.ts +37 -0
  46. package/dist-types/commands/DescribeRuleCommand.d.ts +37 -0
  47. package/dist-types/commands/DismissUserContactCommand.d.ts +1 -1
  48. package/dist-types/commands/ListContactReferencesCommand.d.ts +2 -1
  49. package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
  50. package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +1 -1
  51. package/dist-types/commands/ListInstanceAttributesCommand.d.ts +1 -1
  52. package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
  53. package/dist-types/commands/ListInstancesCommand.d.ts +1 -1
  54. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  55. package/dist-types/commands/ListRulesCommand.d.ts +37 -0
  56. package/dist-types/commands/MonitorContactCommand.d.ts +3 -2
  57. package/dist-types/commands/UpdateRuleCommand.d.ts +37 -0
  58. package/dist-types/commands/index.d.ts +5 -0
  59. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  60. package/dist-types/models/models_0.d.ts +373 -516
  61. package/dist-types/models/models_1.d.ts +628 -29
  62. package/dist-types/pagination/ListRulesPaginator.d.ts +4 -0
  63. package/dist-types/pagination/index.d.ts +1 -0
  64. package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
  65. package/dist-types/ts3.4/Connect.d.ts +85 -0
  66. package/dist-types/ts3.4/ConnectClient.d.ts +30 -0
  67. package/dist-types/ts3.4/commands/CreateRuleCommand.d.ts +34 -0
  68. package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +32 -0
  69. package/dist-types/ts3.4/commands/DescribeRuleCommand.d.ts +34 -0
  70. package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +2 -4
  71. package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/ListHoursOfOperationsCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/ListInstanceAttributesCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +34 -0
  78. package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +32 -0
  79. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  80. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  81. package/dist-types/ts3.4/models/models_0.d.ts +147 -249
  82. package/dist-types/ts3.4/models/models_1.d.ts +294 -6
  83. package/dist-types/ts3.4/pagination/ListRulesPaginator.d.ts +11 -0
  84. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  85. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  86. package/package.json +28 -28
@@ -12,6 +12,21 @@ export declare class AccessDeniedException extends __BaseException {
12
12
  */
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
+ export declare enum ActionType {
16
+ ASSIGN_CONTACT_CATEGORY = "ASSIGN_CONTACT_CATEGORY",
17
+ CREATE_TASK = "CREATE_TASK",
18
+ GENERATE_EVENTBRIDGE_EVENT = "GENERATE_EVENTBRIDGE_EVENT",
19
+ SEND_NOTIFICATION = "SEND_NOTIFICATION"
20
+ }
21
+ /**
22
+ * <p>Information about an action.</p>
23
+ */
24
+ export interface ActionSummary {
25
+ /**
26
+ * <p>The action type.</p>
27
+ */
28
+ ActionType: ActionType | string | undefined;
29
+ }
15
30
  export declare enum ContactState {
16
31
  CONNECTED = "CONNECTED",
17
32
  CONNECTED_ONHOLD = "CONNECTED_ONHOLD",
@@ -1241,6 +1256,222 @@ export interface CreateRoutingProfileResponse {
1241
1256
  */
1242
1257
  RoutingProfileId?: string;
1243
1258
  }
1259
+ /**
1260
+ * <p>This action must be set if <code>TriggerEventSource</code> is one of the following values:
1261
+ * <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> |
1262
+ * <code>OnPostChatAnalysisAvailable</code>. Contact is categorized using the rule name.</p>
1263
+ * <p>
1264
+ * <code>RuleName</code> is used as <code>ContactCategory</code>.</p>
1265
+ */
1266
+ export interface AssignContactCategoryActionDefinition {
1267
+ }
1268
+ /**
1269
+ * <p>The EventBridge action definition.</p>
1270
+ */
1271
+ export interface EventBridgeActionDefinition {
1272
+ /**
1273
+ * <p>The name.</p>
1274
+ */
1275
+ Name: string | undefined;
1276
+ }
1277
+ export declare enum NotificationContentType {
1278
+ PLAIN_TEXT = "PLAIN_TEXT"
1279
+ }
1280
+ export declare enum NotificationDeliveryType {
1281
+ EMAIL = "EMAIL"
1282
+ }
1283
+ /**
1284
+ * <p>The type of notification recipient.</p>
1285
+ */
1286
+ export interface NotificationRecipientType {
1287
+ /**
1288
+ * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.</p>
1289
+ */
1290
+ UserTags?: Record<string, string>;
1291
+ /**
1292
+ * <p>A list of user IDs.</p>
1293
+ */
1294
+ UserIds?: string[];
1295
+ }
1296
+ /**
1297
+ * <p>Information about the send notification action.</p>
1298
+ */
1299
+ export interface SendNotificationActionDefinition {
1300
+ /**
1301
+ * <p>Notification delivery method.</p>
1302
+ */
1303
+ DeliveryMethod: NotificationDeliveryType | string | undefined;
1304
+ /**
1305
+ * <p>The subject of the email if the delivery method is <code>EMAIL</code>.
1306
+ * Supports variable injection. For more information, see
1307
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
1308
+ * in the <i>Amazon Connect Administrators Guide</i>.</p>
1309
+ */
1310
+ Subject?: string;
1311
+ /**
1312
+ * <p>Notification content. Supports variable injection. For more information, see
1313
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
1314
+ * in the <i>Amazon Connect Administrators Guide</i>.</p>
1315
+ */
1316
+ Content: string | undefined;
1317
+ /**
1318
+ * <p>Content type format.</p>
1319
+ */
1320
+ ContentType: NotificationContentType | string | undefined;
1321
+ /**
1322
+ * <p>Notification recipient.</p>
1323
+ */
1324
+ Recipient: NotificationRecipientType | undefined;
1325
+ }
1326
+ export declare enum ReferenceType {
1327
+ ATTACHMENT = "ATTACHMENT",
1328
+ DATE = "DATE",
1329
+ EMAIL = "EMAIL",
1330
+ NUMBER = "NUMBER",
1331
+ STRING = "STRING",
1332
+ URL = "URL"
1333
+ }
1334
+ /**
1335
+ * <p>Well-formed data on a contact, used by agents to complete a contact request. You can have up
1336
+ * to 4,096 UTF-8 bytes across all references for a contact.</p>
1337
+ */
1338
+ export interface Reference {
1339
+ /**
1340
+ * <p>A valid value for the reference. For example, for a URL reference, a formatted URL that is
1341
+ * displayed to an agent in the Contact Control Panel (CCP).</p>
1342
+ */
1343
+ Value: string | undefined;
1344
+ /**
1345
+ * <p>The type of the reference. <code>DATE</code> must be of type Epoch timestamp.
1346
+ * </p>
1347
+ */
1348
+ Type: ReferenceType | string | undefined;
1349
+ }
1350
+ /**
1351
+ * <p>Information about the task action.</p>
1352
+ */
1353
+ export interface TaskActionDefinition {
1354
+ /**
1355
+ * <p>The name. Supports variable injection. For more information, see
1356
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
1357
+ * in the <i>Amazon Connect Administrators Guide</i>.</p>
1358
+ */
1359
+ Name: string | undefined;
1360
+ /**
1361
+ * <p>The description. Supports variable injection. For more information, see
1362
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html">JSONPath reference</a>
1363
+ * in the <i>Amazon Connect Administrators Guide</i>.</p>
1364
+ */
1365
+ Description?: string;
1366
+ /**
1367
+ * <p>The identifier of the flow.</p>
1368
+ */
1369
+ ContactFlowId: string | undefined;
1370
+ /**
1371
+ * <p>Information about the reference when the <code>referenceType</code> is <code>URL</code>.
1372
+ * Otherwise, null. (Supports variable injection in the <code>Value</code> field.)</p>
1373
+ */
1374
+ References?: Record<string, Reference>;
1375
+ }
1376
+ /**
1377
+ * <p>Information about the action to be performed when a rule is triggered.</p>
1378
+ */
1379
+ export interface RuleAction {
1380
+ /**
1381
+ * <p>The type of action that creates a rule.</p>
1382
+ */
1383
+ ActionType: ActionType | string | undefined;
1384
+ /**
1385
+ * <p>Information about the task action. This field is required if <code>TriggerEventSource</code>
1386
+ * is one of the following values: <code>OnZendeskTicketCreate</code> |
1387
+ * <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code>
1388
+ * </p>
1389
+ */
1390
+ TaskAction?: TaskActionDefinition;
1391
+ /**
1392
+ * <p>Information about the EventBridge action.</p>
1393
+ */
1394
+ EventBridgeAction?: EventBridgeActionDefinition;
1395
+ /**
1396
+ * <p>Information about the contact category action.</p>
1397
+ */
1398
+ AssignContactCategoryAction?: AssignContactCategoryActionDefinition;
1399
+ /**
1400
+ * <p>Information about the send notification action.</p>
1401
+ */
1402
+ SendNotificationAction?: SendNotificationActionDefinition;
1403
+ }
1404
+ export declare enum RulePublishStatus {
1405
+ DRAFT = "DRAFT",
1406
+ PUBLISHED = "PUBLISHED"
1407
+ }
1408
+ export declare enum EventSourceName {
1409
+ OnPostCallAnalysisAvailable = "OnPostCallAnalysisAvailable",
1410
+ OnPostChatAnalysisAvailable = "OnPostChatAnalysisAvailable",
1411
+ OnRealTimeCallAnalysisAvailable = "OnRealTimeCallAnalysisAvailable",
1412
+ OnSalesforceCaseCreate = "OnSalesforceCaseCreate",
1413
+ OnZendeskTicketCreate = "OnZendeskTicketCreate",
1414
+ OnZendeskTicketStatusUpdate = "OnZendeskTicketStatusUpdate"
1415
+ }
1416
+ /**
1417
+ * <p>The name of the event source. This field is required if <code>TriggerEventSource</code> is one of the
1418
+ * following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> |
1419
+ * <code>OnSalesforceCaseCreate</code>
1420
+ * </p>
1421
+ */
1422
+ export interface RuleTriggerEventSource {
1423
+ /**
1424
+ * <p>The name of the event source.</p>
1425
+ */
1426
+ EventSourceName: EventSourceName | string | undefined;
1427
+ /**
1428
+ * <p>The identifier for the integration association.</p>
1429
+ */
1430
+ IntegrationAssociationId?: string;
1431
+ }
1432
+ export interface CreateRuleRequest {
1433
+ /**
1434
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
1435
+ */
1436
+ InstanceId: string | undefined;
1437
+ /**
1438
+ * <p>A unique name for the rule.</p>
1439
+ */
1440
+ Name: string | undefined;
1441
+ /**
1442
+ * <p>The event source to trigger the rule.</p>
1443
+ */
1444
+ TriggerEventSource: RuleTriggerEventSource | undefined;
1445
+ /**
1446
+ * <p>The conditions of the rule.</p>
1447
+ */
1448
+ Function: string | undefined;
1449
+ /**
1450
+ * <p>A list of actions to be run when the rule is triggered.</p>
1451
+ */
1452
+ Actions: RuleAction[] | undefined;
1453
+ /**
1454
+ * <p>The publish status of the rule.</p>
1455
+ */
1456
+ PublishStatus: RulePublishStatus | string | undefined;
1457
+ /**
1458
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1459
+ * request. If not provided, the Amazon Web Services
1460
+ * SDK populates this field. For more information about idempotency, see
1461
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1462
+ */
1463
+ ClientToken?: string;
1464
+ }
1465
+ export interface CreateRuleResponse {
1466
+ /**
1467
+ * <p>The Amazon Resource Name (ARN) of the rule.</p>
1468
+ */
1469
+ RuleArn: string | undefined;
1470
+ /**
1471
+ * <p>A unique identifier for the rule.</p>
1472
+ */
1473
+ RuleId: string | undefined;
1474
+ }
1244
1475
  export interface CreateSecurityProfileRequest {
1245
1476
  /**
1246
1477
  * <p>The name of the security profile.</p>
@@ -1835,6 +2066,16 @@ export interface DeleteQuickConnectRequest {
1835
2066
  */
1836
2067
  QuickConnectId: string | undefined;
1837
2068
  }
2069
+ export interface DeleteRuleRequest {
2070
+ /**
2071
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
2072
+ */
2073
+ InstanceId: string | undefined;
2074
+ /**
2075
+ * <p>A unique identifier for the rule.</p>
2076
+ */
2077
+ RuleId: string | undefined;
2078
+ }
1838
2079
  export interface DeleteSecurityProfileRequest {
1839
2080
  /**
1840
2081
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -2917,6 +3158,71 @@ export interface DescribeRoutingProfileResponse {
2917
3158
  */
2918
3159
  RoutingProfile?: RoutingProfile;
2919
3160
  }
3161
+ export interface DescribeRuleRequest {
3162
+ /**
3163
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
3164
+ */
3165
+ InstanceId: string | undefined;
3166
+ /**
3167
+ * <p>A unique identifier for the rule.</p>
3168
+ */
3169
+ RuleId: string | undefined;
3170
+ }
3171
+ /**
3172
+ * <p>Information about a rule.</p>
3173
+ */
3174
+ export interface Rule {
3175
+ /**
3176
+ * <p>The name of the rule.</p>
3177
+ */
3178
+ Name: string | undefined;
3179
+ /**
3180
+ * <p>A unique identifier for the rule.</p>
3181
+ */
3182
+ RuleId: string | undefined;
3183
+ /**
3184
+ * <p>The Amazon Resource Name (ARN) of the rule.</p>
3185
+ */
3186
+ RuleArn: string | undefined;
3187
+ /**
3188
+ * <p>The event source to trigger the rule.</p>
3189
+ */
3190
+ TriggerEventSource: RuleTriggerEventSource | undefined;
3191
+ /**
3192
+ * <p>The conditions of the rule.</p>
3193
+ */
3194
+ Function: string | undefined;
3195
+ /**
3196
+ * <p>A list of actions to be run when the rule is triggered.</p>
3197
+ */
3198
+ Actions: RuleAction[] | undefined;
3199
+ /**
3200
+ * <p>The publish status of the rule.</p>
3201
+ */
3202
+ PublishStatus: RulePublishStatus | string | undefined;
3203
+ /**
3204
+ * <p>The timestamp for when the rule was created.</p>
3205
+ */
3206
+ CreatedTime: Date | undefined;
3207
+ /**
3208
+ * <p>The timestamp for the when the rule was last updated.</p>
3209
+ */
3210
+ LastUpdatedTime: Date | undefined;
3211
+ /**
3212
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the rule.</p>
3213
+ */
3214
+ LastUpdatedBy: string | undefined;
3215
+ /**
3216
+ * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
3217
+ */
3218
+ Tags?: Record<string, string>;
3219
+ }
3220
+ export interface DescribeRuleResponse {
3221
+ /**
3222
+ * <p>Information about the rule.</p>
3223
+ */
3224
+ Rule: Rule | undefined;
3225
+ }
2920
3226
  export interface DescribeSecurityProfileRequest {
2921
3227
  /**
2922
3228
  * <p>The identifier for the security profle.</p>
@@ -3538,14 +3844,15 @@ export interface GetCurrentMetricDataRequest {
3538
3844
  * <ul>
3539
3845
  * <li>
3540
3846
  * <p>If you group by <code>CHANNEL</code>, you should include a Channels filter.
3541
- * VOICE, CHAT, and TASK channels are supported.</p>
3847
+ * VOICE, CHAT, and TASK channels are supported.</p>
3542
3848
  * </li>
3543
3849
  * <li>
3544
- * <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing profile filter.</p>
3850
+ * <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing
3851
+ * profile filter.</p>
3545
3852
  * </li>
3546
3853
  * <li>
3547
3854
  * <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
3548
- * returned.</p>
3855
+ * returned.</p>
3549
3856
  * </li>
3550
3857
  * </ul>
3551
3858
  */
@@ -4555,14 +4862,6 @@ export interface ListContactFlowsResponse {
4555
4862
  */
4556
4863
  NextToken?: string;
4557
4864
  }
4558
- export declare enum ReferenceType {
4559
- ATTACHMENT = "ATTACHMENT",
4560
- DATE = "DATE",
4561
- EMAIL = "EMAIL",
4562
- NUMBER = "NUMBER",
4563
- STRING = "STRING",
4564
- URL = "URL"
4565
- }
4566
4865
  export interface ListContactReferencesRequest {
4567
4866
  /**
4568
4867
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -4651,437 +4950,19 @@ export interface NumberReference {
4651
4950
  Value?: string;
4652
4951
  }
4653
4952
  /**
4654
- * <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
4655
- * Otherwise, null.</p>
4953
+ * @internal
4656
4954
  */
4657
- export interface StringReference {
4658
- /**
4659
- * <p>Identifier of the string reference.</p>
4660
- */
4661
- Name?: string;
4662
- /**
4663
- * <p>A valid string.</p>
4664
- */
4665
- Value?: string;
4666
- }
4955
+ export declare const ActionSummaryFilterSensitiveLog: (obj: ActionSummary) => any;
4667
4956
  /**
4668
- * <p>The URL reference.</p>
4957
+ * @internal
4669
4958
  */
4670
- export interface UrlReference {
4671
- /**
4672
- * <p>Identifier of the URL reference.</p>
4673
- */
4674
- Name?: string;
4675
- /**
4676
- * <p>A valid URL.</p>
4677
- */
4678
- Value?: string;
4679
- }
4959
+ export declare const QueueReferenceFilterSensitiveLog: (obj: QueueReference) => any;
4680
4960
  /**
4681
- * <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
4682
- * one non null field between the URL and attachment based on the reference type.</p>
4961
+ * @internal
4683
4962
  */
4684
- export declare type ReferenceSummary = ReferenceSummary.AttachmentMember | ReferenceSummary.DateMember | ReferenceSummary.EmailMember | ReferenceSummary.NumberMember | ReferenceSummary.StringMember | ReferenceSummary.UrlMember | ReferenceSummary.$UnknownMember;
4685
- export declare namespace ReferenceSummary {
4686
- /**
4687
- * <p>Information about the reference when the <code>referenceType</code> is <code>URL</code>.
4688
- * Otherwise, null.</p>
4689
- */
4690
- interface UrlMember {
4691
- Url: UrlReference;
4692
- Attachment?: never;
4693
- String?: never;
4694
- Number?: never;
4695
- Date?: never;
4696
- Email?: never;
4697
- $unknown?: never;
4698
- }
4699
- /**
4700
- * <p>Information about the reference when the <code>referenceType</code> is
4701
- * <code>ATTACHMENT</code>. Otherwise, null.</p>
4702
- */
4703
- interface AttachmentMember {
4704
- Url?: never;
4705
- Attachment: AttachmentReference;
4706
- String?: never;
4707
- Number?: never;
4708
- Date?: never;
4709
- Email?: never;
4710
- $unknown?: never;
4711
- }
4712
- /**
4713
- * <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
4714
- * Otherwise, null.</p>
4715
- */
4716
- interface StringMember {
4717
- Url?: never;
4718
- Attachment?: never;
4719
- String: StringReference;
4720
- Number?: never;
4721
- Date?: never;
4722
- Email?: never;
4723
- $unknown?: never;
4724
- }
4725
- /**
4726
- * <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
4727
- * Otherwise, null.</p>
4728
- */
4729
- interface NumberMember {
4730
- Url?: never;
4731
- Attachment?: never;
4732
- String?: never;
4733
- Number: NumberReference;
4734
- Date?: never;
4735
- Email?: never;
4736
- $unknown?: never;
4737
- }
4738
- /**
4739
- * <p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>.
4740
- * Otherwise, null.</p>
4741
- */
4742
- interface DateMember {
4743
- Url?: never;
4744
- Attachment?: never;
4745
- String?: never;
4746
- Number?: never;
4747
- Date: DateReference;
4748
- Email?: never;
4749
- $unknown?: never;
4750
- }
4751
- /**
4752
- * <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
4753
- * Otherwise, null.</p>
4754
- */
4755
- interface EmailMember {
4756
- Url?: never;
4757
- Attachment?: never;
4758
- String?: never;
4759
- Number?: never;
4760
- Date?: never;
4761
- Email: EmailReference;
4762
- $unknown?: never;
4763
- }
4764
- interface $UnknownMember {
4765
- Url?: never;
4766
- Attachment?: never;
4767
- String?: never;
4768
- Number?: never;
4769
- Date?: never;
4770
- Email?: never;
4771
- $unknown: [string, any];
4772
- }
4773
- interface Visitor<T> {
4774
- Url: (value: UrlReference) => T;
4775
- Attachment: (value: AttachmentReference) => T;
4776
- String: (value: StringReference) => T;
4777
- Number: (value: NumberReference) => T;
4778
- Date: (value: DateReference) => T;
4779
- Email: (value: EmailReference) => T;
4780
- _: (name: string, value: any) => T;
4781
- }
4782
- const visit: <T>(value: ReferenceSummary, visitor: Visitor<T>) => T;
4783
- }
4784
- export interface ListContactReferencesResponse {
4785
- /**
4786
- * <p>Information about the flows.</p>
4787
- */
4788
- ReferenceSummaryList?: ReferenceSummary[];
4789
- /**
4790
- * <p>If there are additional results, this is the token for the next set of results.</p>
4791
- * <important>
4792
- * <p>This is always returned as null in the response.</p>
4793
- * </important>
4794
- */
4795
- NextToken?: string;
4796
- }
4797
- export interface ListDefaultVocabulariesRequest {
4798
- /**
4799
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4800
- */
4801
- InstanceId: string | undefined;
4802
- /**
4803
- * <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
4804
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
4805
- * </p>
4806
- */
4807
- LanguageCode?: VocabularyLanguageCode | string;
4808
- /**
4809
- * <p>The maximum number of results to return per page.</p>
4810
- */
4811
- MaxResults?: number;
4812
- /**
4813
- * <p>The token for the next set of results. Use the value returned in the previous
4814
- * response in the next request to retrieve the next set of results.</p>
4815
- */
4816
- NextToken?: string;
4817
- }
4963
+ export declare const AgentContactReferenceFilterSensitiveLog: (obj: AgentContactReference) => any;
4818
4964
  /**
4819
- * <p>Contains information about a default vocabulary.</p>
4820
- */
4821
- export interface DefaultVocabulary {
4822
- /**
4823
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4824
- */
4825
- InstanceId: string | undefined;
4826
- /**
4827
- * <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
4828
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
4829
- * </p>
4830
- */
4831
- LanguageCode: VocabularyLanguageCode | string | undefined;
4832
- /**
4833
- * <p>The identifier of the custom vocabulary.</p>
4834
- */
4835
- VocabularyId: string | undefined;
4836
- /**
4837
- * <p>A unique name of the custom vocabulary.</p>
4838
- */
4839
- VocabularyName: string | undefined;
4840
- }
4841
- export interface ListDefaultVocabulariesResponse {
4842
- /**
4843
- * <p>A list of default vocabularies.</p>
4844
- */
4845
- DefaultVocabularyList: DefaultVocabulary[] | undefined;
4846
- /**
4847
- * <p>If there are additional results, this is the token for the next set of results.</p>
4848
- */
4849
- NextToken?: string;
4850
- }
4851
- export interface ListHoursOfOperationsRequest {
4852
- /**
4853
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4854
- */
4855
- InstanceId: string | undefined;
4856
- /**
4857
- * <p>The token for the next set of results. Use the value returned in the previous
4858
- * response in the next request to retrieve the next set of results.</p>
4859
- */
4860
- NextToken?: string;
4861
- /**
4862
- * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
4863
- */
4864
- MaxResults?: number;
4865
- }
4866
- /**
4867
- * <p>Contains summary information about hours of operation for a contact center.</p>
4868
- */
4869
- export interface HoursOfOperationSummary {
4870
- /**
4871
- * <p>The identifier of the hours of operation.</p>
4872
- */
4873
- Id?: string;
4874
- /**
4875
- * <p>The Amazon Resource Name (ARN) of the hours of operation.</p>
4876
- */
4877
- Arn?: string;
4878
- /**
4879
- * <p>The name of the hours of operation.</p>
4880
- */
4881
- Name?: string;
4882
- }
4883
- export interface ListHoursOfOperationsResponse {
4884
- /**
4885
- * <p>Information about the hours of operation.</p>
4886
- */
4887
- HoursOfOperationSummaryList?: HoursOfOperationSummary[];
4888
- /**
4889
- * <p>If there are additional results, this is the token for the next set of results.</p>
4890
- */
4891
- NextToken?: string;
4892
- }
4893
- export interface ListInstanceAttributesRequest {
4894
- /**
4895
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4896
- */
4897
- InstanceId: string | undefined;
4898
- /**
4899
- * <p>The token for the next set of results. Use the value returned in the previous
4900
- * response in the next request to retrieve the next set of results.</p>
4901
- */
4902
- NextToken?: string;
4903
- /**
4904
- * <p>The maximum number of results to return per page.</p>
4905
- */
4906
- MaxResults?: number;
4907
- }
4908
- export interface ListInstanceAttributesResponse {
4909
- /**
4910
- * <p>The attribute types.</p>
4911
- */
4912
- Attributes?: Attribute[];
4913
- /**
4914
- * <p>If there are additional results, this is the token for the next set of results.</p>
4915
- */
4916
- NextToken?: string;
4917
- }
4918
- export interface ListInstancesRequest {
4919
- /**
4920
- * <p>The token for the next set of results. Use the value returned in the previous
4921
- * response in the next request to retrieve the next set of results.</p>
4922
- */
4923
- NextToken?: string;
4924
- /**
4925
- * <p>The maximum number of results to return per page.</p>
4926
- */
4927
- MaxResults?: number;
4928
- }
4929
- /**
4930
- * <p>Information about the instance.</p>
4931
- */
4932
- export interface InstanceSummary {
4933
- /**
4934
- * <p>The identifier of the instance.</p>
4935
- */
4936
- Id?: string;
4937
- /**
4938
- * <p>The Amazon Resource Name (ARN) of the instance.</p>
4939
- */
4940
- Arn?: string;
4941
- /**
4942
- * <p>The identity management type of the instance.</p>
4943
- */
4944
- IdentityManagementType?: DirectoryType | string;
4945
- /**
4946
- * <p>The alias of the instance.</p>
4947
- */
4948
- InstanceAlias?: string;
4949
- /**
4950
- * <p>When the instance was created.</p>
4951
- */
4952
- CreatedTime?: Date;
4953
- /**
4954
- * <p>The service role of the instance.</p>
4955
- */
4956
- ServiceRole?: string;
4957
- /**
4958
- * <p>The state of the instance.</p>
4959
- */
4960
- InstanceStatus?: InstanceStatus | string;
4961
- /**
4962
- * <p>Whether inbound calls are enabled.</p>
4963
- */
4964
- InboundCallsEnabled?: boolean;
4965
- /**
4966
- * <p>Whether outbound calls are enabled.</p>
4967
- */
4968
- OutboundCallsEnabled?: boolean;
4969
- }
4970
- export interface ListInstancesResponse {
4971
- /**
4972
- * <p>Information about the instances.</p>
4973
- */
4974
- InstanceSummaryList?: InstanceSummary[];
4975
- /**
4976
- * <p>If there are additional results, this is the token for the next set of results.</p>
4977
- */
4978
- NextToken?: string;
4979
- }
4980
- export interface ListInstanceStorageConfigsRequest {
4981
- /**
4982
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4983
- */
4984
- InstanceId: string | undefined;
4985
- /**
4986
- * <p>A valid resource type.</p>
4987
- */
4988
- ResourceType: InstanceStorageResourceType | string | undefined;
4989
- /**
4990
- * <p>The token for the next set of results. Use the value returned in the previous
4991
- * response in the next request to retrieve the next set of results.</p>
4992
- */
4993
- NextToken?: string;
4994
- /**
4995
- * <p>The maximum number of results to return per page.</p>
4996
- */
4997
- MaxResults?: number;
4998
- }
4999
- export interface ListInstanceStorageConfigsResponse {
5000
- /**
5001
- * <p>A valid storage type.</p>
5002
- */
5003
- StorageConfigs?: InstanceStorageConfig[];
5004
- /**
5005
- * <p>If there are additional results, this is the token for the next set of results.</p>
5006
- */
5007
- NextToken?: string;
5008
- }
5009
- export interface ListIntegrationAssociationsRequest {
5010
- /**
5011
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5012
- */
5013
- InstanceId: string | undefined;
5014
- /**
5015
- * <p>The integration type.</p>
5016
- */
5017
- IntegrationType?: IntegrationType | string;
5018
- /**
5019
- * <p>The token for the next set of results. Use the value returned in the previous
5020
- * response in the next request to retrieve the next set of results.</p>
5021
- */
5022
- NextToken?: string;
5023
- /**
5024
- * <p>The maximum number of results to return per page.</p>
5025
- */
5026
- MaxResults?: number;
5027
- }
5028
- /**
5029
- * <p>Contains summary information about the associated AppIntegrations.</p>
5030
- */
5031
- export interface IntegrationAssociationSummary {
5032
- /**
5033
- * <p>The identifier for the AppIntegration association.</p>
5034
- */
5035
- IntegrationAssociationId?: string;
5036
- /**
5037
- * <p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>
5038
- */
5039
- IntegrationAssociationArn?: string;
5040
- /**
5041
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5042
- */
5043
- InstanceId?: string;
5044
- /**
5045
- * <p>The integration type.</p>
5046
- */
5047
- IntegrationType?: IntegrationType | string;
5048
- /**
5049
- * <p>The Amazon Resource Name (ARN) for the AppIntegration.</p>
5050
- */
5051
- IntegrationArn?: string;
5052
- /**
5053
- * <p>The URL for the external application.</p>
5054
- */
5055
- SourceApplicationUrl?: string;
5056
- /**
5057
- * <p>The user-provided, friendly name for the external application.</p>
5058
- */
5059
- SourceApplicationName?: string;
5060
- /**
5061
- * <p>The name of the source.</p>
5062
- */
5063
- SourceType?: SourceType | string;
5064
- }
5065
- export interface ListIntegrationAssociationsResponse {
5066
- /**
5067
- * <p>The associations.</p>
5068
- */
5069
- IntegrationAssociationSummaryList?: IntegrationAssociationSummary[];
5070
- /**
5071
- * <p>If there are additional results, this is the token for the next set of results.</p>
5072
- */
5073
- NextToken?: string;
5074
- }
5075
- /**
5076
- * @internal
5077
- */
5078
- export declare const QueueReferenceFilterSensitiveLog: (obj: QueueReference) => any;
5079
- /**
5080
- * @internal
5081
- */
5082
- export declare const AgentContactReferenceFilterSensitiveLog: (obj: AgentContactReference) => any;
5083
- /**
5084
- * @internal
4965
+ * @internal
5085
4966
  */
5086
4967
  export declare const AgentInfoFilterSensitiveLog: (obj: AgentInfo) => any;
5087
4968
  /**
@@ -5304,6 +5185,46 @@ export declare const CreateRoutingProfileRequestFilterSensitiveLog: (obj: Create
5304
5185
  * @internal
5305
5186
  */
5306
5187
  export declare const CreateRoutingProfileResponseFilterSensitiveLog: (obj: CreateRoutingProfileResponse) => any;
5188
+ /**
5189
+ * @internal
5190
+ */
5191
+ export declare const AssignContactCategoryActionDefinitionFilterSensitiveLog: (obj: AssignContactCategoryActionDefinition) => any;
5192
+ /**
5193
+ * @internal
5194
+ */
5195
+ export declare const EventBridgeActionDefinitionFilterSensitiveLog: (obj: EventBridgeActionDefinition) => any;
5196
+ /**
5197
+ * @internal
5198
+ */
5199
+ export declare const NotificationRecipientTypeFilterSensitiveLog: (obj: NotificationRecipientType) => any;
5200
+ /**
5201
+ * @internal
5202
+ */
5203
+ export declare const SendNotificationActionDefinitionFilterSensitiveLog: (obj: SendNotificationActionDefinition) => any;
5204
+ /**
5205
+ * @internal
5206
+ */
5207
+ export declare const ReferenceFilterSensitiveLog: (obj: Reference) => any;
5208
+ /**
5209
+ * @internal
5210
+ */
5211
+ export declare const TaskActionDefinitionFilterSensitiveLog: (obj: TaskActionDefinition) => any;
5212
+ /**
5213
+ * @internal
5214
+ */
5215
+ export declare const RuleActionFilterSensitiveLog: (obj: RuleAction) => any;
5216
+ /**
5217
+ * @internal
5218
+ */
5219
+ export declare const RuleTriggerEventSourceFilterSensitiveLog: (obj: RuleTriggerEventSource) => any;
5220
+ /**
5221
+ * @internal
5222
+ */
5223
+ export declare const CreateRuleRequestFilterSensitiveLog: (obj: CreateRuleRequest) => any;
5224
+ /**
5225
+ * @internal
5226
+ */
5227
+ export declare const CreateRuleResponseFilterSensitiveLog: (obj: CreateRuleResponse) => any;
5307
5228
  /**
5308
5229
  * @internal
5309
5230
  */
@@ -5432,6 +5353,10 @@ export declare const DeleteIntegrationAssociationRequestFilterSensitiveLog: (obj
5432
5353
  * @internal
5433
5354
  */
5434
5355
  export declare const DeleteQuickConnectRequestFilterSensitiveLog: (obj: DeleteQuickConnectRequest) => any;
5356
+ /**
5357
+ * @internal
5358
+ */
5359
+ export declare const DeleteRuleRequestFilterSensitiveLog: (obj: DeleteRuleRequest) => any;
5435
5360
  /**
5436
5361
  * @internal
5437
5362
  */
@@ -5620,6 +5545,18 @@ export declare const RoutingProfileFilterSensitiveLog: (obj: RoutingProfile) =>
5620
5545
  * @internal
5621
5546
  */
5622
5547
  export declare const DescribeRoutingProfileResponseFilterSensitiveLog: (obj: DescribeRoutingProfileResponse) => any;
5548
+ /**
5549
+ * @internal
5550
+ */
5551
+ export declare const DescribeRuleRequestFilterSensitiveLog: (obj: DescribeRuleRequest) => any;
5552
+ /**
5553
+ * @internal
5554
+ */
5555
+ export declare const RuleFilterSensitiveLog: (obj: Rule) => any;
5556
+ /**
5557
+ * @internal
5558
+ */
5559
+ export declare const DescribeRuleResponseFilterSensitiveLog: (obj: DescribeRuleResponse) => any;
5623
5560
  /**
5624
5561
  * @internal
5625
5562
  */
@@ -5952,83 +5889,3 @@ export declare const EmailReferenceFilterSensitiveLog: (obj: EmailReference) =>
5952
5889
  * @internal
5953
5890
  */
5954
5891
  export declare const NumberReferenceFilterSensitiveLog: (obj: NumberReference) => any;
5955
- /**
5956
- * @internal
5957
- */
5958
- export declare const StringReferenceFilterSensitiveLog: (obj: StringReference) => any;
5959
- /**
5960
- * @internal
5961
- */
5962
- export declare const UrlReferenceFilterSensitiveLog: (obj: UrlReference) => any;
5963
- /**
5964
- * @internal
5965
- */
5966
- export declare const ReferenceSummaryFilterSensitiveLog: (obj: ReferenceSummary) => any;
5967
- /**
5968
- * @internal
5969
- */
5970
- export declare const ListContactReferencesResponseFilterSensitiveLog: (obj: ListContactReferencesResponse) => any;
5971
- /**
5972
- * @internal
5973
- */
5974
- export declare const ListDefaultVocabulariesRequestFilterSensitiveLog: (obj: ListDefaultVocabulariesRequest) => any;
5975
- /**
5976
- * @internal
5977
- */
5978
- export declare const DefaultVocabularyFilterSensitiveLog: (obj: DefaultVocabulary) => any;
5979
- /**
5980
- * @internal
5981
- */
5982
- export declare const ListDefaultVocabulariesResponseFilterSensitiveLog: (obj: ListDefaultVocabulariesResponse) => any;
5983
- /**
5984
- * @internal
5985
- */
5986
- export declare const ListHoursOfOperationsRequestFilterSensitiveLog: (obj: ListHoursOfOperationsRequest) => any;
5987
- /**
5988
- * @internal
5989
- */
5990
- export declare const HoursOfOperationSummaryFilterSensitiveLog: (obj: HoursOfOperationSummary) => any;
5991
- /**
5992
- * @internal
5993
- */
5994
- export declare const ListHoursOfOperationsResponseFilterSensitiveLog: (obj: ListHoursOfOperationsResponse) => any;
5995
- /**
5996
- * @internal
5997
- */
5998
- export declare const ListInstanceAttributesRequestFilterSensitiveLog: (obj: ListInstanceAttributesRequest) => any;
5999
- /**
6000
- * @internal
6001
- */
6002
- export declare const ListInstanceAttributesResponseFilterSensitiveLog: (obj: ListInstanceAttributesResponse) => any;
6003
- /**
6004
- * @internal
6005
- */
6006
- export declare const ListInstancesRequestFilterSensitiveLog: (obj: ListInstancesRequest) => any;
6007
- /**
6008
- * @internal
6009
- */
6010
- export declare const InstanceSummaryFilterSensitiveLog: (obj: InstanceSummary) => any;
6011
- /**
6012
- * @internal
6013
- */
6014
- export declare const ListInstancesResponseFilterSensitiveLog: (obj: ListInstancesResponse) => any;
6015
- /**
6016
- * @internal
6017
- */
6018
- export declare const ListInstanceStorageConfigsRequestFilterSensitiveLog: (obj: ListInstanceStorageConfigsRequest) => any;
6019
- /**
6020
- * @internal
6021
- */
6022
- export declare const ListInstanceStorageConfigsResponseFilterSensitiveLog: (obj: ListInstanceStorageConfigsResponse) => any;
6023
- /**
6024
- * @internal
6025
- */
6026
- export declare const ListIntegrationAssociationsRequestFilterSensitiveLog: (obj: ListIntegrationAssociationsRequest) => any;
6027
- /**
6028
- * @internal
6029
- */
6030
- export declare const IntegrationAssociationSummaryFilterSensitiveLog: (obj: IntegrationAssociationSummary) => any;
6031
- /**
6032
- * @internal
6033
- */
6034
- export declare const ListIntegrationAssociationsResponseFilterSensitiveLog: (obj: ListIntegrationAssociationsResponse) => any;