@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
@@ -0,0 +1,147 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
+ import { SearchPromptsResponse } from "../models/models_1";
6
+ import { SearchPromptsRequest } from "../models/models_2";
7
+ /**
8
+ * @public
9
+ */
10
+ export { __MetadataBearer, $Command };
11
+ /**
12
+ * @public
13
+ *
14
+ * The input for {@link SearchPromptsCommand}.
15
+ */
16
+ export interface SearchPromptsCommandInput extends SearchPromptsRequest {
17
+ }
18
+ /**
19
+ * @public
20
+ *
21
+ * The output of {@link SearchPromptsCommand}.
22
+ */
23
+ export interface SearchPromptsCommandOutput extends SearchPromptsResponse, __MetadataBearer {
24
+ }
25
+ /**
26
+ * @public
27
+ * <p>Searches prompts in an Amazon Connect instance, with optional filtering.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { ConnectClient, SearchPromptsCommand } from "@aws-sdk/client-connect"; // ES Modules import
32
+ * // const { ConnectClient, SearchPromptsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
33
+ * const client = new ConnectClient(config);
34
+ * const input = { // SearchPromptsRequest
35
+ * InstanceId: "STRING_VALUE", // required
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * SearchFilter: { // PromptSearchFilter
39
+ * TagFilter: { // ControlPlaneTagFilter
40
+ * OrConditions: [ // TagOrConditionList
41
+ * [ // TagAndConditionList
42
+ * { // TagCondition
43
+ * TagKey: "STRING_VALUE",
44
+ * TagValue: "STRING_VALUE",
45
+ * },
46
+ * ],
47
+ * ],
48
+ * AndConditions: [
49
+ * {
50
+ * TagKey: "STRING_VALUE",
51
+ * TagValue: "STRING_VALUE",
52
+ * },
53
+ * ],
54
+ * TagCondition: "<TagCondition>",
55
+ * },
56
+ * },
57
+ * SearchCriteria: { // PromptSearchCriteria
58
+ * OrConditions: [ // PromptSearchConditionList
59
+ * {
60
+ * OrConditions: [
61
+ * "<PromptSearchCriteria>",
62
+ * ],
63
+ * AndConditions: [
64
+ * "<PromptSearchCriteria>",
65
+ * ],
66
+ * StringCondition: { // StringCondition
67
+ * FieldName: "STRING_VALUE",
68
+ * Value: "STRING_VALUE",
69
+ * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
70
+ * },
71
+ * },
72
+ * ],
73
+ * AndConditions: [
74
+ * "<PromptSearchCriteria>",
75
+ * ],
76
+ * StringCondition: {
77
+ * FieldName: "STRING_VALUE",
78
+ * Value: "STRING_VALUE",
79
+ * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
80
+ * },
81
+ * },
82
+ * };
83
+ * const command = new SearchPromptsCommand(input);
84
+ * const response = await client.send(command);
85
+ * // { // SearchPromptsResponse
86
+ * // Prompts: [ // PromptList
87
+ * // { // Prompt
88
+ * // PromptARN: "STRING_VALUE",
89
+ * // PromptId: "STRING_VALUE",
90
+ * // Name: "STRING_VALUE",
91
+ * // Description: "STRING_VALUE",
92
+ * // Tags: { // TagMap
93
+ * // "<keys>": "STRING_VALUE",
94
+ * // },
95
+ * // },
96
+ * // ],
97
+ * // NextToken: "STRING_VALUE",
98
+ * // ApproximateTotalCount: Number("long"),
99
+ * // };
100
+ *
101
+ * ```
102
+ *
103
+ * @param SearchPromptsCommandInput - {@link SearchPromptsCommandInput}
104
+ * @returns {@link SearchPromptsCommandOutput}
105
+ * @see {@link SearchPromptsCommandInput} for command's `input` shape.
106
+ * @see {@link SearchPromptsCommandOutput} for command's `response` shape.
107
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
108
+ *
109
+ * @throws {@link InternalServiceException} (server fault)
110
+ * <p>Request processing failed because of an error or failure with the service.</p>
111
+ *
112
+ * @throws {@link InvalidParameterException} (client fault)
113
+ * <p>One or more of the specified parameters are not valid.</p>
114
+ *
115
+ * @throws {@link InvalidRequestException} (client fault)
116
+ * <p>The request is not valid.</p>
117
+ *
118
+ * @throws {@link ResourceNotFoundException} (client fault)
119
+ * <p>The specified resource was not found.</p>
120
+ *
121
+ * @throws {@link ThrottlingException} (client fault)
122
+ * <p>The throttling limit has been exceeded.</p>
123
+ *
124
+ * @throws {@link ConnectServiceException}
125
+ * <p>Base exception class for all service exceptions from Connect service.</p>
126
+ *
127
+ */
128
+ export declare class SearchPromptsCommand extends $Command<SearchPromptsCommandInput, SearchPromptsCommandOutput, ConnectClientResolvedConfig> {
129
+ readonly input: SearchPromptsCommandInput;
130
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
131
+ /**
132
+ * @public
133
+ */
134
+ constructor(input: SearchPromptsCommandInput);
135
+ /**
136
+ * @internal
137
+ */
138
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchPromptsCommandInput, SearchPromptsCommandOutput>;
139
+ /**
140
+ * @internal
141
+ */
142
+ private serialize;
143
+ /**
144
+ * @internal
145
+ */
146
+ private deserialize;
147
+ }
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
- import { SearchQueuesRequest, SearchQueuesResponse } from "../models/models_1";
5
+ import { SearchQueuesResponse } from "../models/models_1";
6
+ import { SearchQueuesRequest } from "../models/models_2";
6
7
  /**
7
8
  * @public
8
9
  */
@@ -0,0 +1,161 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
+ import { SearchQuickConnectsResponse } from "../models/models_1";
6
+ import { SearchQuickConnectsRequest } from "../models/models_2";
7
+ /**
8
+ * @public
9
+ */
10
+ export { __MetadataBearer, $Command };
11
+ /**
12
+ * @public
13
+ *
14
+ * The input for {@link SearchQuickConnectsCommand}.
15
+ */
16
+ export interface SearchQuickConnectsCommandInput extends SearchQuickConnectsRequest {
17
+ }
18
+ /**
19
+ * @public
20
+ *
21
+ * The output of {@link SearchQuickConnectsCommand}.
22
+ */
23
+ export interface SearchQuickConnectsCommandOutput extends SearchQuickConnectsResponse, __MetadataBearer {
24
+ }
25
+ /**
26
+ * @public
27
+ * <p>Searches quick connects in an Amazon Connect instance, with optional filtering.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { ConnectClient, SearchQuickConnectsCommand } from "@aws-sdk/client-connect"; // ES Modules import
32
+ * // const { ConnectClient, SearchQuickConnectsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
33
+ * const client = new ConnectClient(config);
34
+ * const input = { // SearchQuickConnectsRequest
35
+ * InstanceId: "STRING_VALUE", // required
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * SearchFilter: { // QuickConnectSearchFilter
39
+ * TagFilter: { // ControlPlaneTagFilter
40
+ * OrConditions: [ // TagOrConditionList
41
+ * [ // TagAndConditionList
42
+ * { // TagCondition
43
+ * TagKey: "STRING_VALUE",
44
+ * TagValue: "STRING_VALUE",
45
+ * },
46
+ * ],
47
+ * ],
48
+ * AndConditions: [
49
+ * {
50
+ * TagKey: "STRING_VALUE",
51
+ * TagValue: "STRING_VALUE",
52
+ * },
53
+ * ],
54
+ * TagCondition: "<TagCondition>",
55
+ * },
56
+ * },
57
+ * SearchCriteria: { // QuickConnectSearchCriteria
58
+ * OrConditions: [ // QuickConnectSearchConditionList
59
+ * {
60
+ * OrConditions: [
61
+ * "<QuickConnectSearchCriteria>",
62
+ * ],
63
+ * AndConditions: [
64
+ * "<QuickConnectSearchCriteria>",
65
+ * ],
66
+ * StringCondition: { // StringCondition
67
+ * FieldName: "STRING_VALUE",
68
+ * Value: "STRING_VALUE",
69
+ * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
70
+ * },
71
+ * },
72
+ * ],
73
+ * AndConditions: [
74
+ * "<QuickConnectSearchCriteria>",
75
+ * ],
76
+ * StringCondition: {
77
+ * FieldName: "STRING_VALUE",
78
+ * Value: "STRING_VALUE",
79
+ * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
80
+ * },
81
+ * },
82
+ * };
83
+ * const command = new SearchQuickConnectsCommand(input);
84
+ * const response = await client.send(command);
85
+ * // { // SearchQuickConnectsResponse
86
+ * // QuickConnects: [ // QuickConnectSearchSummaryList
87
+ * // { // QuickConnect
88
+ * // QuickConnectARN: "STRING_VALUE",
89
+ * // QuickConnectId: "STRING_VALUE",
90
+ * // Name: "STRING_VALUE",
91
+ * // Description: "STRING_VALUE",
92
+ * // QuickConnectConfig: { // QuickConnectConfig
93
+ * // QuickConnectType: "USER" || "QUEUE" || "PHONE_NUMBER", // required
94
+ * // UserConfig: { // UserQuickConnectConfig
95
+ * // UserId: "STRING_VALUE", // required
96
+ * // ContactFlowId: "STRING_VALUE", // required
97
+ * // },
98
+ * // QueueConfig: { // QueueQuickConnectConfig
99
+ * // QueueId: "STRING_VALUE", // required
100
+ * // ContactFlowId: "STRING_VALUE", // required
101
+ * // },
102
+ * // PhoneConfig: { // PhoneNumberQuickConnectConfig
103
+ * // PhoneNumber: "STRING_VALUE", // required
104
+ * // },
105
+ * // },
106
+ * // Tags: { // TagMap
107
+ * // "<keys>": "STRING_VALUE",
108
+ * // },
109
+ * // },
110
+ * // ],
111
+ * // NextToken: "STRING_VALUE",
112
+ * // ApproximateTotalCount: Number("long"),
113
+ * // };
114
+ *
115
+ * ```
116
+ *
117
+ * @param SearchQuickConnectsCommandInput - {@link SearchQuickConnectsCommandInput}
118
+ * @returns {@link SearchQuickConnectsCommandOutput}
119
+ * @see {@link SearchQuickConnectsCommandInput} for command's `input` shape.
120
+ * @see {@link SearchQuickConnectsCommandOutput} for command's `response` shape.
121
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
122
+ *
123
+ * @throws {@link InternalServiceException} (server fault)
124
+ * <p>Request processing failed because of an error or failure with the service.</p>
125
+ *
126
+ * @throws {@link InvalidParameterException} (client fault)
127
+ * <p>One or more of the specified parameters are not valid.</p>
128
+ *
129
+ * @throws {@link InvalidRequestException} (client fault)
130
+ * <p>The request is not valid.</p>
131
+ *
132
+ * @throws {@link ResourceNotFoundException} (client fault)
133
+ * <p>The specified resource was not found.</p>
134
+ *
135
+ * @throws {@link ThrottlingException} (client fault)
136
+ * <p>The throttling limit has been exceeded.</p>
137
+ *
138
+ * @throws {@link ConnectServiceException}
139
+ * <p>Base exception class for all service exceptions from Connect service.</p>
140
+ *
141
+ */
142
+ export declare class SearchQuickConnectsCommand extends $Command<SearchQuickConnectsCommandInput, SearchQuickConnectsCommandOutput, ConnectClientResolvedConfig> {
143
+ readonly input: SearchQuickConnectsCommandInput;
144
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
145
+ /**
146
+ * @public
147
+ */
148
+ constructor(input: SearchQuickConnectsCommandInput);
149
+ /**
150
+ * @internal
151
+ */
152
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchQuickConnectsCommandInput, SearchQuickConnectsCommandOutput>;
153
+ /**
154
+ * @internal
155
+ */
156
+ private serialize;
157
+ /**
158
+ * @internal
159
+ */
160
+ private deserialize;
161
+ }
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
- import { SearchRoutingProfilesRequest, SearchRoutingProfilesResponse } from "../models/models_1";
5
+ import { SearchRoutingProfilesResponse } from "../models/models_1";
6
+ import { SearchRoutingProfilesRequest } from "../models/models_2";
6
7
  /**
7
8
  * @public
8
9
  */
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
- import { SearchSecurityProfilesRequest, SearchSecurityProfilesResponse } from "../models/models_1";
5
+ import { SearchSecurityProfilesResponse } from "../models/models_1";
6
+ import { SearchSecurityProfilesRequest } from "../models/models_2";
6
7
  /**
7
8
  * @public
8
9
  */
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
- import { SearchUsersRequest, SearchUsersResponse } from "../models/models_1";
5
+ import { SearchUsersResponse } from "../models/models_1";
6
+ import { SearchUsersRequest } from "../models/models_2";
6
7
  /**
7
8
  * @public
8
9
  */
@@ -130,7 +130,10 @@ export * from "./ReleasePhoneNumberCommand";
130
130
  export * from "./ReplicateInstanceCommand";
131
131
  export * from "./ResumeContactRecordingCommand";
132
132
  export * from "./SearchAvailablePhoneNumbersCommand";
133
+ export * from "./SearchHoursOfOperationsCommand";
134
+ export * from "./SearchPromptsCommand";
133
135
  export * from "./SearchQueuesCommand";
136
+ export * from "./SearchQuickConnectsCommand";
134
137
  export * from "./SearchRoutingProfilesCommand";
135
138
  export * from "./SearchSecurityProfilesCommand";
136
139
  export * from "./SearchUsersCommand";
@@ -1,2 +1,3 @@
1
1
  export * from "./models_0";
2
2
  export * from "./models_1";
3
+ export * from "./models_2";
@@ -4563,7 +4563,7 @@ export interface Prompt {
4563
4563
  */
4564
4564
  Name?: string;
4565
4565
  /**
4566
- * <p>A description for the prompt.</p>
4566
+ * <p>The description of the prompt.</p>
4567
4567
  */
4568
4568
  Description?: string;
4569
4569
  /**