@aws-sdk/client-connectcampaigns 3.113.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.
- package/CHANGELOG.md +11 -0
- package/LICENSE +201 -0
- package/README.md +205 -0
- package/dist-cjs/ConnectCampaigns.js +337 -0
- package/dist-cjs/ConnectCampaignsClient.js +37 -0
- package/dist-cjs/commands/CreateCampaignCommand.js +36 -0
- package/dist-cjs/commands/DeleteCampaignCommand.js +36 -0
- package/dist-cjs/commands/DeleteConnectInstanceConfigCommand.js +36 -0
- package/dist-cjs/commands/DeleteInstanceOnboardingJobCommand.js +36 -0
- package/dist-cjs/commands/DescribeCampaignCommand.js +36 -0
- package/dist-cjs/commands/GetCampaignStateBatchCommand.js +36 -0
- package/dist-cjs/commands/GetCampaignStateCommand.js +36 -0
- package/dist-cjs/commands/GetConnectInstanceConfigCommand.js +36 -0
- package/dist-cjs/commands/GetInstanceOnboardingJobStatusCommand.js +36 -0
- package/dist-cjs/commands/ListCampaignsCommand.js +36 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
- package/dist-cjs/commands/PauseCampaignCommand.js +36 -0
- package/dist-cjs/commands/PutDialRequestBatchCommand.js +36 -0
- package/dist-cjs/commands/ResumeCampaignCommand.js +36 -0
- package/dist-cjs/commands/StartCampaignCommand.js +36 -0
- package/dist-cjs/commands/StartInstanceOnboardingJobCommand.js +36 -0
- package/dist-cjs/commands/StopCampaignCommand.js +36 -0
- package/dist-cjs/commands/TagResourceCommand.js +36 -0
- package/dist-cjs/commands/UntagResourceCommand.js +36 -0
- package/dist-cjs/commands/UpdateCampaignDialerConfigCommand.js +36 -0
- package/dist-cjs/commands/UpdateCampaignNameCommand.js +36 -0
- package/dist-cjs/commands/UpdateCampaignOutboundCallConfigCommand.js +36 -0
- package/dist-cjs/commands/index.js +25 -0
- package/dist-cjs/endpoints.js +131 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/ConnectCampaignsServiceException.js +11 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +490 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListCampaignsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2174 -0
- package/dist-cjs/runtimeConfig.browser.js +45 -0
- package/dist-cjs/runtimeConfig.js +52 -0
- package/dist-cjs/runtimeConfig.native.js +16 -0
- package/dist-cjs/runtimeConfig.shared.js +17 -0
- package/dist-es/ConnectCampaigns.js +340 -0
- package/dist-es/ConnectCampaignsClient.js +39 -0
- package/dist-es/commands/CreateCampaignCommand.js +39 -0
- package/dist-es/commands/DeleteCampaignCommand.js +39 -0
- package/dist-es/commands/DeleteConnectInstanceConfigCommand.js +39 -0
- package/dist-es/commands/DeleteInstanceOnboardingJobCommand.js +39 -0
- package/dist-es/commands/DescribeCampaignCommand.js +39 -0
- package/dist-es/commands/GetCampaignStateBatchCommand.js +39 -0
- package/dist-es/commands/GetCampaignStateCommand.js +39 -0
- package/dist-es/commands/GetConnectInstanceConfigCommand.js +39 -0
- package/dist-es/commands/GetInstanceOnboardingJobStatusCommand.js +39 -0
- package/dist-es/commands/ListCampaignsCommand.js +39 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
- package/dist-es/commands/PauseCampaignCommand.js +39 -0
- package/dist-es/commands/PutDialRequestBatchCommand.js +39 -0
- package/dist-es/commands/ResumeCampaignCommand.js +39 -0
- package/dist-es/commands/StartCampaignCommand.js +39 -0
- package/dist-es/commands/StartInstanceOnboardingJobCommand.js +39 -0
- package/dist-es/commands/StopCampaignCommand.js +39 -0
- package/dist-es/commands/TagResourceCommand.js +39 -0
- package/dist-es/commands/UntagResourceCommand.js +39 -0
- package/dist-es/commands/UpdateCampaignDialerConfigCommand.js +39 -0
- package/dist-es/commands/UpdateCampaignNameCommand.js +39 -0
- package/dist-es/commands/UpdateCampaignOutboundCallConfigCommand.js +39 -0
- package/dist-es/commands/index.js +22 -0
- package/dist-es/endpoints.js +127 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/ConnectCampaignsServiceException.js +12 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +376 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListCampaignsPaginator.js +75 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +2718 -0
- package/dist-es/runtimeConfig.browser.js +26 -0
- package/dist-es/runtimeConfig.js +30 -0
- package/dist-es/runtimeConfig.native.js +8 -0
- package/dist-es/runtimeConfig.shared.js +13 -0
- package/dist-types/ConnectCampaigns.d.ts +161 -0
- package/dist-types/ConnectCampaignsClient.d.ts +166 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +35 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +35 -0
- package/dist-types/commands/DeleteConnectInstanceConfigCommand.d.ts +35 -0
- package/dist-types/commands/DeleteInstanceOnboardingJobCommand.d.ts +35 -0
- package/dist-types/commands/DescribeCampaignCommand.d.ts +35 -0
- package/dist-types/commands/GetCampaignStateBatchCommand.d.ts +35 -0
- package/dist-types/commands/GetCampaignStateCommand.d.ts +35 -0
- package/dist-types/commands/GetConnectInstanceConfigCommand.d.ts +35 -0
- package/dist-types/commands/GetInstanceOnboardingJobStatusCommand.d.ts +35 -0
- package/dist-types/commands/ListCampaignsCommand.d.ts +35 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
- package/dist-types/commands/PauseCampaignCommand.d.ts +35 -0
- package/dist-types/commands/PutDialRequestBatchCommand.d.ts +35 -0
- package/dist-types/commands/ResumeCampaignCommand.d.ts +35 -0
- package/dist-types/commands/StartCampaignCommand.d.ts +35 -0
- package/dist-types/commands/StartInstanceOnboardingJobCommand.d.ts +35 -0
- package/dist-types/commands/StopCampaignCommand.d.ts +35 -0
- package/dist-types/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCampaignDialerConfigCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCampaignNameCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +22 -0
- package/dist-types/endpoints.d.ts +2 -0
- package/dist-types/index.d.ts +6 -0
- package/dist-types/models/ConnectCampaignsServiceException.d.ts +10 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1165 -0
- package/dist-types/pagination/Interfaces.d.ts +6 -0
- package/dist-types/pagination/ListCampaignsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +68 -0
- package/dist-types/runtimeConfig.browser.d.ts +40 -0
- package/dist-types/runtimeConfig.d.ts +40 -0
- package/dist-types/runtimeConfig.native.d.ts +39 -0
- package/dist-types/runtimeConfig.shared.d.ts +13 -0
- package/dist-types/ts3.4/ConnectCampaigns.d.ts +115 -0
- package/dist-types/ts3.4/ConnectCampaignsClient.d.ts +95 -0
- package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteConnectInstanceConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteInstanceOnboardingJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetCampaignStateBatchCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetCampaignStateCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetConnectInstanceConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetInstanceOnboardingJobStatusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/PauseCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/PutDialRequestBatchCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ResumeCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StartCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StartInstanceOnboardingJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StopCampaignCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateCampaignDialerConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateCampaignNameCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +22 -0
- package/dist-types/ts3.4/endpoints.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/ConnectCampaignsServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +691 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListCampaignsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +68 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
- package/package.json +94 -0
|
@@ -0,0 +1,1165 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { ConnectCampaignsServiceException as __BaseException } from "./ConnectCampaignsServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* You do not have sufficient access to perform this action.
|
|
5
|
+
*/
|
|
6
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
7
|
+
readonly name: "AccessDeniedException";
|
|
8
|
+
readonly $fault: "client";
|
|
9
|
+
/**
|
|
10
|
+
* A header that defines the error encountered while processing the request.
|
|
11
|
+
*/
|
|
12
|
+
xAmzErrorType?: string;
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* The request could not be processed because of conflict in the current state of the resource.
|
|
20
|
+
*/
|
|
21
|
+
export declare class ConflictException extends __BaseException {
|
|
22
|
+
readonly name: "ConflictException";
|
|
23
|
+
readonly $fault: "client";
|
|
24
|
+
/**
|
|
25
|
+
* A header that defines the error encountered while processing the request.
|
|
26
|
+
*/
|
|
27
|
+
xAmzErrorType?: string;
|
|
28
|
+
/**
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
31
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Predictive Dialer config
|
|
35
|
+
*/
|
|
36
|
+
export interface PredictiveDialerConfig {
|
|
37
|
+
/**
|
|
38
|
+
* The bandwidth allocation of a queue resource.
|
|
39
|
+
*/
|
|
40
|
+
bandwidthAllocation: number | undefined;
|
|
41
|
+
}
|
|
42
|
+
export declare namespace PredictiveDialerConfig {
|
|
43
|
+
/**
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
const filterSensitiveLog: (obj: PredictiveDialerConfig) => any;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Progressive Dialer config
|
|
50
|
+
*/
|
|
51
|
+
export interface ProgressiveDialerConfig {
|
|
52
|
+
/**
|
|
53
|
+
* The bandwidth allocation of a queue resource.
|
|
54
|
+
*/
|
|
55
|
+
bandwidthAllocation: number | undefined;
|
|
56
|
+
}
|
|
57
|
+
export declare namespace ProgressiveDialerConfig {
|
|
58
|
+
/**
|
|
59
|
+
* @internal
|
|
60
|
+
*/
|
|
61
|
+
const filterSensitiveLog: (obj: ProgressiveDialerConfig) => any;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* The possible types of dialer config parameters
|
|
65
|
+
*/
|
|
66
|
+
export declare type DialerConfig = DialerConfig.PredictiveDialerConfigMember | DialerConfig.ProgressiveDialerConfigMember | DialerConfig.$UnknownMember;
|
|
67
|
+
export declare namespace DialerConfig {
|
|
68
|
+
/**
|
|
69
|
+
* Progressive Dialer config
|
|
70
|
+
*/
|
|
71
|
+
interface ProgressiveDialerConfigMember {
|
|
72
|
+
progressiveDialerConfig: ProgressiveDialerConfig;
|
|
73
|
+
predictiveDialerConfig?: never;
|
|
74
|
+
$unknown?: never;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Predictive Dialer config
|
|
78
|
+
*/
|
|
79
|
+
interface PredictiveDialerConfigMember {
|
|
80
|
+
progressiveDialerConfig?: never;
|
|
81
|
+
predictiveDialerConfig: PredictiveDialerConfig;
|
|
82
|
+
$unknown?: never;
|
|
83
|
+
}
|
|
84
|
+
interface $UnknownMember {
|
|
85
|
+
progressiveDialerConfig?: never;
|
|
86
|
+
predictiveDialerConfig?: never;
|
|
87
|
+
$unknown: [string, any];
|
|
88
|
+
}
|
|
89
|
+
interface Visitor<T> {
|
|
90
|
+
progressiveDialerConfig: (value: ProgressiveDialerConfig) => T;
|
|
91
|
+
predictiveDialerConfig: (value: PredictiveDialerConfig) => T;
|
|
92
|
+
_: (name: string, value: any) => T;
|
|
93
|
+
}
|
|
94
|
+
const visit: <T>(value: DialerConfig, visitor: Visitor<T>) => T;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
const filterSensitiveLog: (obj: DialerConfig) => any;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Answering Machine Detection config
|
|
102
|
+
*/
|
|
103
|
+
export interface AnswerMachineDetectionConfig {
|
|
104
|
+
/**
|
|
105
|
+
* Enable or disable answering machine detection
|
|
106
|
+
*/
|
|
107
|
+
enableAnswerMachineDetection: boolean | undefined;
|
|
108
|
+
}
|
|
109
|
+
export declare namespace AnswerMachineDetectionConfig {
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
const filterSensitiveLog: (obj: AnswerMachineDetectionConfig) => any;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* The configuration used for outbound calls.
|
|
117
|
+
*/
|
|
118
|
+
export interface OutboundCallConfig {
|
|
119
|
+
/**
|
|
120
|
+
* The identifier of the contact flow for the outbound call.
|
|
121
|
+
*/
|
|
122
|
+
connectContactFlowId: string | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
125
|
+
*/
|
|
126
|
+
connectSourcePhoneNumber?: string;
|
|
127
|
+
/**
|
|
128
|
+
* The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
|
|
129
|
+
*/
|
|
130
|
+
connectQueueId: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* Answering Machine Detection config
|
|
133
|
+
*/
|
|
134
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
135
|
+
}
|
|
136
|
+
export declare namespace OutboundCallConfig {
|
|
137
|
+
/**
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
140
|
+
const filterSensitiveLog: (obj: OutboundCallConfig) => any;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* The request for Create Campaign API.
|
|
144
|
+
*/
|
|
145
|
+
export interface CreateCampaignRequest {
|
|
146
|
+
/**
|
|
147
|
+
* The name of an Amazon Connect Campaign name.
|
|
148
|
+
*/
|
|
149
|
+
name: string | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* Amazon Connect Instance Id
|
|
152
|
+
*/
|
|
153
|
+
connectInstanceId: string | undefined;
|
|
154
|
+
/**
|
|
155
|
+
* The possible types of dialer config parameters
|
|
156
|
+
*/
|
|
157
|
+
dialerConfig: DialerConfig | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* The configuration used for outbound calls.
|
|
160
|
+
*/
|
|
161
|
+
outboundCallConfig: OutboundCallConfig | undefined;
|
|
162
|
+
/**
|
|
163
|
+
* Tag map with key and value.
|
|
164
|
+
*/
|
|
165
|
+
tags?: Record<string, string>;
|
|
166
|
+
}
|
|
167
|
+
export declare namespace CreateCampaignRequest {
|
|
168
|
+
/**
|
|
169
|
+
* @internal
|
|
170
|
+
*/
|
|
171
|
+
const filterSensitiveLog: (obj: CreateCampaignRequest) => any;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* The response for Create Campaign API
|
|
175
|
+
*/
|
|
176
|
+
export interface CreateCampaignResponse {
|
|
177
|
+
/**
|
|
178
|
+
* Identifier representing a Campaign
|
|
179
|
+
*/
|
|
180
|
+
id?: string;
|
|
181
|
+
/**
|
|
182
|
+
* The resource name of an Amazon Connect campaign.
|
|
183
|
+
*/
|
|
184
|
+
arn?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Tag map with key and value.
|
|
187
|
+
*/
|
|
188
|
+
tags?: Record<string, string>;
|
|
189
|
+
}
|
|
190
|
+
export declare namespace CreateCampaignResponse {
|
|
191
|
+
/**
|
|
192
|
+
* @internal
|
|
193
|
+
*/
|
|
194
|
+
const filterSensitiveLog: (obj: CreateCampaignResponse) => any;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Request processing failed because of an error or failure with the service.
|
|
198
|
+
*/
|
|
199
|
+
export declare class InternalServerException extends __BaseException {
|
|
200
|
+
readonly name: "InternalServerException";
|
|
201
|
+
readonly $fault: "server";
|
|
202
|
+
$retryable: {};
|
|
203
|
+
/**
|
|
204
|
+
* A header that defines the error encountered while processing the request.
|
|
205
|
+
*/
|
|
206
|
+
xAmzErrorType?: string;
|
|
207
|
+
/**
|
|
208
|
+
* @internal
|
|
209
|
+
*/
|
|
210
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* The specified resource was not found.
|
|
214
|
+
*/
|
|
215
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
216
|
+
readonly name: "ResourceNotFoundException";
|
|
217
|
+
readonly $fault: "client";
|
|
218
|
+
/**
|
|
219
|
+
* A header that defines the error encountered while processing the request.
|
|
220
|
+
*/
|
|
221
|
+
xAmzErrorType?: string;
|
|
222
|
+
/**
|
|
223
|
+
* @internal
|
|
224
|
+
*/
|
|
225
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Request would cause a service quota to be exceeded.
|
|
229
|
+
*/
|
|
230
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
231
|
+
readonly name: "ServiceQuotaExceededException";
|
|
232
|
+
readonly $fault: "client";
|
|
233
|
+
/**
|
|
234
|
+
* A header that defines the error encountered while processing the request.
|
|
235
|
+
*/
|
|
236
|
+
xAmzErrorType?: string;
|
|
237
|
+
/**
|
|
238
|
+
* @internal
|
|
239
|
+
*/
|
|
240
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* The request was denied due to request throttling.
|
|
244
|
+
*/
|
|
245
|
+
export declare class ThrottlingException extends __BaseException {
|
|
246
|
+
readonly name: "ThrottlingException";
|
|
247
|
+
readonly $fault: "client";
|
|
248
|
+
$retryable: {};
|
|
249
|
+
/**
|
|
250
|
+
* A header that defines the error encountered while processing the request.
|
|
251
|
+
*/
|
|
252
|
+
xAmzErrorType?: string;
|
|
253
|
+
/**
|
|
254
|
+
* @internal
|
|
255
|
+
*/
|
|
256
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
260
|
+
*/
|
|
261
|
+
export declare class ValidationException extends __BaseException {
|
|
262
|
+
readonly name: "ValidationException";
|
|
263
|
+
readonly $fault: "client";
|
|
264
|
+
/**
|
|
265
|
+
* A header that defines the error encountered while processing the request.
|
|
266
|
+
*/
|
|
267
|
+
xAmzErrorType?: string;
|
|
268
|
+
/**
|
|
269
|
+
* @internal
|
|
270
|
+
*/
|
|
271
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* DeleteCampaignRequest
|
|
275
|
+
*/
|
|
276
|
+
export interface DeleteCampaignRequest {
|
|
277
|
+
/**
|
|
278
|
+
* Identifier representing a Campaign
|
|
279
|
+
*/
|
|
280
|
+
id: string | undefined;
|
|
281
|
+
}
|
|
282
|
+
export declare namespace DeleteCampaignRequest {
|
|
283
|
+
/**
|
|
284
|
+
* @internal
|
|
285
|
+
*/
|
|
286
|
+
const filterSensitiveLog: (obj: DeleteCampaignRequest) => any;
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* DeleteCampaignRequest
|
|
290
|
+
*/
|
|
291
|
+
export interface DeleteConnectInstanceConfigRequest {
|
|
292
|
+
/**
|
|
293
|
+
* Amazon Connect Instance Id
|
|
294
|
+
*/
|
|
295
|
+
connectInstanceId: string | undefined;
|
|
296
|
+
}
|
|
297
|
+
export declare namespace DeleteConnectInstanceConfigRequest {
|
|
298
|
+
/**
|
|
299
|
+
* @internal
|
|
300
|
+
*/
|
|
301
|
+
const filterSensitiveLog: (obj: DeleteConnectInstanceConfigRequest) => any;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* The request could not be processed because of conflict in the current state.
|
|
305
|
+
*/
|
|
306
|
+
export declare class InvalidStateException extends __BaseException {
|
|
307
|
+
readonly name: "InvalidStateException";
|
|
308
|
+
readonly $fault: "client";
|
|
309
|
+
/**
|
|
310
|
+
* A header that defines the error encountered while processing the request.
|
|
311
|
+
*/
|
|
312
|
+
xAmzErrorType?: string;
|
|
313
|
+
/**
|
|
314
|
+
* @internal
|
|
315
|
+
*/
|
|
316
|
+
constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* The request for DeleteInstanceOnboardingJob API.
|
|
320
|
+
*/
|
|
321
|
+
export interface DeleteInstanceOnboardingJobRequest {
|
|
322
|
+
/**
|
|
323
|
+
* Amazon Connect Instance Id
|
|
324
|
+
*/
|
|
325
|
+
connectInstanceId: string | undefined;
|
|
326
|
+
}
|
|
327
|
+
export declare namespace DeleteInstanceOnboardingJobRequest {
|
|
328
|
+
/**
|
|
329
|
+
* @internal
|
|
330
|
+
*/
|
|
331
|
+
const filterSensitiveLog: (obj: DeleteInstanceOnboardingJobRequest) => any;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* DescribeCampaignRequests
|
|
335
|
+
*/
|
|
336
|
+
export interface DescribeCampaignRequest {
|
|
337
|
+
/**
|
|
338
|
+
* Identifier representing a Campaign
|
|
339
|
+
*/
|
|
340
|
+
id: string | undefined;
|
|
341
|
+
}
|
|
342
|
+
export declare namespace DescribeCampaignRequest {
|
|
343
|
+
/**
|
|
344
|
+
* @internal
|
|
345
|
+
*/
|
|
346
|
+
const filterSensitiveLog: (obj: DescribeCampaignRequest) => any;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* An Amazon Connect campaign.
|
|
350
|
+
*/
|
|
351
|
+
export interface Campaign {
|
|
352
|
+
/**
|
|
353
|
+
* Identifier representing a Campaign
|
|
354
|
+
*/
|
|
355
|
+
id: string | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* The resource name of an Amazon Connect campaign.
|
|
358
|
+
*/
|
|
359
|
+
arn: string | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* The name of an Amazon Connect Campaign name.
|
|
362
|
+
*/
|
|
363
|
+
name: string | undefined;
|
|
364
|
+
/**
|
|
365
|
+
* Amazon Connect Instance Id
|
|
366
|
+
*/
|
|
367
|
+
connectInstanceId: string | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* The possible types of dialer config parameters
|
|
370
|
+
*/
|
|
371
|
+
dialerConfig: DialerConfig | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* The configuration used for outbound calls.
|
|
374
|
+
*/
|
|
375
|
+
outboundCallConfig: OutboundCallConfig | undefined;
|
|
376
|
+
/**
|
|
377
|
+
* Tag map with key and value.
|
|
378
|
+
*/
|
|
379
|
+
tags?: Record<string, string>;
|
|
380
|
+
}
|
|
381
|
+
export declare namespace Campaign {
|
|
382
|
+
/**
|
|
383
|
+
* @internal
|
|
384
|
+
*/
|
|
385
|
+
const filterSensitiveLog: (obj: Campaign) => any;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* DescribeCampaignResponse
|
|
389
|
+
*/
|
|
390
|
+
export interface DescribeCampaignResponse {
|
|
391
|
+
/**
|
|
392
|
+
* An Amazon Connect campaign.
|
|
393
|
+
*/
|
|
394
|
+
campaign?: Campaign;
|
|
395
|
+
}
|
|
396
|
+
export declare namespace DescribeCampaignResponse {
|
|
397
|
+
/**
|
|
398
|
+
* @internal
|
|
399
|
+
*/
|
|
400
|
+
const filterSensitiveLog: (obj: DescribeCampaignResponse) => any;
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* GetCampaignStateRequest
|
|
404
|
+
*/
|
|
405
|
+
export interface GetCampaignStateRequest {
|
|
406
|
+
/**
|
|
407
|
+
* Identifier representing a Campaign
|
|
408
|
+
*/
|
|
409
|
+
id: string | undefined;
|
|
410
|
+
}
|
|
411
|
+
export declare namespace GetCampaignStateRequest {
|
|
412
|
+
/**
|
|
413
|
+
* @internal
|
|
414
|
+
*/
|
|
415
|
+
const filterSensitiveLog: (obj: GetCampaignStateRequest) => any;
|
|
416
|
+
}
|
|
417
|
+
export declare enum CampaignState {
|
|
418
|
+
/**
|
|
419
|
+
* Campaign is in failed state
|
|
420
|
+
*/
|
|
421
|
+
FAILED = "Failed",
|
|
422
|
+
/**
|
|
423
|
+
* Campaign is in initialized state
|
|
424
|
+
*/
|
|
425
|
+
INITIALIZED = "Initialized",
|
|
426
|
+
/**
|
|
427
|
+
* Campaign is in paused state
|
|
428
|
+
*/
|
|
429
|
+
PAUSED = "Paused",
|
|
430
|
+
/**
|
|
431
|
+
* Campaign is in running state
|
|
432
|
+
*/
|
|
433
|
+
RUNNING = "Running",
|
|
434
|
+
/**
|
|
435
|
+
* Campaign is in stopped state
|
|
436
|
+
*/
|
|
437
|
+
STOPPED = "Stopped"
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* GetCampaignStateResponse
|
|
441
|
+
*/
|
|
442
|
+
export interface GetCampaignStateResponse {
|
|
443
|
+
/**
|
|
444
|
+
* State of a campaign
|
|
445
|
+
*/
|
|
446
|
+
state?: CampaignState | string;
|
|
447
|
+
}
|
|
448
|
+
export declare namespace GetCampaignStateResponse {
|
|
449
|
+
/**
|
|
450
|
+
* @internal
|
|
451
|
+
*/
|
|
452
|
+
const filterSensitiveLog: (obj: GetCampaignStateResponse) => any;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* GetCampaignStateBatchRequest
|
|
456
|
+
*/
|
|
457
|
+
export interface GetCampaignStateBatchRequest {
|
|
458
|
+
/**
|
|
459
|
+
* List of CampaignId
|
|
460
|
+
*/
|
|
461
|
+
campaignIds: string[] | undefined;
|
|
462
|
+
}
|
|
463
|
+
export declare namespace GetCampaignStateBatchRequest {
|
|
464
|
+
/**
|
|
465
|
+
* @internal
|
|
466
|
+
*/
|
|
467
|
+
const filterSensitiveLog: (obj: GetCampaignStateBatchRequest) => any;
|
|
468
|
+
}
|
|
469
|
+
export declare enum GetCampaignStateBatchFailureCode {
|
|
470
|
+
/**
|
|
471
|
+
* The specified resource was not found
|
|
472
|
+
*/
|
|
473
|
+
RESOURCE_NOT_FOUND = "ResourceNotFound",
|
|
474
|
+
/**
|
|
475
|
+
* Unexpected error during processing of request
|
|
476
|
+
*/
|
|
477
|
+
UNKNOWN_ERROR = "UnknownError"
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* Failed response of campaign state
|
|
481
|
+
*/
|
|
482
|
+
export interface FailedCampaignStateResponse {
|
|
483
|
+
/**
|
|
484
|
+
* Identifier representing a Campaign
|
|
485
|
+
*/
|
|
486
|
+
campaignId?: string;
|
|
487
|
+
/**
|
|
488
|
+
* A predefined code indicating the error that caused the failure in getting state of campaigns
|
|
489
|
+
*/
|
|
490
|
+
failureCode?: GetCampaignStateBatchFailureCode | string;
|
|
491
|
+
}
|
|
492
|
+
export declare namespace FailedCampaignStateResponse {
|
|
493
|
+
/**
|
|
494
|
+
* @internal
|
|
495
|
+
*/
|
|
496
|
+
const filterSensitiveLog: (obj: FailedCampaignStateResponse) => any;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Successful response of campaign state
|
|
500
|
+
*/
|
|
501
|
+
export interface SuccessfulCampaignStateResponse {
|
|
502
|
+
/**
|
|
503
|
+
* Identifier representing a Campaign
|
|
504
|
+
*/
|
|
505
|
+
campaignId?: string;
|
|
506
|
+
/**
|
|
507
|
+
* State of a campaign
|
|
508
|
+
*/
|
|
509
|
+
state?: CampaignState | string;
|
|
510
|
+
}
|
|
511
|
+
export declare namespace SuccessfulCampaignStateResponse {
|
|
512
|
+
/**
|
|
513
|
+
* @internal
|
|
514
|
+
*/
|
|
515
|
+
const filterSensitiveLog: (obj: SuccessfulCampaignStateResponse) => any;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* GetCampaignStateBatchResponse
|
|
519
|
+
*/
|
|
520
|
+
export interface GetCampaignStateBatchResponse {
|
|
521
|
+
/**
|
|
522
|
+
* List of successful response of campaign state
|
|
523
|
+
*/
|
|
524
|
+
successfulRequests?: SuccessfulCampaignStateResponse[];
|
|
525
|
+
/**
|
|
526
|
+
* List of failed requests of campaign state
|
|
527
|
+
*/
|
|
528
|
+
failedRequests?: FailedCampaignStateResponse[];
|
|
529
|
+
}
|
|
530
|
+
export declare namespace GetCampaignStateBatchResponse {
|
|
531
|
+
/**
|
|
532
|
+
* @internal
|
|
533
|
+
*/
|
|
534
|
+
const filterSensitiveLog: (obj: GetCampaignStateBatchResponse) => any;
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* GetConnectInstanceConfigRequest
|
|
538
|
+
*/
|
|
539
|
+
export interface GetConnectInstanceConfigRequest {
|
|
540
|
+
/**
|
|
541
|
+
* Amazon Connect Instance Id
|
|
542
|
+
*/
|
|
543
|
+
connectInstanceId: string | undefined;
|
|
544
|
+
}
|
|
545
|
+
export declare namespace GetConnectInstanceConfigRequest {
|
|
546
|
+
/**
|
|
547
|
+
* @internal
|
|
548
|
+
*/
|
|
549
|
+
const filterSensitiveLog: (obj: GetConnectInstanceConfigRequest) => any;
|
|
550
|
+
}
|
|
551
|
+
export declare enum EncryptionType {
|
|
552
|
+
KMS = "KMS"
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
556
|
+
* If disabled, service will perform encryption with its own key.
|
|
557
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
558
|
+
* KMS is only type supported
|
|
559
|
+
*/
|
|
560
|
+
export interface EncryptionConfig {
|
|
561
|
+
/**
|
|
562
|
+
* Boolean to indicate if custom encryption has been enabled.
|
|
563
|
+
*/
|
|
564
|
+
enabled: boolean | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* Server-side encryption type.
|
|
567
|
+
*/
|
|
568
|
+
encryptionType?: EncryptionType | string;
|
|
569
|
+
/**
|
|
570
|
+
* KMS key id/arn for encryption config.
|
|
571
|
+
*/
|
|
572
|
+
keyArn?: string;
|
|
573
|
+
}
|
|
574
|
+
export declare namespace EncryptionConfig {
|
|
575
|
+
/**
|
|
576
|
+
* @internal
|
|
577
|
+
*/
|
|
578
|
+
const filterSensitiveLog: (obj: EncryptionConfig) => any;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* Instance config object
|
|
582
|
+
*/
|
|
583
|
+
export interface InstanceConfig {
|
|
584
|
+
/**
|
|
585
|
+
* Amazon Connect Instance Id
|
|
586
|
+
*/
|
|
587
|
+
connectInstanceId: string | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* Service linked role arn
|
|
590
|
+
*/
|
|
591
|
+
serviceLinkedRoleArn: string | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
594
|
+
* If disabled, service will perform encryption with its own key.
|
|
595
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
596
|
+
* KMS is only type supported
|
|
597
|
+
*/
|
|
598
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
599
|
+
}
|
|
600
|
+
export declare namespace InstanceConfig {
|
|
601
|
+
/**
|
|
602
|
+
* @internal
|
|
603
|
+
*/
|
|
604
|
+
const filterSensitiveLog: (obj: InstanceConfig) => any;
|
|
605
|
+
}
|
|
606
|
+
/**
|
|
607
|
+
* GetConnectInstanceConfigResponse
|
|
608
|
+
*/
|
|
609
|
+
export interface GetConnectInstanceConfigResponse {
|
|
610
|
+
/**
|
|
611
|
+
* Instance config object
|
|
612
|
+
*/
|
|
613
|
+
connectInstanceConfig?: InstanceConfig;
|
|
614
|
+
}
|
|
615
|
+
export declare namespace GetConnectInstanceConfigResponse {
|
|
616
|
+
/**
|
|
617
|
+
* @internal
|
|
618
|
+
*/
|
|
619
|
+
const filterSensitiveLog: (obj: GetConnectInstanceConfigResponse) => any;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* GetInstanceOnboardingJobStatusRequest
|
|
623
|
+
*/
|
|
624
|
+
export interface GetInstanceOnboardingJobStatusRequest {
|
|
625
|
+
/**
|
|
626
|
+
* Amazon Connect Instance Id
|
|
627
|
+
*/
|
|
628
|
+
connectInstanceId: string | undefined;
|
|
629
|
+
}
|
|
630
|
+
export declare namespace GetInstanceOnboardingJobStatusRequest {
|
|
631
|
+
/**
|
|
632
|
+
* @internal
|
|
633
|
+
*/
|
|
634
|
+
const filterSensitiveLog: (obj: GetInstanceOnboardingJobStatusRequest) => any;
|
|
635
|
+
}
|
|
636
|
+
export declare enum InstanceOnboardingJobFailureCode {
|
|
637
|
+
EVENT_BRIDGE_ACCESS_DENIED = "EVENT_BRIDGE_ACCESS_DENIED",
|
|
638
|
+
EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED = "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
|
|
639
|
+
IAM_ACCESS_DENIED = "IAM_ACCESS_DENIED",
|
|
640
|
+
INTERNAL_FAILURE = "INTERNAL_FAILURE",
|
|
641
|
+
KMS_ACCESS_DENIED = "KMS_ACCESS_DENIED",
|
|
642
|
+
KMS_KEY_NOT_FOUND = "KMS_KEY_NOT_FOUND"
|
|
643
|
+
}
|
|
644
|
+
export declare enum InstanceOnboardingJobStatusCode {
|
|
645
|
+
FAILED = "FAILED",
|
|
646
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
647
|
+
SUCCEEDED = "SUCCEEDED"
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* Instance onboarding job status object
|
|
651
|
+
*/
|
|
652
|
+
export interface InstanceOnboardingJobStatus {
|
|
653
|
+
/**
|
|
654
|
+
* Amazon Connect Instance Id
|
|
655
|
+
*/
|
|
656
|
+
connectInstanceId: string | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* Enumeration of the possible states for instance onboarding job
|
|
659
|
+
*/
|
|
660
|
+
status: InstanceOnboardingJobStatusCode | string | undefined;
|
|
661
|
+
/**
|
|
662
|
+
* Enumeration of the possible failure codes for instance onboarding job
|
|
663
|
+
*/
|
|
664
|
+
failureCode?: InstanceOnboardingJobFailureCode | string;
|
|
665
|
+
}
|
|
666
|
+
export declare namespace InstanceOnboardingJobStatus {
|
|
667
|
+
/**
|
|
668
|
+
* @internal
|
|
669
|
+
*/
|
|
670
|
+
const filterSensitiveLog: (obj: InstanceOnboardingJobStatus) => any;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* GetInstanceOnboardingJobStatusResponse
|
|
674
|
+
*/
|
|
675
|
+
export interface GetInstanceOnboardingJobStatusResponse {
|
|
676
|
+
/**
|
|
677
|
+
* Instance onboarding job status object
|
|
678
|
+
*/
|
|
679
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
|
|
680
|
+
}
|
|
681
|
+
export declare namespace GetInstanceOnboardingJobStatusResponse {
|
|
682
|
+
/**
|
|
683
|
+
* @internal
|
|
684
|
+
*/
|
|
685
|
+
const filterSensitiveLog: (obj: GetInstanceOnboardingJobStatusResponse) => any;
|
|
686
|
+
}
|
|
687
|
+
export declare enum InstanceIdFilterOperator {
|
|
688
|
+
/**
|
|
689
|
+
* Equals operator
|
|
690
|
+
*/
|
|
691
|
+
EQ = "Eq"
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* Connect instance identifier filter
|
|
695
|
+
*/
|
|
696
|
+
export interface InstanceIdFilter {
|
|
697
|
+
/**
|
|
698
|
+
* Amazon Connect Instance Id
|
|
699
|
+
*/
|
|
700
|
+
value: string | undefined;
|
|
701
|
+
/**
|
|
702
|
+
* Operators for Connect instance identifier filter
|
|
703
|
+
*/
|
|
704
|
+
operator: InstanceIdFilterOperator | string | undefined;
|
|
705
|
+
}
|
|
706
|
+
export declare namespace InstanceIdFilter {
|
|
707
|
+
/**
|
|
708
|
+
* @internal
|
|
709
|
+
*/
|
|
710
|
+
const filterSensitiveLog: (obj: InstanceIdFilter) => any;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Filter model by type
|
|
714
|
+
*/
|
|
715
|
+
export interface CampaignFilters {
|
|
716
|
+
/**
|
|
717
|
+
* Connect instance identifier filter
|
|
718
|
+
*/
|
|
719
|
+
instanceIdFilter?: InstanceIdFilter;
|
|
720
|
+
}
|
|
721
|
+
export declare namespace CampaignFilters {
|
|
722
|
+
/**
|
|
723
|
+
* @internal
|
|
724
|
+
*/
|
|
725
|
+
const filterSensitiveLog: (obj: CampaignFilters) => any;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* ListCampaignsRequest
|
|
729
|
+
*/
|
|
730
|
+
export interface ListCampaignsRequest {
|
|
731
|
+
/**
|
|
732
|
+
* The maximum number of results to return per page.
|
|
733
|
+
*/
|
|
734
|
+
maxResults?: number;
|
|
735
|
+
/**
|
|
736
|
+
* The token for the next set of results.
|
|
737
|
+
*/
|
|
738
|
+
nextToken?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Filter model by type
|
|
741
|
+
*/
|
|
742
|
+
filters?: CampaignFilters;
|
|
743
|
+
}
|
|
744
|
+
export declare namespace ListCampaignsRequest {
|
|
745
|
+
/**
|
|
746
|
+
* @internal
|
|
747
|
+
*/
|
|
748
|
+
const filterSensitiveLog: (obj: ListCampaignsRequest) => any;
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* An Amazon Connect campaign summary.
|
|
752
|
+
*/
|
|
753
|
+
export interface CampaignSummary {
|
|
754
|
+
/**
|
|
755
|
+
* Identifier representing a Campaign
|
|
756
|
+
*/
|
|
757
|
+
id: string | undefined;
|
|
758
|
+
/**
|
|
759
|
+
* The resource name of an Amazon Connect campaign.
|
|
760
|
+
*/
|
|
761
|
+
arn: string | undefined;
|
|
762
|
+
/**
|
|
763
|
+
* The name of an Amazon Connect Campaign name.
|
|
764
|
+
*/
|
|
765
|
+
name: string | undefined;
|
|
766
|
+
/**
|
|
767
|
+
* Amazon Connect Instance Id
|
|
768
|
+
*/
|
|
769
|
+
connectInstanceId: string | undefined;
|
|
770
|
+
}
|
|
771
|
+
export declare namespace CampaignSummary {
|
|
772
|
+
/**
|
|
773
|
+
* @internal
|
|
774
|
+
*/
|
|
775
|
+
const filterSensitiveLog: (obj: CampaignSummary) => any;
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* ListCampaignsResponse
|
|
779
|
+
*/
|
|
780
|
+
export interface ListCampaignsResponse {
|
|
781
|
+
/**
|
|
782
|
+
* The token for the next set of results.
|
|
783
|
+
*/
|
|
784
|
+
nextToken?: string;
|
|
785
|
+
/**
|
|
786
|
+
* A list of Amazon Connect campaigns.
|
|
787
|
+
*/
|
|
788
|
+
campaignSummaryList?: CampaignSummary[];
|
|
789
|
+
}
|
|
790
|
+
export declare namespace ListCampaignsResponse {
|
|
791
|
+
/**
|
|
792
|
+
* @internal
|
|
793
|
+
*/
|
|
794
|
+
const filterSensitiveLog: (obj: ListCampaignsResponse) => any;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* ListTagsForResource
|
|
798
|
+
*/
|
|
799
|
+
export interface ListTagsForResourceRequest {
|
|
800
|
+
/**
|
|
801
|
+
* Arn
|
|
802
|
+
*/
|
|
803
|
+
arn: string | undefined;
|
|
804
|
+
}
|
|
805
|
+
export declare namespace ListTagsForResourceRequest {
|
|
806
|
+
/**
|
|
807
|
+
* @internal
|
|
808
|
+
*/
|
|
809
|
+
const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
810
|
+
}
|
|
811
|
+
/**
|
|
812
|
+
* ListTagsForResponse
|
|
813
|
+
*/
|
|
814
|
+
export interface ListTagsForResourceResponse {
|
|
815
|
+
/**
|
|
816
|
+
* Tag map with key and value.
|
|
817
|
+
*/
|
|
818
|
+
tags?: Record<string, string>;
|
|
819
|
+
}
|
|
820
|
+
export declare namespace ListTagsForResourceResponse {
|
|
821
|
+
/**
|
|
822
|
+
* @internal
|
|
823
|
+
*/
|
|
824
|
+
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* The request could not be processed because of conflict in the current state of the campaign.
|
|
828
|
+
*/
|
|
829
|
+
export declare class InvalidCampaignStateException extends __BaseException {
|
|
830
|
+
readonly name: "InvalidCampaignStateException";
|
|
831
|
+
readonly $fault: "client";
|
|
832
|
+
/**
|
|
833
|
+
* State of a campaign
|
|
834
|
+
*/
|
|
835
|
+
state: CampaignState | string | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* A header that defines the error encountered while processing the request.
|
|
838
|
+
*/
|
|
839
|
+
xAmzErrorType?: string;
|
|
840
|
+
/**
|
|
841
|
+
* @internal
|
|
842
|
+
*/
|
|
843
|
+
constructor(opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>);
|
|
844
|
+
}
|
|
845
|
+
/**
|
|
846
|
+
* PauseCampaignRequest
|
|
847
|
+
*/
|
|
848
|
+
export interface PauseCampaignRequest {
|
|
849
|
+
/**
|
|
850
|
+
* Identifier representing a Campaign
|
|
851
|
+
*/
|
|
852
|
+
id: string | undefined;
|
|
853
|
+
}
|
|
854
|
+
export declare namespace PauseCampaignRequest {
|
|
855
|
+
/**
|
|
856
|
+
* @internal
|
|
857
|
+
*/
|
|
858
|
+
const filterSensitiveLog: (obj: PauseCampaignRequest) => any;
|
|
859
|
+
}
|
|
860
|
+
/**
|
|
861
|
+
* A dial request for a campaign.
|
|
862
|
+
*/
|
|
863
|
+
export interface DialRequest {
|
|
864
|
+
/**
|
|
865
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
866
|
+
*/
|
|
867
|
+
clientToken: string | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* The phone number of the customer, in E.164 format.
|
|
870
|
+
*/
|
|
871
|
+
phoneNumber: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* Timestamp with no UTC offset or timezone
|
|
874
|
+
*/
|
|
875
|
+
expirationTime: Date | undefined;
|
|
876
|
+
/**
|
|
877
|
+
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
|
|
878
|
+
*/
|
|
879
|
+
attributes: Record<string, string> | undefined;
|
|
880
|
+
}
|
|
881
|
+
export declare namespace DialRequest {
|
|
882
|
+
/**
|
|
883
|
+
* @internal
|
|
884
|
+
*/
|
|
885
|
+
const filterSensitiveLog: (obj: DialRequest) => any;
|
|
886
|
+
}
|
|
887
|
+
/**
|
|
888
|
+
* PutDialRequestBatchRequest
|
|
889
|
+
*/
|
|
890
|
+
export interface PutDialRequestBatchRequest {
|
|
891
|
+
/**
|
|
892
|
+
* Identifier representing a Campaign
|
|
893
|
+
*/
|
|
894
|
+
id: string | undefined;
|
|
895
|
+
/**
|
|
896
|
+
* A list of dial requests.
|
|
897
|
+
*/
|
|
898
|
+
dialRequests: DialRequest[] | undefined;
|
|
899
|
+
}
|
|
900
|
+
export declare namespace PutDialRequestBatchRequest {
|
|
901
|
+
/**
|
|
902
|
+
* @internal
|
|
903
|
+
*/
|
|
904
|
+
const filterSensitiveLog: (obj: PutDialRequestBatchRequest) => any;
|
|
905
|
+
}
|
|
906
|
+
export declare enum FailureCode {
|
|
907
|
+
/**
|
|
908
|
+
* The request failed to satisfy the constraints specified by the service
|
|
909
|
+
*/
|
|
910
|
+
INVALID_INPUT = "InvalidInput",
|
|
911
|
+
/**
|
|
912
|
+
* Request throttled due to large number of pending dial requests
|
|
913
|
+
*/
|
|
914
|
+
REQUEST_THROTTLED = "RequestThrottled",
|
|
915
|
+
/**
|
|
916
|
+
* Unexpected error during processing of request
|
|
917
|
+
*/
|
|
918
|
+
UNKNOWN_ERROR = "UnknownError"
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* A failed request identified by the unique client token.
|
|
922
|
+
*/
|
|
923
|
+
export interface FailedRequest {
|
|
924
|
+
/**
|
|
925
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
926
|
+
*/
|
|
927
|
+
clientToken?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Identifier representing a Dial request
|
|
930
|
+
*/
|
|
931
|
+
id?: string;
|
|
932
|
+
/**
|
|
933
|
+
* A predefined code indicating the error that caused the failure.
|
|
934
|
+
*/
|
|
935
|
+
failureCode?: FailureCode | string;
|
|
936
|
+
}
|
|
937
|
+
export declare namespace FailedRequest {
|
|
938
|
+
/**
|
|
939
|
+
* @internal
|
|
940
|
+
*/
|
|
941
|
+
const filterSensitiveLog: (obj: FailedRequest) => any;
|
|
942
|
+
}
|
|
943
|
+
/**
|
|
944
|
+
* A successful request identified by the unique client token.
|
|
945
|
+
*/
|
|
946
|
+
export interface SuccessfulRequest {
|
|
947
|
+
/**
|
|
948
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
949
|
+
*/
|
|
950
|
+
clientToken?: string;
|
|
951
|
+
/**
|
|
952
|
+
* Identifier representing a Dial request
|
|
953
|
+
*/
|
|
954
|
+
id?: string;
|
|
955
|
+
}
|
|
956
|
+
export declare namespace SuccessfulRequest {
|
|
957
|
+
/**
|
|
958
|
+
* @internal
|
|
959
|
+
*/
|
|
960
|
+
const filterSensitiveLog: (obj: SuccessfulRequest) => any;
|
|
961
|
+
}
|
|
962
|
+
/**
|
|
963
|
+
* PutDialRequestBatchResponse
|
|
964
|
+
*/
|
|
965
|
+
export interface PutDialRequestBatchResponse {
|
|
966
|
+
/**
|
|
967
|
+
* A list of successful requests identified by the unique client token.
|
|
968
|
+
*/
|
|
969
|
+
successfulRequests?: SuccessfulRequest[];
|
|
970
|
+
/**
|
|
971
|
+
* A list of failed requests.
|
|
972
|
+
*/
|
|
973
|
+
failedRequests?: FailedRequest[];
|
|
974
|
+
}
|
|
975
|
+
export declare namespace PutDialRequestBatchResponse {
|
|
976
|
+
/**
|
|
977
|
+
* @internal
|
|
978
|
+
*/
|
|
979
|
+
const filterSensitiveLog: (obj: PutDialRequestBatchResponse) => any;
|
|
980
|
+
}
|
|
981
|
+
/**
|
|
982
|
+
* ResumeCampaignRequest
|
|
983
|
+
*/
|
|
984
|
+
export interface ResumeCampaignRequest {
|
|
985
|
+
/**
|
|
986
|
+
* Identifier representing a Campaign
|
|
987
|
+
*/
|
|
988
|
+
id: string | undefined;
|
|
989
|
+
}
|
|
990
|
+
export declare namespace ResumeCampaignRequest {
|
|
991
|
+
/**
|
|
992
|
+
* @internal
|
|
993
|
+
*/
|
|
994
|
+
const filterSensitiveLog: (obj: ResumeCampaignRequest) => any;
|
|
995
|
+
}
|
|
996
|
+
/**
|
|
997
|
+
* StartCampaignRequest
|
|
998
|
+
*/
|
|
999
|
+
export interface StartCampaignRequest {
|
|
1000
|
+
/**
|
|
1001
|
+
* Identifier representing a Campaign
|
|
1002
|
+
*/
|
|
1003
|
+
id: string | undefined;
|
|
1004
|
+
}
|
|
1005
|
+
export declare namespace StartCampaignRequest {
|
|
1006
|
+
/**
|
|
1007
|
+
* @internal
|
|
1008
|
+
*/
|
|
1009
|
+
const filterSensitiveLog: (obj: StartCampaignRequest) => any;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* The request for StartInstanceOnboardingJob API.
|
|
1013
|
+
*/
|
|
1014
|
+
export interface StartInstanceOnboardingJobRequest {
|
|
1015
|
+
/**
|
|
1016
|
+
* Amazon Connect Instance Id
|
|
1017
|
+
*/
|
|
1018
|
+
connectInstanceId: string | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
1021
|
+
* If disabled, service will perform encryption with its own key.
|
|
1022
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
1023
|
+
* KMS is only type supported
|
|
1024
|
+
*/
|
|
1025
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
1026
|
+
}
|
|
1027
|
+
export declare namespace StartInstanceOnboardingJobRequest {
|
|
1028
|
+
/**
|
|
1029
|
+
* @internal
|
|
1030
|
+
*/
|
|
1031
|
+
const filterSensitiveLog: (obj: StartInstanceOnboardingJobRequest) => any;
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* The response for StartInstanceOnboardingJob API.
|
|
1035
|
+
*/
|
|
1036
|
+
export interface StartInstanceOnboardingJobResponse {
|
|
1037
|
+
/**
|
|
1038
|
+
* Instance onboarding job status object
|
|
1039
|
+
*/
|
|
1040
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
|
|
1041
|
+
}
|
|
1042
|
+
export declare namespace StartInstanceOnboardingJobResponse {
|
|
1043
|
+
/**
|
|
1044
|
+
* @internal
|
|
1045
|
+
*/
|
|
1046
|
+
const filterSensitiveLog: (obj: StartInstanceOnboardingJobResponse) => any;
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* StopCampaignRequest
|
|
1050
|
+
*/
|
|
1051
|
+
export interface StopCampaignRequest {
|
|
1052
|
+
/**
|
|
1053
|
+
* Identifier representing a Campaign
|
|
1054
|
+
*/
|
|
1055
|
+
id: string | undefined;
|
|
1056
|
+
}
|
|
1057
|
+
export declare namespace StopCampaignRequest {
|
|
1058
|
+
/**
|
|
1059
|
+
* @internal
|
|
1060
|
+
*/
|
|
1061
|
+
const filterSensitiveLog: (obj: StopCampaignRequest) => any;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* TagResourceRequest
|
|
1065
|
+
*/
|
|
1066
|
+
export interface TagResourceRequest {
|
|
1067
|
+
/**
|
|
1068
|
+
* Arn
|
|
1069
|
+
*/
|
|
1070
|
+
arn: string | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* Tag map with key and value.
|
|
1073
|
+
*/
|
|
1074
|
+
tags: Record<string, string> | undefined;
|
|
1075
|
+
}
|
|
1076
|
+
export declare namespace TagResourceRequest {
|
|
1077
|
+
/**
|
|
1078
|
+
* @internal
|
|
1079
|
+
*/
|
|
1080
|
+
const filterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
1081
|
+
}
|
|
1082
|
+
/**
|
|
1083
|
+
* UntagResourceRequest
|
|
1084
|
+
*/
|
|
1085
|
+
export interface UntagResourceRequest {
|
|
1086
|
+
/**
|
|
1087
|
+
* Arn
|
|
1088
|
+
*/
|
|
1089
|
+
arn: string | undefined;
|
|
1090
|
+
/**
|
|
1091
|
+
* List of tag keys.
|
|
1092
|
+
*/
|
|
1093
|
+
tagKeys: string[] | undefined;
|
|
1094
|
+
}
|
|
1095
|
+
export declare namespace UntagResourceRequest {
|
|
1096
|
+
/**
|
|
1097
|
+
* @internal
|
|
1098
|
+
*/
|
|
1099
|
+
const filterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
1100
|
+
}
|
|
1101
|
+
/**
|
|
1102
|
+
* UpdateCampaignDialerConfigRequest
|
|
1103
|
+
*/
|
|
1104
|
+
export interface UpdateCampaignDialerConfigRequest {
|
|
1105
|
+
/**
|
|
1106
|
+
* Identifier representing a Campaign
|
|
1107
|
+
*/
|
|
1108
|
+
id: string | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* The possible types of dialer config parameters
|
|
1111
|
+
*/
|
|
1112
|
+
dialerConfig: DialerConfig | undefined;
|
|
1113
|
+
}
|
|
1114
|
+
export declare namespace UpdateCampaignDialerConfigRequest {
|
|
1115
|
+
/**
|
|
1116
|
+
* @internal
|
|
1117
|
+
*/
|
|
1118
|
+
const filterSensitiveLog: (obj: UpdateCampaignDialerConfigRequest) => any;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* UpdateCampaignNameRequest
|
|
1122
|
+
*/
|
|
1123
|
+
export interface UpdateCampaignNameRequest {
|
|
1124
|
+
/**
|
|
1125
|
+
* Identifier representing a Campaign
|
|
1126
|
+
*/
|
|
1127
|
+
id: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* The name of an Amazon Connect Campaign name.
|
|
1130
|
+
*/
|
|
1131
|
+
name: string | undefined;
|
|
1132
|
+
}
|
|
1133
|
+
export declare namespace UpdateCampaignNameRequest {
|
|
1134
|
+
/**
|
|
1135
|
+
* @internal
|
|
1136
|
+
*/
|
|
1137
|
+
const filterSensitiveLog: (obj: UpdateCampaignNameRequest) => any;
|
|
1138
|
+
}
|
|
1139
|
+
/**
|
|
1140
|
+
* UpdateCampaignOutboundCallConfigRequest
|
|
1141
|
+
*/
|
|
1142
|
+
export interface UpdateCampaignOutboundCallConfigRequest {
|
|
1143
|
+
/**
|
|
1144
|
+
* Identifier representing a Campaign
|
|
1145
|
+
*/
|
|
1146
|
+
id: string | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* The identifier of the contact flow for the outbound call.
|
|
1149
|
+
*/
|
|
1150
|
+
connectContactFlowId?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
1153
|
+
*/
|
|
1154
|
+
connectSourcePhoneNumber?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* Answering Machine Detection config
|
|
1157
|
+
*/
|
|
1158
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
1159
|
+
}
|
|
1160
|
+
export declare namespace UpdateCampaignOutboundCallConfigRequest {
|
|
1161
|
+
/**
|
|
1162
|
+
* @internal
|
|
1163
|
+
*/
|
|
1164
|
+
const filterSensitiveLog: (obj: UpdateCampaignOutboundCallConfigRequest) => any;
|
|
1165
|
+
}
|