@aws-sdk/client-connect 3.348.0 → 3.352.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 (67) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/Connect.js +6 -0
  3. package/dist-cjs/commands/SearchHoursOfOperationsCommand.js +46 -0
  4. package/dist-cjs/commands/SearchPromptsCommand.js +46 -0
  5. package/dist-cjs/commands/SearchQuickConnectsCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/models/index.js +1 -0
  8. package/dist-cjs/models/models_1.js +4 -4
  9. package/dist-cjs/models/models_2.js +2 -0
  10. package/dist-cjs/pagination/SearchHoursOfOperationsPaginator.js +29 -0
  11. package/dist-cjs/pagination/SearchPromptsPaginator.js +29 -0
  12. package/dist-cjs/pagination/SearchQuickConnectsPaginator.js +29 -0
  13. package/dist-cjs/pagination/index.js +3 -0
  14. package/dist-cjs/protocols/Aws_restJson1.js +267 -6
  15. package/dist-es/Connect.js +6 -0
  16. package/dist-es/commands/SearchHoursOfOperationsCommand.js +42 -0
  17. package/dist-es/commands/SearchPromptsCommand.js +42 -0
  18. package/dist-es/commands/SearchQuickConnectsCommand.js +42 -0
  19. package/dist-es/commands/index.js +3 -0
  20. package/dist-es/models/index.js +1 -0
  21. package/dist-es/models/models_1.js +3 -3
  22. package/dist-es/models/models_2.js +1 -0
  23. package/dist-es/pagination/SearchHoursOfOperationsPaginator.js +25 -0
  24. package/dist-es/pagination/SearchPromptsPaginator.js +25 -0
  25. package/dist-es/pagination/SearchQuickConnectsPaginator.js +25 -0
  26. package/dist-es/pagination/index.js +3 -0
  27. package/dist-es/protocols/Aws_restJson1.js +255 -0
  28. package/dist-types/Connect.d.ts +21 -0
  29. package/dist-types/ConnectClient.d.ts +5 -2
  30. package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +1 -1
  31. package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +161 -0
  32. package/dist-types/commands/SearchPromptsCommand.d.ts +147 -0
  33. package/dist-types/commands/SearchQueuesCommand.d.ts +2 -1
  34. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +161 -0
  35. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +2 -1
  36. package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
  37. package/dist-types/commands/SearchUsersCommand.d.ts +2 -1
  38. package/dist-types/commands/index.d.ts +3 -0
  39. package/dist-types/models/index.d.ts +1 -0
  40. package/dist-types/models/models_0.d.ts +1 -1
  41. package/dist-types/models/models_1.d.ts +202 -163
  42. package/dist-types/models/models_2.d.ts +216 -0
  43. package/dist-types/pagination/SearchHoursOfOperationsPaginator.d.ts +7 -0
  44. package/dist-types/pagination/SearchPromptsPaginator.d.ts +7 -0
  45. package/dist-types/pagination/SearchQuickConnectsPaginator.d.ts +7 -0
  46. package/dist-types/pagination/index.d.ts +3 -0
  47. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  48. package/dist-types/ts3.4/Connect.d.ts +51 -0
  49. package/dist-types/ts3.4/ConnectClient.d.ts +18 -0
  50. package/dist-types/ts3.4/commands/DescribeEvaluationFormCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/SearchHoursOfOperationsCommand.d.ts +40 -0
  52. package/dist-types/ts3.4/commands/SearchPromptsCommand.d.ts +36 -0
  53. package/dist-types/ts3.4/commands/SearchQueuesCommand.d.ts +2 -1
  54. package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +37 -0
  55. package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +2 -4
  56. package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +2 -4
  57. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +2 -1
  58. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  59. package/dist-types/ts3.4/models/index.d.ts +1 -0
  60. package/dist-types/ts3.4/models/models_1.d.ts +47 -36
  61. package/dist-types/ts3.4/models/models_2.d.ts +69 -0
  62. package/dist-types/ts3.4/pagination/SearchHoursOfOperationsPaginator.d.ts +11 -0
  63. package/dist-types/ts3.4/pagination/SearchPromptsPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/SearchQuickConnectsPaginator.d.ts +11 -0
  65. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  66. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  67. package/package.json +6 -6
@@ -1,6 +1,6 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, DirectoryType, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueReference, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
3
+ import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, DirectoryType, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QueueStatus, QuickConnect, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
4
  /**
5
5
  * @public
6
6
  * <p>Contains the data for a real-time metric.</p>
@@ -3558,17 +3558,6 @@ export interface SearchAvailablePhoneNumbersResponse {
3558
3558
  */
3559
3559
  AvailableNumbersList?: AvailableNumberSummary[];
3560
3560
  }
3561
- /**
3562
- * @public
3563
- * @enum
3564
- */
3565
- export declare const SearchableQueueType: {
3566
- readonly STANDARD: "STANDARD";
3567
- };
3568
- /**
3569
- * @public
3570
- */
3571
- export type SearchableQueueType = (typeof SearchableQueueType)[keyof typeof SearchableQueueType];
3572
3561
  /**
3573
3562
  * @public
3574
3563
  * @enum
@@ -3585,10 +3574,6 @@ export type StringComparisonType = (typeof StringComparisonType)[keyof typeof St
3585
3574
  /**
3586
3575
  * @public
3587
3576
  * <p>A leaf node condition which can be used to specify a string condition. </p>
3588
- * <note>
3589
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
3590
- * </p>
3591
- * </note>
3592
3577
  */
3593
3578
  export interface StringCondition {
3594
3579
  /**
@@ -3650,6 +3635,93 @@ export interface ControlPlaneTagFilter {
3650
3635
  */
3651
3636
  TagCondition?: TagCondition;
3652
3637
  }
3638
+ /**
3639
+ * @public
3640
+ * <p>Filters to be applied to search results.</p>
3641
+ */
3642
+ export interface HoursOfOperationSearchFilter {
3643
+ /**
3644
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
3645
+ * This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
3646
+ * <ul>
3647
+ * <li>
3648
+ * <p>Top level list specifies conditions that need to be applied with <code>OR</code>
3649
+ * operator</p>
3650
+ * </li>
3651
+ * <li>
3652
+ * <p>Inner list specifies conditions that need to be applied with <code>AND</code>
3653
+ * operator.</p>
3654
+ * </li>
3655
+ * </ul>
3656
+ */
3657
+ TagFilter?: ControlPlaneTagFilter;
3658
+ }
3659
+ /**
3660
+ * @public
3661
+ */
3662
+ export interface SearchHoursOfOperationsResponse {
3663
+ /**
3664
+ * <p>Information about the hours of operations.</p>
3665
+ */
3666
+ HoursOfOperations?: HoursOfOperation[];
3667
+ /**
3668
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3669
+ */
3670
+ NextToken?: string;
3671
+ /**
3672
+ * <p>The total number of hours of operations which matched your search query.</p>
3673
+ */
3674
+ ApproximateTotalCount?: number;
3675
+ }
3676
+ /**
3677
+ * @public
3678
+ * <p>Filters to be applied to search results.</p>
3679
+ */
3680
+ export interface PromptSearchFilter {
3681
+ /**
3682
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
3683
+ * This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
3684
+ * <ul>
3685
+ * <li>
3686
+ * <p>Top level list specifies conditions that need to be applied with <code>OR</code>
3687
+ * operator</p>
3688
+ * </li>
3689
+ * <li>
3690
+ * <p>Inner list specifies conditions that need to be applied with <code>AND</code>
3691
+ * operator.</p>
3692
+ * </li>
3693
+ * </ul>
3694
+ */
3695
+ TagFilter?: ControlPlaneTagFilter;
3696
+ }
3697
+ /**
3698
+ * @public
3699
+ */
3700
+ export interface SearchPromptsResponse {
3701
+ /**
3702
+ * <p>Information about the prompts.</p>
3703
+ */
3704
+ Prompts?: Prompt[];
3705
+ /**
3706
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3707
+ */
3708
+ NextToken?: string;
3709
+ /**
3710
+ * <p>The total number of quick connects which matched your search query.</p>
3711
+ */
3712
+ ApproximateTotalCount?: number;
3713
+ }
3714
+ /**
3715
+ * @public
3716
+ * @enum
3717
+ */
3718
+ export declare const SearchableQueueType: {
3719
+ readonly STANDARD: "STANDARD";
3720
+ };
3721
+ /**
3722
+ * @public
3723
+ */
3724
+ export type SearchableQueueType = (typeof SearchableQueueType)[keyof typeof SearchableQueueType];
3653
3725
  /**
3654
3726
  * @public
3655
3727
  * <p>Filters to be applied to search results.</p>
@@ -3688,6 +3760,44 @@ export interface SearchQueuesResponse {
3688
3760
  */
3689
3761
  ApproximateTotalCount?: number;
3690
3762
  }
3763
+ /**
3764
+ * @public
3765
+ * <p>Filters to be applied to search results.</p>
3766
+ */
3767
+ export interface QuickConnectSearchFilter {
3768
+ /**
3769
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
3770
+ * This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
3771
+ * <ul>
3772
+ * <li>
3773
+ * <p>Top level list specifies conditions that need to be applied with <code>OR</code>
3774
+ * operator</p>
3775
+ * </li>
3776
+ * <li>
3777
+ * <p>Inner list specifies conditions that need to be applied with <code>AND</code>
3778
+ * operator.</p>
3779
+ * </li>
3780
+ * </ul>
3781
+ */
3782
+ TagFilter?: ControlPlaneTagFilter;
3783
+ }
3784
+ /**
3785
+ * @public
3786
+ */
3787
+ export interface SearchQuickConnectsResponse {
3788
+ /**
3789
+ * <p>Information about the quick connects.</p>
3790
+ */
3791
+ QuickConnects?: QuickConnect[];
3792
+ /**
3793
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3794
+ */
3795
+ NextToken?: string;
3796
+ /**
3797
+ * <p>The total number of quick connects which matched your search query.</p>
3798
+ */
3799
+ ApproximateTotalCount?: number;
3800
+ }
3691
3801
  /**
3692
3802
  * @public
3693
3803
  * <p>Filters to be applied to search results.</p>
@@ -6067,6 +6177,50 @@ export interface EvaluationFormContent {
6067
6177
  */
6068
6178
  ScoringStrategy?: EvaluationFormScoringStrategy;
6069
6179
  }
6180
+ /**
6181
+ * @public
6182
+ * <p>The search criteria to be used to return hours of operations.</p>
6183
+ */
6184
+ export interface HoursOfOperationSearchCriteria {
6185
+ /**
6186
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
6187
+ */
6188
+ OrConditions?: HoursOfOperationSearchCriteria[];
6189
+ /**
6190
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
6191
+ */
6192
+ AndConditions?: HoursOfOperationSearchCriteria[];
6193
+ /**
6194
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6195
+ * <note>
6196
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6197
+ * <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
6198
+ * </note>
6199
+ */
6200
+ StringCondition?: StringCondition;
6201
+ }
6202
+ /**
6203
+ * @public
6204
+ * <p>The search criteria to be used to return prompts.</p>
6205
+ */
6206
+ export interface PromptSearchCriteria {
6207
+ /**
6208
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
6209
+ */
6210
+ OrConditions?: PromptSearchCriteria[];
6211
+ /**
6212
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
6213
+ */
6214
+ AndConditions?: PromptSearchCriteria[];
6215
+ /**
6216
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6217
+ * <note>
6218
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6219
+ * <code>description</code>, and <code>resourceID</code>.</p>
6220
+ * </note>
6221
+ */
6222
+ StringCondition?: StringCondition;
6223
+ }
6070
6224
  /**
6071
6225
  * @public
6072
6226
  * <p>The search criteria to be used to return queues.</p>
@@ -6086,10 +6240,10 @@ export interface QueueSearchCriteria {
6086
6240
  */
6087
6241
  AndConditions?: QueueSearchCriteria[];
6088
6242
  /**
6089
- * <p>A leaf node condition which can be used to specify a string condition. </p>
6243
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6090
6244
  * <note>
6091
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
6092
- * </p>
6245
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6246
+ * <code>description</code>, and <code>resourceID</code>.</p>
6093
6247
  * </note>
6094
6248
  */
6095
6249
  StringCondition?: StringCondition;
@@ -6098,6 +6252,28 @@ export interface QueueSearchCriteria {
6098
6252
  */
6099
6253
  QueueTypeCondition?: SearchableQueueType | string;
6100
6254
  }
6255
+ /**
6256
+ * @public
6257
+ * <p>The search criteria to be used to return quick connects.</p>
6258
+ */
6259
+ export interface QuickConnectSearchCriteria {
6260
+ /**
6261
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
6262
+ */
6263
+ OrConditions?: QuickConnectSearchCriteria[];
6264
+ /**
6265
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
6266
+ */
6267
+ AndConditions?: QuickConnectSearchCriteria[];
6268
+ /**
6269
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6270
+ * <note>
6271
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6272
+ * <code>description</code>, and <code>resourceID</code>.</p>
6273
+ * </note>
6274
+ */
6275
+ StringCondition?: StringCondition;
6276
+ }
6101
6277
  /**
6102
6278
  * @public
6103
6279
  * <p>The search criteria to be used to return routing profiles.</p>
@@ -6117,10 +6293,10 @@ export interface RoutingProfileSearchCriteria {
6117
6293
  */
6118
6294
  AndConditions?: RoutingProfileSearchCriteria[];
6119
6295
  /**
6120
- * <p>A leaf node condition which can be used to specify a string condition. </p>
6296
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
6121
6297
  * <note>
6122
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
6123
- * </p>
6298
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6299
+ * <code>description</code>, and <code>resourceID</code>.</p>
6124
6300
  * </note>
6125
6301
  */
6126
6302
  StringCondition?: StringCondition;
@@ -6145,10 +6321,6 @@ export interface SecurityProfileSearchCriteria {
6145
6321
  AndConditions?: SecurityProfileSearchCriteria[];
6146
6322
  /**
6147
6323
  * <p>A leaf node condition which can be used to specify a string condition. </p>
6148
- * <note>
6149
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
6150
- * </p>
6151
- * </note>
6152
6324
  */
6153
6325
  StringCondition?: StringCondition;
6154
6326
  }
@@ -6218,6 +6390,10 @@ export interface UserSearchCriteria {
6218
6390
  AndConditions?: UserSearchCriteria[];
6219
6391
  /**
6220
6392
  * <p>A leaf node condition which can be used to specify a string condition.</p>
6393
+ * <note>
6394
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6395
+ * <code>description</code>, and <code>resourceID</code>.</p>
6396
+ * </note>
6221
6397
  */
6222
6398
  StringCondition?: StringCondition;
6223
6399
  /**
@@ -6238,143 +6414,6 @@ export interface DescribeContactEvaluationResponse {
6238
6414
  */
6239
6415
  EvaluationForm: EvaluationFormContent | undefined;
6240
6416
  }
6241
- /**
6242
- * @public
6243
- */
6244
- export interface DescribeEvaluationFormResponse {
6245
- /**
6246
- * <p>Information about the evaluation form.</p>
6247
- */
6248
- EvaluationForm: EvaluationForm | undefined;
6249
- }
6250
- /**
6251
- * @public
6252
- */
6253
- export interface SearchQueuesRequest {
6254
- /**
6255
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
6256
- */
6257
- InstanceId: string | undefined;
6258
- /**
6259
- * <p>The token for the next set of results. Use the value returned in the previous
6260
- * response in the next request to retrieve the next set of results.</p>
6261
- */
6262
- NextToken?: string;
6263
- /**
6264
- * <p>The maximum number of results to return per page.</p>
6265
- */
6266
- MaxResults?: number;
6267
- /**
6268
- * <p>Filters to be applied to search results.</p>
6269
- */
6270
- SearchFilter?: QueueSearchFilter;
6271
- /**
6272
- * <p>The search criteria to be used to return queues.</p>
6273
- * <note>
6274
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
6275
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
6276
- * outside of this range will throw invalid results. </p>
6277
- * </note>
6278
- */
6279
- SearchCriteria?: QueueSearchCriteria;
6280
- }
6281
- /**
6282
- * @public
6283
- */
6284
- export interface SearchRoutingProfilesRequest {
6285
- /**
6286
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
6287
- */
6288
- InstanceId: string | undefined;
6289
- /**
6290
- * <p>The token for the next set of results. Use the value returned in the previous
6291
- * response in the next request to retrieve the next set of results.</p>
6292
- */
6293
- NextToken?: string;
6294
- /**
6295
- * <p>The maximum number of results to return per page.</p>
6296
- */
6297
- MaxResults?: number;
6298
- /**
6299
- * <p>Filters to be applied to search results.</p>
6300
- */
6301
- SearchFilter?: RoutingProfileSearchFilter;
6302
- /**
6303
- * <p>The search criteria to be used to return routing profiles.</p>
6304
- * <note>
6305
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
6306
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
6307
- * outside of this range will throw invalid results. </p>
6308
- * </note>
6309
- */
6310
- SearchCriteria?: RoutingProfileSearchCriteria;
6311
- }
6312
- /**
6313
- * @public
6314
- */
6315
- export interface SearchSecurityProfilesRequest {
6316
- /**
6317
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
6318
- */
6319
- InstanceId: string | undefined;
6320
- /**
6321
- * <p>The token for the next set of results. Use the value returned in the previous
6322
- * response in the next request to retrieve the next set of results.</p>
6323
- */
6324
- NextToken?: string;
6325
- /**
6326
- * <p>The maximum number of results to return per page.</p>
6327
- */
6328
- MaxResults?: number;
6329
- /**
6330
- * <p>The search criteria to be used to return security profiles. </p>
6331
- * <note>
6332
- * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
6333
- * maximum of 25 characters. Any queries with character lengths outside of this range will throw
6334
- * invalid results.</p>
6335
- * </note>
6336
- * <note>
6337
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
6338
- * </p>
6339
- * </note>
6340
- */
6341
- SearchCriteria?: SecurityProfileSearchCriteria;
6342
- /**
6343
- * <p>Filters to be applied to search results.</p>
6344
- */
6345
- SearchFilter?: SecurityProfilesSearchFilter;
6346
- }
6347
- /**
6348
- * @public
6349
- */
6350
- export interface SearchUsersRequest {
6351
- /**
6352
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
6353
- */
6354
- InstanceId?: string;
6355
- /**
6356
- * <p>The token for the next set of results. Use the value returned in the previous
6357
- * response in the next request to retrieve the next set of results.</p>
6358
- */
6359
- NextToken?: string;
6360
- /**
6361
- * <p>The maximum number of results to return per page.</p>
6362
- */
6363
- MaxResults?: number;
6364
- /**
6365
- * <p>Filters to be applied to search results.</p>
6366
- */
6367
- SearchFilter?: UserSearchFilter;
6368
- /**
6369
- * <p>The search criteria to be used to return users.</p>
6370
- * <note>
6371
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
6372
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
6373
- * outside of this range will throw invalid results. </p>
6374
- * </note>
6375
- */
6376
- SearchCriteria?: UserSearchCriteria;
6377
- }
6378
6417
  /**
6379
6418
  * @internal
6380
6419
  */
@@ -0,0 +1,216 @@
1
+ import { EvaluationForm, HoursOfOperationSearchCriteria, HoursOfOperationSearchFilter, PromptSearchCriteria, PromptSearchFilter, QueueSearchCriteria, QueueSearchFilter, QuickConnectSearchCriteria, QuickConnectSearchFilter, RoutingProfileSearchCriteria, RoutingProfileSearchFilter, SecurityProfileSearchCriteria, SecurityProfilesSearchFilter, UserSearchCriteria, UserSearchFilter } from "./models_1";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface DescribeEvaluationFormResponse {
6
+ /**
7
+ * <p>Information about the evaluation form.</p>
8
+ */
9
+ EvaluationForm: EvaluationForm | undefined;
10
+ }
11
+ /**
12
+ * @public
13
+ */
14
+ export interface SearchHoursOfOperationsRequest {
15
+ /**
16
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
17
+ */
18
+ InstanceId: string | undefined;
19
+ /**
20
+ * <p>The token for the next set of results. Use the value returned in the previous
21
+ * response in the next request to retrieve the next set of results.</p>
22
+ */
23
+ NextToken?: string;
24
+ /**
25
+ * <p>The maximum number of results to return per page.</p>
26
+ */
27
+ MaxResults?: number;
28
+ /**
29
+ * <p>Filters to be applied to search results.</p>
30
+ */
31
+ SearchFilter?: HoursOfOperationSearchFilter;
32
+ /**
33
+ * <p>The search criteria to be used to return hours of operations.</p>
34
+ */
35
+ SearchCriteria?: HoursOfOperationSearchCriteria;
36
+ }
37
+ /**
38
+ * @public
39
+ */
40
+ export interface SearchPromptsRequest {
41
+ /**
42
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
43
+ */
44
+ InstanceId: string | undefined;
45
+ /**
46
+ * <p>The token for the next set of results. Use the value returned in the previous
47
+ * response in the next request to retrieve the next set of results.</p>
48
+ */
49
+ NextToken?: string;
50
+ /**
51
+ * <p>The maximum number of results to return per page.</p>
52
+ */
53
+ MaxResults?: number;
54
+ /**
55
+ * <p>Filters to be applied to search results.</p>
56
+ */
57
+ SearchFilter?: PromptSearchFilter;
58
+ /**
59
+ * <p>The search criteria to be used to return prompts.</p>
60
+ */
61
+ SearchCriteria?: PromptSearchCriteria;
62
+ }
63
+ /**
64
+ * @public
65
+ */
66
+ export interface SearchQueuesRequest {
67
+ /**
68
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
69
+ */
70
+ InstanceId: string | undefined;
71
+ /**
72
+ * <p>The token for the next set of results. Use the value returned in the previous
73
+ * response in the next request to retrieve the next set of results.</p>
74
+ */
75
+ NextToken?: string;
76
+ /**
77
+ * <p>The maximum number of results to return per page.</p>
78
+ */
79
+ MaxResults?: number;
80
+ /**
81
+ * <p>Filters to be applied to search results.</p>
82
+ */
83
+ SearchFilter?: QueueSearchFilter;
84
+ /**
85
+ * <p>The search criteria to be used to return queues.</p>
86
+ * <note>
87
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
88
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
89
+ * outside of this range will throw invalid results. </p>
90
+ * </note>
91
+ */
92
+ SearchCriteria?: QueueSearchCriteria;
93
+ }
94
+ /**
95
+ * @public
96
+ */
97
+ export interface SearchQuickConnectsRequest {
98
+ /**
99
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
100
+ */
101
+ InstanceId: string | undefined;
102
+ /**
103
+ * <p>The token for the next set of results. Use the value returned in the previous
104
+ * response in the next request to retrieve the next set of results.</p>
105
+ */
106
+ NextToken?: string;
107
+ /**
108
+ * <p>The maximum number of results to return per page.</p>
109
+ */
110
+ MaxResults?: number;
111
+ /**
112
+ * <p>Filters to be applied to search results.</p>
113
+ */
114
+ SearchFilter?: QuickConnectSearchFilter;
115
+ /**
116
+ * <p>The search criteria to be used to return quick connects.</p>
117
+ */
118
+ SearchCriteria?: QuickConnectSearchCriteria;
119
+ }
120
+ /**
121
+ * @public
122
+ */
123
+ export interface SearchRoutingProfilesRequest {
124
+ /**
125
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
126
+ */
127
+ InstanceId: string | undefined;
128
+ /**
129
+ * <p>The token for the next set of results. Use the value returned in the previous
130
+ * response in the next request to retrieve the next set of results.</p>
131
+ */
132
+ NextToken?: string;
133
+ /**
134
+ * <p>The maximum number of results to return per page.</p>
135
+ */
136
+ MaxResults?: number;
137
+ /**
138
+ * <p>Filters to be applied to search results.</p>
139
+ */
140
+ SearchFilter?: RoutingProfileSearchFilter;
141
+ /**
142
+ * <p>The search criteria to be used to return routing profiles.</p>
143
+ * <note>
144
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
145
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
146
+ * outside of this range will throw invalid results. </p>
147
+ * </note>
148
+ */
149
+ SearchCriteria?: RoutingProfileSearchCriteria;
150
+ }
151
+ /**
152
+ * @public
153
+ */
154
+ export interface SearchSecurityProfilesRequest {
155
+ /**
156
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
157
+ */
158
+ InstanceId: string | undefined;
159
+ /**
160
+ * <p>The token for the next set of results. Use the value returned in the previous
161
+ * response in the next request to retrieve the next set of results.</p>
162
+ */
163
+ NextToken?: string;
164
+ /**
165
+ * <p>The maximum number of results to return per page.</p>
166
+ */
167
+ MaxResults?: number;
168
+ /**
169
+ * <p>The search criteria to be used to return security profiles. </p>
170
+ * <note>
171
+ * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
172
+ * maximum of 25 characters. Any queries with character lengths outside of this range will throw
173
+ * invalid results.</p>
174
+ * </note>
175
+ * <note>
176
+ * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
177
+ * </p>
178
+ * </note>
179
+ */
180
+ SearchCriteria?: SecurityProfileSearchCriteria;
181
+ /**
182
+ * <p>Filters to be applied to search results.</p>
183
+ */
184
+ SearchFilter?: SecurityProfilesSearchFilter;
185
+ }
186
+ /**
187
+ * @public
188
+ */
189
+ export interface SearchUsersRequest {
190
+ /**
191
+ * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
192
+ */
193
+ InstanceId?: string;
194
+ /**
195
+ * <p>The token for the next set of results. Use the value returned in the previous
196
+ * response in the next request to retrieve the next set of results.</p>
197
+ */
198
+ NextToken?: string;
199
+ /**
200
+ * <p>The maximum number of results to return per page.</p>
201
+ */
202
+ MaxResults?: number;
203
+ /**
204
+ * <p>Filters to be applied to search results.</p>
205
+ */
206
+ SearchFilter?: UserSearchFilter;
207
+ /**
208
+ * <p>The search criteria to be used to return users.</p>
209
+ * <note>
210
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
211
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
212
+ * outside of this range will throw invalid results. </p>
213
+ * </note>
214
+ */
215
+ SearchCriteria?: UserSearchCriteria;
216
+ }
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { SearchHoursOfOperationsCommandInput, SearchHoursOfOperationsCommandOutput } from "../commands/SearchHoursOfOperationsCommand";
3
+ import { ConnectPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare function paginateSearchHoursOfOperations(config: ConnectPaginationConfiguration, input: SearchHoursOfOperationsCommandInput, ...additionalArguments: any): Paginator<SearchHoursOfOperationsCommandOutput>;
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { SearchPromptsCommandInput, SearchPromptsCommandOutput } from "../commands/SearchPromptsCommand";
3
+ import { ConnectPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare function paginateSearchPrompts(config: ConnectPaginationConfiguration, input: SearchPromptsCommandInput, ...additionalArguments: any): Paginator<SearchPromptsCommandOutput>;