UNPKG

346 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Pinpoint extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Pinpoint.Types.ClientConfiguration)
13 config: Config & Pinpoint.Types.ClientConfiguration;
14 /**
15 * Creates an application.
16 */
17 createApp(params: Pinpoint.Types.CreateAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
18 /**
19 * Creates an application.
20 */
21 createApp(callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
22 /**
23 * Creates a new campaign for an application or updates the settings of an existing campaign for an application.
24 */
25 createCampaign(params: Pinpoint.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
26 /**
27 * Creates a new campaign for an application or updates the settings of an existing campaign for an application.
28 */
29 createCampaign(callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
30 /**
31 * Creates a message template for messages that are sent through the email channel.
32 */
33 createEmailTemplate(params: Pinpoint.Types.CreateEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateEmailTemplateResponse) => void): Request<Pinpoint.Types.CreateEmailTemplateResponse, AWSError>;
34 /**
35 * Creates a message template for messages that are sent through the email channel.
36 */
37 createEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateEmailTemplateResponse) => void): Request<Pinpoint.Types.CreateEmailTemplateResponse, AWSError>;
38 /**
39 * Creates an export job for an application.
40 */
41 createExportJob(params: Pinpoint.Types.CreateExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
42 /**
43 * Creates an export job for an application.
44 */
45 createExportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
46 /**
47 * Creates an import job for an application.
48 */
49 createImportJob(params: Pinpoint.Types.CreateImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
50 /**
51 * Creates an import job for an application.
52 */
53 createImportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
54 /**
55 * Creates a journey for an application.
56 */
57 createJourney(params: Pinpoint.Types.CreateJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateJourneyResponse) => void): Request<Pinpoint.Types.CreateJourneyResponse, AWSError>;
58 /**
59 * Creates a journey for an application.
60 */
61 createJourney(callback?: (err: AWSError, data: Pinpoint.Types.CreateJourneyResponse) => void): Request<Pinpoint.Types.CreateJourneyResponse, AWSError>;
62 /**
63 * Creates a message template for messages that are sent through a push notification channel.
64 */
65 createPushTemplate(params: Pinpoint.Types.CreatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
66 /**
67 * Creates a message template for messages that are sent through a push notification channel.
68 */
69 createPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
70 /**
71 * Creates an Amazon Pinpoint configuration for a recommender model.
72 */
73 createRecommenderConfiguration(params: Pinpoint.Types.CreateRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.CreateRecommenderConfigurationResponse, AWSError>;
74 /**
75 * Creates an Amazon Pinpoint configuration for a recommender model.
76 */
77 createRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.CreateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.CreateRecommenderConfigurationResponse, AWSError>;
78 /**
79 * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
80 */
81 createSegment(params: Pinpoint.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
82 /**
83 * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
84 */
85 createSegment(callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
86 /**
87 * Creates a message template for messages that are sent through the SMS channel.
88 */
89 createSmsTemplate(params: Pinpoint.Types.CreateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
90 /**
91 * Creates a message template for messages that are sent through the SMS channel.
92 */
93 createSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
94 /**
95 * Creates a message template for messages that are sent through the voice channel.
96 */
97 createVoiceTemplate(params: Pinpoint.Types.CreateVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateVoiceTemplateResponse) => void): Request<Pinpoint.Types.CreateVoiceTemplateResponse, AWSError>;
98 /**
99 * Creates a message template for messages that are sent through the voice channel.
100 */
101 createVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateVoiceTemplateResponse) => void): Request<Pinpoint.Types.CreateVoiceTemplateResponse, AWSError>;
102 /**
103 * Disables the ADM channel for an application and deletes any existing settings for the channel.
104 */
105 deleteAdmChannel(params: Pinpoint.Types.DeleteAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
106 /**
107 * Disables the ADM channel for an application and deletes any existing settings for the channel.
108 */
109 deleteAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
110 /**
111 * Disables the APNs channel for an application and deletes any existing settings for the channel.
112 */
113 deleteApnsChannel(params: Pinpoint.Types.DeleteApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
114 /**
115 * Disables the APNs channel for an application and deletes any existing settings for the channel.
116 */
117 deleteApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
118 /**
119 * Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
120 */
121 deleteApnsSandboxChannel(params: Pinpoint.Types.DeleteApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
122 /**
123 * Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
124 */
125 deleteApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
126 /**
127 * Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
128 */
129 deleteApnsVoipChannel(params: Pinpoint.Types.DeleteApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
130 /**
131 * Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
132 */
133 deleteApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
134 /**
135 * Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
136 */
137 deleteApnsVoipSandboxChannel(params: Pinpoint.Types.DeleteApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
138 /**
139 * Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
140 */
141 deleteApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
142 /**
143 * Deletes an application.
144 */
145 deleteApp(params: Pinpoint.Types.DeleteAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
146 /**
147 * Deletes an application.
148 */
149 deleteApp(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
150 /**
151 * Disables the Baidu channel for an application and deletes any existing settings for the channel.
152 */
153 deleteBaiduChannel(params: Pinpoint.Types.DeleteBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
154 /**
155 * Disables the Baidu channel for an application and deletes any existing settings for the channel.
156 */
157 deleteBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
158 /**
159 * Deletes a campaign from an application.
160 */
161 deleteCampaign(params: Pinpoint.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
162 /**
163 * Deletes a campaign from an application.
164 */
165 deleteCampaign(callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
166 /**
167 * Disables the email channel for an application and deletes any existing settings for the channel.
168 */
169 deleteEmailChannel(params: Pinpoint.Types.DeleteEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
170 /**
171 * Disables the email channel for an application and deletes any existing settings for the channel.
172 */
173 deleteEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
174 /**
175 * Deletes a message template for messages that were sent through the email channel.
176 */
177 deleteEmailTemplate(params: Pinpoint.Types.DeleteEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
178 /**
179 * Deletes a message template for messages that were sent through the email channel.
180 */
181 deleteEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
182 /**
183 * Deletes an endpoint from an application.
184 */
185 deleteEndpoint(params: Pinpoint.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
186 /**
187 * Deletes an endpoint from an application.
188 */
189 deleteEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
190 /**
191 * Deletes the event stream for an application.
192 */
193 deleteEventStream(params: Pinpoint.Types.DeleteEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
194 /**
195 * Deletes the event stream for an application.
196 */
197 deleteEventStream(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
198 /**
199 * Disables the GCM channel for an application and deletes any existing settings for the channel.
200 */
201 deleteGcmChannel(params: Pinpoint.Types.DeleteGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
202 /**
203 * Disables the GCM channel for an application and deletes any existing settings for the channel.
204 */
205 deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
206 /**
207 * Deletes a journey from an application.
208 */
209 deleteJourney(params: Pinpoint.Types.DeleteJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteJourneyResponse) => void): Request<Pinpoint.Types.DeleteJourneyResponse, AWSError>;
210 /**
211 * Deletes a journey from an application.
212 */
213 deleteJourney(callback?: (err: AWSError, data: Pinpoint.Types.DeleteJourneyResponse) => void): Request<Pinpoint.Types.DeleteJourneyResponse, AWSError>;
214 /**
215 * Deletes a message template for messages that were sent through a push notification channel.
216 */
217 deletePushTemplate(params: Pinpoint.Types.DeletePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
218 /**
219 * Deletes a message template for messages that were sent through a push notification channel.
220 */
221 deletePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
222 /**
223 * Deletes an Amazon Pinpoint configuration for a recommender model.
224 */
225 deleteRecommenderConfiguration(params: Pinpoint.Types.DeleteRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.DeleteRecommenderConfigurationResponse, AWSError>;
226 /**
227 * Deletes an Amazon Pinpoint configuration for a recommender model.
228 */
229 deleteRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.DeleteRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.DeleteRecommenderConfigurationResponse, AWSError>;
230 /**
231 * Deletes a segment from an application.
232 */
233 deleteSegment(params: Pinpoint.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
234 /**
235 * Deletes a segment from an application.
236 */
237 deleteSegment(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
238 /**
239 * Disables the SMS channel for an application and deletes any existing settings for the channel.
240 */
241 deleteSmsChannel(params: Pinpoint.Types.DeleteSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
242 /**
243 * Disables the SMS channel for an application and deletes any existing settings for the channel.
244 */
245 deleteSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
246 /**
247 * Deletes a message template for messages that were sent through the SMS channel.
248 */
249 deleteSmsTemplate(params: Pinpoint.Types.DeleteSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
250 /**
251 * Deletes a message template for messages that were sent through the SMS channel.
252 */
253 deleteSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
254 /**
255 * Deletes all the endpoints that are associated with a specific user ID.
256 */
257 deleteUserEndpoints(params: Pinpoint.Types.DeleteUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
258 /**
259 * Deletes all the endpoints that are associated with a specific user ID.
260 */
261 deleteUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
262 /**
263 * Disables the voice channel for an application and deletes any existing settings for the channel.
264 */
265 deleteVoiceChannel(params: Pinpoint.Types.DeleteVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
266 /**
267 * Disables the voice channel for an application and deletes any existing settings for the channel.
268 */
269 deleteVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
270 /**
271 * Deletes a message template for messages that were sent through the voice channel.
272 */
273 deleteVoiceTemplate(params: Pinpoint.Types.DeleteVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceTemplateResponse) => void): Request<Pinpoint.Types.DeleteVoiceTemplateResponse, AWSError>;
274 /**
275 * Deletes a message template for messages that were sent through the voice channel.
276 */
277 deleteVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceTemplateResponse) => void): Request<Pinpoint.Types.DeleteVoiceTemplateResponse, AWSError>;
278 /**
279 * Retrieves information about the status and settings of the ADM channel for an application.
280 */
281 getAdmChannel(params: Pinpoint.Types.GetAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
282 /**
283 * Retrieves information about the status and settings of the ADM channel for an application.
284 */
285 getAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
286 /**
287 * Retrieves information about the status and settings of the APNs channel for an application.
288 */
289 getApnsChannel(params: Pinpoint.Types.GetApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
290 /**
291 * Retrieves information about the status and settings of the APNs channel for an application.
292 */
293 getApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
294 /**
295 * Retrieves information about the status and settings of the APNs sandbox channel for an application.
296 */
297 getApnsSandboxChannel(params: Pinpoint.Types.GetApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
298 /**
299 * Retrieves information about the status and settings of the APNs sandbox channel for an application.
300 */
301 getApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
302 /**
303 * Retrieves information about the status and settings of the APNs VoIP channel for an application.
304 */
305 getApnsVoipChannel(params: Pinpoint.Types.GetApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
306 /**
307 * Retrieves information about the status and settings of the APNs VoIP channel for an application.
308 */
309 getApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
310 /**
311 * Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
312 */
313 getApnsVoipSandboxChannel(params: Pinpoint.Types.GetApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
314 /**
315 * Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
316 */
317 getApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
318 /**
319 * Retrieves information about an application.
320 */
321 getApp(params: Pinpoint.Types.GetAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
322 /**
323 * Retrieves information about an application.
324 */
325 getApp(callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
326 /**
327 * Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
328 */
329 getApplicationDateRangeKpi(params: Pinpoint.Types.GetApplicationDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
330 /**
331 * Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
332 */
333 getApplicationDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
334 /**
335 * Retrieves information about the settings for an application.
336 */
337 getApplicationSettings(params: Pinpoint.Types.GetApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
338 /**
339 * Retrieves information about the settings for an application.
340 */
341 getApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
342 /**
343 * Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
344 */
345 getApps(params: Pinpoint.Types.GetAppsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
346 /**
347 * Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
348 */
349 getApps(callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
350 /**
351 * Retrieves information about the status and settings of the Baidu channel for an application.
352 */
353 getBaiduChannel(params: Pinpoint.Types.GetBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
354 /**
355 * Retrieves information about the status and settings of the Baidu channel for an application.
356 */
357 getBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
358 /**
359 * Retrieves information about the status, configuration, and other settings for a campaign.
360 */
361 getCampaign(params: Pinpoint.Types.GetCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
362 /**
363 * Retrieves information about the status, configuration, and other settings for a campaign.
364 */
365 getCampaign(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
366 /**
367 * Retrieves information about all the activities for a campaign.
368 */
369 getCampaignActivities(params: Pinpoint.Types.GetCampaignActivitiesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
370 /**
371 * Retrieves information about all the activities for a campaign.
372 */
373 getCampaignActivities(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
374 /**
375 * Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
376 */
377 getCampaignDateRangeKpi(params: Pinpoint.Types.GetCampaignDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
378 /**
379 * Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
380 */
381 getCampaignDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
382 /**
383 * Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
384 */
385 getCampaignVersion(params: Pinpoint.Types.GetCampaignVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
386 /**
387 * Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
388 */
389 getCampaignVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
390 /**
391 * Retrieves information about the status, configuration, and other settings for all versions of a campaign.
392 */
393 getCampaignVersions(params: Pinpoint.Types.GetCampaignVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
394 /**
395 * Retrieves information about the status, configuration, and other settings for all versions of a campaign.
396 */
397 getCampaignVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
398 /**
399 * Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
400 */
401 getCampaigns(params: Pinpoint.Types.GetCampaignsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
402 /**
403 * Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
404 */
405 getCampaigns(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
406 /**
407 * Retrieves information about the history and status of each channel for an application.
408 */
409 getChannels(params: Pinpoint.Types.GetChannelsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
410 /**
411 * Retrieves information about the history and status of each channel for an application.
412 */
413 getChannels(callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
414 /**
415 * Retrieves information about the status and settings of the email channel for an application.
416 */
417 getEmailChannel(params: Pinpoint.Types.GetEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
418 /**
419 * Retrieves information about the status and settings of the email channel for an application.
420 */
421 getEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
422 /**
423 * Retrieves the content and settings of a message template for messages that are sent through the email channel.
424 */
425 getEmailTemplate(params: Pinpoint.Types.GetEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
426 /**
427 * Retrieves the content and settings of a message template for messages that are sent through the email channel.
428 */
429 getEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
430 /**
431 * Retrieves information about the settings and attributes of a specific endpoint for an application.
432 */
433 getEndpoint(params: Pinpoint.Types.GetEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
434 /**
435 * Retrieves information about the settings and attributes of a specific endpoint for an application.
436 */
437 getEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
438 /**
439 * Retrieves information about the event stream settings for an application.
440 */
441 getEventStream(params: Pinpoint.Types.GetEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
442 /**
443 * Retrieves information about the event stream settings for an application.
444 */
445 getEventStream(callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
446 /**
447 * Retrieves information about the status and settings of a specific export job for an application.
448 */
449 getExportJob(params: Pinpoint.Types.GetExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
450 /**
451 * Retrieves information about the status and settings of a specific export job for an application.
452 */
453 getExportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
454 /**
455 * Retrieves information about the status and settings of all the export jobs for an application.
456 */
457 getExportJobs(params: Pinpoint.Types.GetExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
458 /**
459 * Retrieves information about the status and settings of all the export jobs for an application.
460 */
461 getExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
462 /**
463 * Retrieves information about the status and settings of the GCM channel for an application.
464 */
465 getGcmChannel(params: Pinpoint.Types.GetGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
466 /**
467 * Retrieves information about the status and settings of the GCM channel for an application.
468 */
469 getGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
470 /**
471 * Retrieves information about the status and settings of a specific import job for an application.
472 */
473 getImportJob(params: Pinpoint.Types.GetImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
474 /**
475 * Retrieves information about the status and settings of a specific import job for an application.
476 */
477 getImportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
478 /**
479 * Retrieves information about the status and settings of all the import jobs for an application.
480 */
481 getImportJobs(params: Pinpoint.Types.GetImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
482 /**
483 * Retrieves information about the status and settings of all the import jobs for an application.
484 */
485 getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
486 /**
487 * Retrieves information about the status, configuration, and other settings for a journey.
488 */
489 getJourney(params: Pinpoint.Types.GetJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyResponse) => void): Request<Pinpoint.Types.GetJourneyResponse, AWSError>;
490 /**
491 * Retrieves information about the status, configuration, and other settings for a journey.
492 */
493 getJourney(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyResponse) => void): Request<Pinpoint.Types.GetJourneyResponse, AWSError>;
494 /**
495 * Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
496 */
497 getJourneyDateRangeKpi(params: Pinpoint.Types.GetJourneyDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetJourneyDateRangeKpiResponse, AWSError>;
498 /**
499 * Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
500 */
501 getJourneyDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetJourneyDateRangeKpiResponse, AWSError>;
502 /**
503 * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
504 */
505 getJourneyExecutionActivityMetrics(params: Pinpoint.Types.GetJourneyExecutionActivityMetricsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse, AWSError>;
506 /**
507 * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
508 */
509 getJourneyExecutionActivityMetrics(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse, AWSError>;
510 /**
511 * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
512 */
513 getJourneyExecutionMetrics(params: Pinpoint.Types.GetJourneyExecutionMetricsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionMetricsResponse, AWSError>;
514 /**
515 * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
516 */
517 getJourneyExecutionMetrics(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionMetricsResponse, AWSError>;
518 /**
519 * Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
520 */
521 getPushTemplate(params: Pinpoint.Types.GetPushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
522 /**
523 * Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
524 */
525 getPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
526 /**
527 * Retrieves information about an Amazon Pinpoint configuration for a recommender model.
528 */
529 getRecommenderConfiguration(params: Pinpoint.Types.GetRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationResponse, AWSError>;
530 /**
531 * Retrieves information about an Amazon Pinpoint configuration for a recommender model.
532 */
533 getRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationResponse, AWSError>;
534 /**
535 * Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
536 */
537 getRecommenderConfigurations(params: Pinpoint.Types.GetRecommenderConfigurationsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationsResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationsResponse, AWSError>;
538 /**
539 * Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
540 */
541 getRecommenderConfigurations(callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationsResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationsResponse, AWSError>;
542 /**
543 * Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
544 */
545 getSegment(params: Pinpoint.Types.GetSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
546 /**
547 * Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
548 */
549 getSegment(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
550 /**
551 * Retrieves information about the status and settings of the export jobs for a segment.
552 */
553 getSegmentExportJobs(params: Pinpoint.Types.GetSegmentExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
554 /**
555 * Retrieves information about the status and settings of the export jobs for a segment.
556 */
557 getSegmentExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
558 /**
559 * Retrieves information about the status and settings of the import jobs for a segment.
560 */
561 getSegmentImportJobs(params: Pinpoint.Types.GetSegmentImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
562 /**
563 * Retrieves information about the status and settings of the import jobs for a segment.
564 */
565 getSegmentImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
566 /**
567 * Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
568 */
569 getSegmentVersion(params: Pinpoint.Types.GetSegmentVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
570 /**
571 * Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
572 */
573 getSegmentVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
574 /**
575 * Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
576 */
577 getSegmentVersions(params: Pinpoint.Types.GetSegmentVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
578 /**
579 * Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
580 */
581 getSegmentVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
582 /**
583 * Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
584 */
585 getSegments(params: Pinpoint.Types.GetSegmentsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
586 /**
587 * Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
588 */
589 getSegments(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
590 /**
591 * Retrieves information about the status and settings of the SMS channel for an application.
592 */
593 getSmsChannel(params: Pinpoint.Types.GetSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
594 /**
595 * Retrieves information about the status and settings of the SMS channel for an application.
596 */
597 getSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
598 /**
599 * Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
600 */
601 getSmsTemplate(params: Pinpoint.Types.GetSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
602 /**
603 * Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
604 */
605 getSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
606 /**
607 * Retrieves information about all the endpoints that are associated with a specific user ID.
608 */
609 getUserEndpoints(params: Pinpoint.Types.GetUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
610 /**
611 * Retrieves information about all the endpoints that are associated with a specific user ID.
612 */
613 getUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
614 /**
615 * Retrieves information about the status and settings of the voice channel for an application.
616 */
617 getVoiceChannel(params: Pinpoint.Types.GetVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
618 /**
619 * Retrieves information about the status and settings of the voice channel for an application.
620 */
621 getVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
622 /**
623 * Retrieves the content and settings of a message template for messages that are sent through the voice channel.
624 */
625 getVoiceTemplate(params: Pinpoint.Types.GetVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceTemplateResponse) => void): Request<Pinpoint.Types.GetVoiceTemplateResponse, AWSError>;
626 /**
627 * Retrieves the content and settings of a message template for messages that are sent through the voice channel.
628 */
629 getVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceTemplateResponse) => void): Request<Pinpoint.Types.GetVoiceTemplateResponse, AWSError>;
630 /**
631 * Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
632 */
633 listJourneys(params: Pinpoint.Types.ListJourneysRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListJourneysResponse) => void): Request<Pinpoint.Types.ListJourneysResponse, AWSError>;
634 /**
635 * Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
636 */
637 listJourneys(callback?: (err: AWSError, data: Pinpoint.Types.ListJourneysResponse) => void): Request<Pinpoint.Types.ListJourneysResponse, AWSError>;
638 /**
639 * Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
640 */
641 listTagsForResource(params: Pinpoint.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
642 /**
643 * Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
644 */
645 listTagsForResource(callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
646 /**
647 * Retrieves information about all the versions of a specific message template.
648 */
649 listTemplateVersions(params: Pinpoint.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTemplateVersionsResponse) => void): Request<Pinpoint.Types.ListTemplateVersionsResponse, AWSError>;
650 /**
651 * Retrieves information about all the versions of a specific message template.
652 */
653 listTemplateVersions(callback?: (err: AWSError, data: Pinpoint.Types.ListTemplateVersionsResponse) => void): Request<Pinpoint.Types.ListTemplateVersionsResponse, AWSError>;
654 /**
655 * Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
656 */
657 listTemplates(params: Pinpoint.Types.ListTemplatesRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
658 /**
659 * Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
660 */
661 listTemplates(callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
662 /**
663 * Retrieves information about a phone number.
664 */
665 phoneNumberValidate(params: Pinpoint.Types.PhoneNumberValidateRequest, callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
666 /**
667 * Retrieves information about a phone number.
668 */
669 phoneNumberValidate(callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
670 /**
671 * Creates a new event stream for an application or updates the settings of an existing event stream for an application.
672 */
673 putEventStream(params: Pinpoint.Types.PutEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
674 /**
675 * Creates a new event stream for an application or updates the settings of an existing event stream for an application.
676 */
677 putEventStream(callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
678 /**
679 * Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
680 */
681 putEvents(params: Pinpoint.Types.PutEventsRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
682 /**
683 * Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
684 */
685 putEvents(callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
686 /**
687 * Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
688 */
689 removeAttributes(params: Pinpoint.Types.RemoveAttributesRequest, callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
690 /**
691 * Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
692 */
693 removeAttributes(callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
694 /**
695 * Creates and sends a direct message.
696 */
697 sendMessages(params: Pinpoint.Types.SendMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
698 /**
699 * Creates and sends a direct message.
700 */
701 sendMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
702 /**
703 * Creates and sends a message to a list of users.
704 */
705 sendUsersMessages(params: Pinpoint.Types.SendUsersMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
706 /**
707 * Creates and sends a message to a list of users.
708 */
709 sendUsersMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
710 /**
711 * Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
712 */
713 tagResource(params: Pinpoint.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
714 /**
715 * Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
716 */
717 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
718 /**
719 * Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
720 */
721 untagResource(params: Pinpoint.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
722 /**
723 * Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
724 */
725 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
726 /**
727 * Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
728 */
729 updateAdmChannel(params: Pinpoint.Types.UpdateAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
730 /**
731 * Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
732 */
733 updateAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
734 /**
735 * Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
736 */
737 updateApnsChannel(params: Pinpoint.Types.UpdateApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
738 /**
739 * Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
740 */
741 updateApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
742 /**
743 * Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
744 */
745 updateApnsSandboxChannel(params: Pinpoint.Types.UpdateApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
746 /**
747 * Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
748 */
749 updateApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
750 /**
751 * Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
752 */
753 updateApnsVoipChannel(params: Pinpoint.Types.UpdateApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
754 /**
755 * Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
756 */
757 updateApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
758 /**
759 * Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
760 */
761 updateApnsVoipSandboxChannel(params: Pinpoint.Types.UpdateApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
762 /**
763 * Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
764 */
765 updateApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
766 /**
767 * Updates the settings for an application.
768 */
769 updateApplicationSettings(params: Pinpoint.Types.UpdateApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
770 /**
771 * Updates the settings for an application.
772 */
773 updateApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
774 /**
775 * Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
776 */
777 updateBaiduChannel(params: Pinpoint.Types.UpdateBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
778 /**
779 * Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
780 */
781 updateBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
782 /**
783 * Updates the configuration and other settings for a campaign.
784 */
785 updateCampaign(params: Pinpoint.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
786 /**
787 * Updates the configuration and other settings for a campaign.
788 */
789 updateCampaign(callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
790 /**
791 * Enables the email channel for an application or updates the status and settings of the email channel for an application.
792 */
793 updateEmailChannel(params: Pinpoint.Types.UpdateEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
794 /**
795 * Enables the email channel for an application or updates the status and settings of the email channel for an application.
796 */
797 updateEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
798 /**
799 * Updates an existing message template for messages that are sent through the email channel.
800 */
801 updateEmailTemplate(params: Pinpoint.Types.UpdateEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
802 /**
803 * Updates an existing message template for messages that are sent through the email channel.
804 */
805 updateEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
806 /**
807 * Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.
808 */
809 updateEndpoint(params: Pinpoint.Types.UpdateEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
810 /**
811 * Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.
812 */
813 updateEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
814 /**
815 * Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
816 */
817 updateEndpointsBatch(params: Pinpoint.Types.UpdateEndpointsBatchRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
818 /**
819 * Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
820 */
821 updateEndpointsBatch(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
822 /**
823 * Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
824 */
825 updateGcmChannel(params: Pinpoint.Types.UpdateGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
826 /**
827 * Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
828 */
829 updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
830 /**
831 * Updates the configuration and other settings for a journey.
832 */
833 updateJourney(params: Pinpoint.Types.UpdateJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyResponse) => void): Request<Pinpoint.Types.UpdateJourneyResponse, AWSError>;
834 /**
835 * Updates the configuration and other settings for a journey.
836 */
837 updateJourney(callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyResponse) => void): Request<Pinpoint.Types.UpdateJourneyResponse, AWSError>;
838 /**
839 * Cancels (stops) an active journey.
840 */
841 updateJourneyState(params: Pinpoint.Types.UpdateJourneyStateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyStateResponse) => void): Request<Pinpoint.Types.UpdateJourneyStateResponse, AWSError>;
842 /**
843 * Cancels (stops) an active journey.
844 */
845 updateJourneyState(callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyStateResponse) => void): Request<Pinpoint.Types.UpdateJourneyStateResponse, AWSError>;
846 /**
847 * Updates an existing message template for messages that are sent through a push notification channel.
848 */
849 updatePushTemplate(params: Pinpoint.Types.UpdatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
850 /**
851 * Updates an existing message template for messages that are sent through a push notification channel.
852 */
853 updatePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
854 /**
855 * Updates an Amazon Pinpoint configuration for a recommender model.
856 */
857 updateRecommenderConfiguration(params: Pinpoint.Types.UpdateRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.UpdateRecommenderConfigurationResponse, AWSError>;
858 /**
859 * Updates an Amazon Pinpoint configuration for a recommender model.
860 */
861 updateRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.UpdateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.UpdateRecommenderConfigurationResponse, AWSError>;
862 /**
863 * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
864 */
865 updateSegment(params: Pinpoint.Types.UpdateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
866 /**
867 * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
868 */
869 updateSegment(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
870 /**
871 * Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
872 */
873 updateSmsChannel(params: Pinpoint.Types.UpdateSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
874 /**
875 * Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
876 */
877 updateSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
878 /**
879 * Updates an existing message template for messages that are sent through the SMS channel.
880 */
881 updateSmsTemplate(params: Pinpoint.Types.UpdateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
882 /**
883 * Updates an existing message template for messages that are sent through the SMS channel.
884 */
885 updateSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
886 /**
887 * Changes the status of a specific version of a message template to active.
888 */
889 updateTemplateActiveVersion(params: Pinpoint.Types.UpdateTemplateActiveVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateTemplateActiveVersionResponse) => void): Request<Pinpoint.Types.UpdateTemplateActiveVersionResponse, AWSError>;
890 /**
891 * Changes the status of a specific version of a message template to active.
892 */
893 updateTemplateActiveVersion(callback?: (err: AWSError, data: Pinpoint.Types.UpdateTemplateActiveVersionResponse) => void): Request<Pinpoint.Types.UpdateTemplateActiveVersionResponse, AWSError>;
894 /**
895 * Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
896 */
897 updateVoiceChannel(params: Pinpoint.Types.UpdateVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
898 /**
899 * Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
900 */
901 updateVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
902 /**
903 * Updates an existing message template for messages that are sent through the voice channel.
904 */
905 updateVoiceTemplate(params: Pinpoint.Types.UpdateVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceTemplateResponse) => void): Request<Pinpoint.Types.UpdateVoiceTemplateResponse, AWSError>;
906 /**
907 * Updates an existing message template for messages that are sent through the voice channel.
908 */
909 updateVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceTemplateResponse) => void): Request<Pinpoint.Types.UpdateVoiceTemplateResponse, AWSError>;
910}
911declare namespace Pinpoint {
912 export interface ADMChannelRequest {
913 /**
914 * The Client ID that you received from Amazon to send messages by using ADM.
915 */
916 ClientId: __string;
917 /**
918 * The Client Secret that you received from Amazon to send messages by using ADM.
919 */
920 ClientSecret: __string;
921 /**
922 * Specifies whether to enable the ADM channel for the application.
923 */
924 Enabled?: __boolean;
925 }
926 export interface ADMChannelResponse {
927 /**
928 * The unique identifier for the application that the ADM channel applies to.
929 */
930 ApplicationId?: __string;
931 /**
932 * The date and time when the ADM channel was enabled.
933 */
934 CreationDate?: __string;
935 /**
936 * Specifies whether the ADM channel is enabled for the application.
937 */
938 Enabled?: __boolean;
939 /**
940 * (Not used) This property is retained only for backward compatibility.
941 */
942 HasCredential?: __boolean;
943 /**
944 * (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
945 */
946 Id?: __string;
947 /**
948 * Specifies whether the ADM channel is archived.
949 */
950 IsArchived?: __boolean;
951 /**
952 * The user who last modified the ADM channel.
953 */
954 LastModifiedBy?: __string;
955 /**
956 * The date and time when the ADM channel was last modified.
957 */
958 LastModifiedDate?: __string;
959 /**
960 * The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
961 */
962 Platform: __string;
963 /**
964 * The current version of the ADM channel.
965 */
966 Version?: __integer;
967 }
968 export interface ADMMessage {
969 /**
970 * The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
971 */
972 Action?: Action;
973 /**
974 * The body of the notification message.
975 */
976 Body?: __string;
977 /**
978 * An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
979 */
980 ConsolidationKey?: __string;
981 /**
982 * The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
983 */
984 Data?: MapOf__string;
985 /**
986 * The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
987 */
988 ExpiresAfter?: __string;
989 /**
990 * The icon image name of the asset saved in your app.
991 */
992 IconReference?: __string;
993 /**
994 * The URL of the large icon image to display in the content view of the push notification.
995 */
996 ImageIconUrl?: __string;
997 /**
998 * The URL of an image to display in the push notification.
999 */
1000 ImageUrl?: __string;
1001 /**
1002 * The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
1003 */
1004 MD5?: __string;
1005 /**
1006 * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
1007 */
1008 RawContent?: __string;
1009 /**
1010 * Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
1011 */
1012 SilentPush?: __boolean;
1013 /**
1014 * The URL of the small icon image to display in the status bar and the content view of the push notification.
1015 */
1016 SmallImageIconUrl?: __string;
1017 /**
1018 * The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
1019 */
1020 Sound?: __string;
1021 /**
1022 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
1023 */
1024 Substitutions?: MapOfListOf__string;
1025 /**
1026 * The title to display above the notification message on the recipient's device.
1027 */
1028 Title?: __string;
1029 /**
1030 * The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
1031 */
1032 Url?: __string;
1033 }
1034 export interface APNSChannelRequest {
1035 /**
1036 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1037 */
1038 BundleId?: __string;
1039 /**
1040 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
1041 */
1042 Certificate?: __string;
1043 /**
1044 * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
1045 */
1046 DefaultAuthenticationMethod?: __string;
1047 /**
1048 * Specifies whether to enable the APNs channel for the application.
1049 */
1050 Enabled?: __boolean;
1051 /**
1052 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
1053 */
1054 PrivateKey?: __string;
1055 /**
1056 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1057 */
1058 TeamId?: __string;
1059 /**
1060 * The authentication key to use for APNs tokens.
1061 */
1062 TokenKey?: __string;
1063 /**
1064 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
1065 */
1066 TokenKeyId?: __string;
1067 }
1068 export interface APNSChannelResponse {
1069 /**
1070 * The unique identifier for the application that the APNs channel applies to.
1071 */
1072 ApplicationId?: __string;
1073 /**
1074 * The date and time when the APNs channel was enabled.
1075 */
1076 CreationDate?: __string;
1077 /**
1078 * The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
1079 */
1080 DefaultAuthenticationMethod?: __string;
1081 /**
1082 * Specifies whether the APNs channel is enabled for the application.
1083 */
1084 Enabled?: __boolean;
1085 /**
1086 * (Not used) This property is retained only for backward compatibility.
1087 */
1088 HasCredential?: __boolean;
1089 /**
1090 * Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
1091 */
1092 HasTokenKey?: __boolean;
1093 /**
1094 * (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
1095 */
1096 Id?: __string;
1097 /**
1098 * Specifies whether the APNs channel is archived.
1099 */
1100 IsArchived?: __boolean;
1101 /**
1102 * The user who last modified the APNs channel.
1103 */
1104 LastModifiedBy?: __string;
1105 /**
1106 * The date and time when the APNs channel was last modified.
1107 */
1108 LastModifiedDate?: __string;
1109 /**
1110 * The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
1111 */
1112 Platform: __string;
1113 /**
1114 * The current version of the APNs channel.
1115 */
1116 Version?: __integer;
1117 }
1118 export interface APNSMessage {
1119 /**
1120 * The type of push notification to send. Valid values are: alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification. background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices. complication - For a notification that contains update information for an app’s complication timeline. fileprovider - For a notification that signals changes to a File Provider extension. mdm - For a notification that tells managed devices to contact the MDM server. voip - For a notification that provides information about an incoming VoIP call. Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message. For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
1121 */
1122 APNSPushType?: __string;
1123 /**
1124 * The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
1125 */
1126 Action?: Action;
1127 /**
1128 * The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
1129 */
1130 Badge?: __integer;
1131 /**
1132 * The body of the notification message.
1133 */
1134 Body?: __string;
1135 /**
1136 * The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
1137 */
1138 Category?: __string;
1139 /**
1140 * An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
1141 */
1142 CollapseId?: __string;
1143 /**
1144 * The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
1145 */
1146 Data?: MapOf__string;
1147 /**
1148 * The URL of an image or video to display in the push notification.
1149 */
1150 MediaUrl?: __string;
1151 /**
1152 * The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
1153 */
1154 PreferredAuthenticationMethod?: __string;
1155 /**
1156 * para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled./listitem> 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device./para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
1157 */
1158 Priority?: __string;
1159 /**
1160 * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
1161 */
1162 RawContent?: __string;
1163 /**
1164 * Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
1165 */
1166 SilentPush?: __boolean;
1167 /**
1168 * The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
1169 */
1170 Sound?: __string;
1171 /**
1172 * The default message variables to use in the notification message. You can override these default variables with individual address variables.
1173 */
1174 Substitutions?: MapOfListOf__string;
1175 /**
1176 * The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
1177 */
1178 ThreadId?: __string;
1179 /**
1180 * The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
1181 */
1182 TimeToLive?: __integer;
1183 /**
1184 * The title to display above the notification message on the recipient's device.
1185 */
1186 Title?: __string;
1187 /**
1188 * The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
1189 */
1190 Url?: __string;
1191 }
1192 export interface APNSPushNotificationTemplate {
1193 /**
1194 * The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
1195 */
1196 Action?: Action;
1197 /**
1198 * The message body to use in push notifications that are based on the message template.
1199 */
1200 Body?: __string;
1201 /**
1202 * The URL of an image or video to display in push notifications that are based on the message template.
1203 */
1204 MediaUrl?: __string;
1205 /**
1206 * The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
1207 */
1208 RawContent?: __string;
1209 /**
1210 * The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
1211 */
1212 Sound?: __string;
1213 /**
1214 * The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
1215 */
1216 Title?: __string;
1217 /**
1218 * The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
1219 */
1220 Url?: __string;
1221 }
1222 export interface APNSSandboxChannelRequest {
1223 /**
1224 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1225 */
1226 BundleId?: __string;
1227 /**
1228 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
1229 */
1230 Certificate?: __string;
1231 /**
1232 * The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
1233 */
1234 DefaultAuthenticationMethod?: __string;
1235 /**
1236 * Specifies whether to enable the APNs sandbox channel for the application.
1237 */
1238 Enabled?: __boolean;
1239 /**
1240 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
1241 */
1242 PrivateKey?: __string;
1243 /**
1244 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1245 */
1246 TeamId?: __string;
1247 /**
1248 * The authentication key to use for APNs tokens.
1249 */
1250 TokenKey?: __string;
1251 /**
1252 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
1253 */
1254 TokenKeyId?: __string;
1255 }
1256 export interface APNSSandboxChannelResponse {
1257 /**
1258 * The unique identifier for the application that the APNs sandbox channel applies to.
1259 */
1260 ApplicationId?: __string;
1261 /**
1262 * The date and time when the APNs sandbox channel was enabled.
1263 */
1264 CreationDate?: __string;
1265 /**
1266 * The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
1267 */
1268 DefaultAuthenticationMethod?: __string;
1269 /**
1270 * Specifies whether the APNs sandbox channel is enabled for the application.
1271 */
1272 Enabled?: __boolean;
1273 /**
1274 * (Not used) This property is retained only for backward compatibility.
1275 */
1276 HasCredential?: __boolean;
1277 /**
1278 * Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
1279 */
1280 HasTokenKey?: __boolean;
1281 /**
1282 * (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
1283 */
1284 Id?: __string;
1285 /**
1286 * Specifies whether the APNs sandbox channel is archived.
1287 */
1288 IsArchived?: __boolean;
1289 /**
1290 * The user who last modified the APNs sandbox channel.
1291 */
1292 LastModifiedBy?: __string;
1293 /**
1294 * The date and time when the APNs sandbox channel was last modified.
1295 */
1296 LastModifiedDate?: __string;
1297 /**
1298 * The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
1299 */
1300 Platform: __string;
1301 /**
1302 * The current version of the APNs sandbox channel.
1303 */
1304 Version?: __integer;
1305 }
1306 export interface APNSVoipChannelRequest {
1307 /**
1308 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1309 */
1310 BundleId?: __string;
1311 /**
1312 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
1313 */
1314 Certificate?: __string;
1315 /**
1316 * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
1317 */
1318 DefaultAuthenticationMethod?: __string;
1319 /**
1320 * Specifies whether to enable the APNs VoIP channel for the application.
1321 */
1322 Enabled?: __boolean;
1323 /**
1324 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
1325 */
1326 PrivateKey?: __string;
1327 /**
1328 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1329 */
1330 TeamId?: __string;
1331 /**
1332 * The authentication key to use for APNs tokens.
1333 */
1334 TokenKey?: __string;
1335 /**
1336 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
1337 */
1338 TokenKeyId?: __string;
1339 }
1340 export interface APNSVoipChannelResponse {
1341 /**
1342 * The unique identifier for the application that the APNs VoIP channel applies to.
1343 */
1344 ApplicationId?: __string;
1345 /**
1346 * The date and time when the APNs VoIP channel was enabled.
1347 */
1348 CreationDate?: __string;
1349 /**
1350 * The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
1351 */
1352 DefaultAuthenticationMethod?: __string;
1353 /**
1354 * Specifies whether the APNs VoIP channel is enabled for the application.
1355 */
1356 Enabled?: __boolean;
1357 /**
1358 * (Not used) This property is retained only for backward compatibility.
1359 */
1360 HasCredential?: __boolean;
1361 /**
1362 * Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
1363 */
1364 HasTokenKey?: __boolean;
1365 /**
1366 * (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
1367 */
1368 Id?: __string;
1369 /**
1370 * Specifies whether the APNs VoIP channel is archived.
1371 */
1372 IsArchived?: __boolean;
1373 /**
1374 * The user who last modified the APNs VoIP channel.
1375 */
1376 LastModifiedBy?: __string;
1377 /**
1378 * The date and time when the APNs VoIP channel was last modified.
1379 */
1380 LastModifiedDate?: __string;
1381 /**
1382 * The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
1383 */
1384 Platform: __string;
1385 /**
1386 * The current version of the APNs VoIP channel.
1387 */
1388 Version?: __integer;
1389 }
1390 export interface APNSVoipSandboxChannelRequest {
1391 /**
1392 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1393 */
1394 BundleId?: __string;
1395 /**
1396 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
1397 */
1398 Certificate?: __string;
1399 /**
1400 * The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
1401 */
1402 DefaultAuthenticationMethod?: __string;
1403 /**
1404 * Specifies whether the APNs VoIP sandbox channel is enabled for the application.
1405 */
1406 Enabled?: __boolean;
1407 /**
1408 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
1409 */
1410 PrivateKey?: __string;
1411 /**
1412 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1413 */
1414 TeamId?: __string;
1415 /**
1416 * The authentication key to use for APNs tokens.
1417 */
1418 TokenKey?: __string;
1419 /**
1420 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
1421 */
1422 TokenKeyId?: __string;
1423 }
1424 export interface APNSVoipSandboxChannelResponse {
1425 /**
1426 * The unique identifier for the application that the APNs VoIP sandbox channel applies to.
1427 */
1428 ApplicationId?: __string;
1429 /**
1430 * The date and time when the APNs VoIP sandbox channel was enabled.
1431 */
1432 CreationDate?: __string;
1433 /**
1434 * The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
1435 */
1436 DefaultAuthenticationMethod?: __string;
1437 /**
1438 * Specifies whether the APNs VoIP sandbox channel is enabled for the application.
1439 */
1440 Enabled?: __boolean;
1441 /**
1442 * (Not used) This property is retained only for backward compatibility.
1443 */
1444 HasCredential?: __boolean;
1445 /**
1446 * Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
1447 */
1448 HasTokenKey?: __boolean;
1449 /**
1450 * (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
1451 */
1452 Id?: __string;
1453 /**
1454 * Specifies whether the APNs VoIP sandbox channel is archived.
1455 */
1456 IsArchived?: __boolean;
1457 /**
1458 * The user who last modified the APNs VoIP sandbox channel.
1459 */
1460 LastModifiedBy?: __string;
1461 /**
1462 * The date and time when the APNs VoIP sandbox channel was last modified.
1463 */
1464 LastModifiedDate?: __string;
1465 /**
1466 * The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
1467 */
1468 Platform: __string;
1469 /**
1470 * The current version of the APNs VoIP sandbox channel.
1471 */
1472 Version?: __integer;
1473 }
1474 export type Action = "OPEN_APP"|"DEEP_LINK"|"URL"|string;
1475 export interface ActivitiesResponse {
1476 /**
1477 * An array of responses, one for each activity that was performed by the campaign.
1478 */
1479 Item: ListOfActivityResponse;
1480 /**
1481 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
1482 */
1483 NextToken?: __string;
1484 }
1485 export interface Activity {
1486 /**
1487 * The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
1488 */
1489 ConditionalSplit?: ConditionalSplitActivity;
1490 /**
1491 * The custom description of the activity.
1492 */
1493 Description?: __string;
1494 /**
1495 * The settings for an email activity. This type of activity sends an email message to participants.
1496 */
1497 EMAIL?: EmailMessageActivity;
1498 /**
1499 * The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
1500 */
1501 Holdout?: HoldoutActivity;
1502 /**
1503 * The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
1504 */
1505 MultiCondition?: MultiConditionalSplitActivity;
1506 /**
1507 * The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
1508 */
1509 RandomSplit?: RandomSplitActivity;
1510 /**
1511 * The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
1512 */
1513 Wait?: WaitActivity;
1514 }
1515 export interface ActivityResponse {
1516 /**
1517 * The unique identifier for the application that the campaign applies to.
1518 */
1519 ApplicationId: __string;
1520 /**
1521 * The unique identifier for the campaign that the activity applies to.
1522 */
1523 CampaignId: __string;
1524 /**
1525 * The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
1526 */
1527 End?: __string;
1528 /**
1529 * The unique identifier for the activity.
1530 */
1531 Id: __string;
1532 /**
1533 * Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
1534 */
1535 Result?: __string;
1536 /**
1537 * The scheduled start time, in ISO 8601 format, for the activity.
1538 */
1539 ScheduledStart?: __string;
1540 /**
1541 * The actual start time, in ISO 8601 format, of the activity.
1542 */
1543 Start?: __string;
1544 /**
1545 * The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
1546 */
1547 State?: __string;
1548 /**
1549 * The total number of endpoints that the campaign successfully delivered messages to.
1550 */
1551 SuccessfulEndpointCount?: __integer;
1552 /**
1553 * The total number of time zones that were completed.
1554 */
1555 TimezonesCompletedCount?: __integer;
1556 /**
1557 * The total number of unique time zones that are in the segment for the campaign.
1558 */
1559 TimezonesTotalCount?: __integer;
1560 /**
1561 * The total number of endpoints that the campaign attempted to deliver messages to.
1562 */
1563 TotalEndpointCount?: __integer;
1564 /**
1565 * The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
1566 */
1567 TreatmentId?: __string;
1568 }
1569 export interface AddressConfiguration {
1570 /**
1571 * The message body to use instead of the default message body. This value overrides the default message body.
1572 */
1573 BodyOverride?: __string;
1574 /**
1575 * The channel to use when sending the message.
1576 */
1577 ChannelType?: ChannelType;
1578 /**
1579 * An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
1580 */
1581 Context?: MapOf__string;
1582 /**
1583 * The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
1584 */
1585 RawContent?: __string;
1586 /**
1587 * A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
1588 */
1589 Substitutions?: MapOfListOf__string;
1590 /**
1591 * The message title to use instead of the default message title. This value overrides the default message title.
1592 */
1593 TitleOverride?: __string;
1594 }
1595 export interface AndroidPushNotificationTemplate {
1596 /**
1597 * The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
1598 */
1599 Action?: Action;
1600 /**
1601 * The message body to use in a push notification that's based on the message template.
1602 */
1603 Body?: __string;
1604 /**
1605 * The URL of the large icon image to display in the content view of a push notification that's based on the message template.
1606 */
1607 ImageIconUrl?: __string;
1608 /**
1609 * The URL of an image to display in a push notification that's based on the message template.
1610 */
1611 ImageUrl?: __string;
1612 /**
1613 * The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
1614 */
1615 RawContent?: __string;
1616 /**
1617 * The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
1618 */
1619 SmallImageIconUrl?: __string;
1620 /**
1621 * The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
1622 */
1623 Sound?: __string;
1624 /**
1625 * The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
1626 */
1627 Title?: __string;
1628 /**
1629 * The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
1630 */
1631 Url?: __string;
1632 }
1633 export interface ApplicationDateRangeKpiResponse {
1634 /**
1635 * The unique identifier for the application that the metric applies to.
1636 */
1637 ApplicationId: __string;
1638 /**
1639 * The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
1640 */
1641 EndTime: __timestampIso8601;
1642 /**
1643 * The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
1644 */
1645 KpiName: __string;
1646 /**
1647 * An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
1648 */
1649 KpiResult: BaseKpiResult;
1650 /**
1651 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.
1652 */
1653 NextToken?: __string;
1654 /**
1655 * The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
1656 */
1657 StartTime: __timestampIso8601;
1658 }
1659 export interface ApplicationResponse {
1660 /**
1661 * The Amazon Resource Name (ARN) of the application.
1662 */
1663 Arn: __string;
1664 /**
1665 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1666 */
1667 Id: __string;
1668 /**
1669 * The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
1670 */
1671 Name: __string;
1672 /**
1673 * A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
1674 */
1675 tags?: MapOf__string;
1676 }
1677 export interface ApplicationSettingsResource {
1678 /**
1679 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1680 */
1681 ApplicationId: __string;
1682 /**
1683 * The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
1684 */
1685 CampaignHook?: CampaignHook;
1686 /**
1687 * The date and time, in ISO 8601 format, when the application's settings were last modified.
1688 */
1689 LastModifiedDate?: __string;
1690 /**
1691 * The default sending limits for campaigns in the application.
1692 */
1693 Limits?: CampaignLimits;
1694 /**
1695 * The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
1696 */
1697 QuietTime?: QuietTime;
1698 }
1699 export interface ApplicationsResponse {
1700 /**
1701 * An array of responses, one for each application that was returned.
1702 */
1703 Item?: ListOfApplicationResponse;
1704 /**
1705 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
1706 */
1707 NextToken?: __string;
1708 }
1709 export interface AttributeDimension {
1710 /**
1711 * The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
1712 */
1713 AttributeType?: AttributeType;
1714 /**
1715 * The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
1716 */
1717 Values: ListOf__string;
1718 }
1719 export type AttributeType = "INCLUSIVE"|"EXCLUSIVE"|string;
1720 export interface AttributesResource {
1721 /**
1722 * The unique identifier for the application.
1723 */
1724 ApplicationId: __string;
1725 /**
1726 * The type of attribute or attributes that were removed from the endpoints. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints. endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints. endpoint-user-attributes - Custom attributes that describe users.
1727 */
1728 AttributeType: __string;
1729 /**
1730 * An array that specifies the names of the attributes that were removed from the endpoints.
1731 */
1732 Attributes?: ListOf__string;
1733 }
1734 export interface BaiduChannelRequest {
1735 /**
1736 * The API key that you received from the Baidu Cloud Push service to communicate with the service.
1737 */
1738 ApiKey: __string;
1739 /**
1740 * Specifies whether to enable the Baidu channel for the application.
1741 */
1742 Enabled?: __boolean;
1743 /**
1744 * The secret key that you received from the Baidu Cloud Push service to communicate with the service.
1745 */
1746 SecretKey: __string;
1747 }
1748 export interface BaiduChannelResponse {
1749 /**
1750 * The unique identifier for the application that the Baidu channel applies to.
1751 */
1752 ApplicationId?: __string;
1753 /**
1754 * The date and time when the Baidu channel was enabled.
1755 */
1756 CreationDate?: __string;
1757 /**
1758 * The API key that you received from the Baidu Cloud Push service to communicate with the service.
1759 */
1760 Credential: __string;
1761 /**
1762 * Specifies whether the Baidu channel is enabled for the application.
1763 */
1764 Enabled?: __boolean;
1765 /**
1766 * (Not used) This property is retained only for backward compatibility.
1767 */
1768 HasCredential?: __boolean;
1769 /**
1770 * (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
1771 */
1772 Id?: __string;
1773 /**
1774 * Specifies whether the Baidu channel is archived.
1775 */
1776 IsArchived?: __boolean;
1777 /**
1778 * The user who last modified the Baidu channel.
1779 */
1780 LastModifiedBy?: __string;
1781 /**
1782 * The date and time when the Baidu channel was last modified.
1783 */
1784 LastModifiedDate?: __string;
1785 /**
1786 * The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
1787 */
1788 Platform: __string;
1789 /**
1790 * The current version of the Baidu channel.
1791 */
1792 Version?: __integer;
1793 }
1794 export interface BaiduMessage {
1795 /**
1796 * The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
1797 */
1798 Action?: Action;
1799 /**
1800 * The body of the notification message.
1801 */
1802 Body?: __string;
1803 /**
1804 * The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
1805 */
1806 Data?: MapOf__string;
1807 /**
1808 * The icon image name of the asset saved in your app.
1809 */
1810 IconReference?: __string;
1811 /**
1812 * The URL of the large icon image to display in the content view of the push notification.
1813 */
1814 ImageIconUrl?: __string;
1815 /**
1816 * The URL of an image to display in the push notification.
1817 */
1818 ImageUrl?: __string;
1819 /**
1820 * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
1821 */
1822 RawContent?: __string;
1823 /**
1824 * Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
1825 */
1826 SilentPush?: __boolean;
1827 /**
1828 * The URL of the small icon image to display in the status bar and the content view of the push notification.
1829 */
1830 SmallImageIconUrl?: __string;
1831 /**
1832 * The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
1833 */
1834 Sound?: __string;
1835 /**
1836 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
1837 */
1838 Substitutions?: MapOfListOf__string;
1839 /**
1840 * The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
1841 */
1842 TimeToLive?: __integer;
1843 /**
1844 * The title to display above the notification message on the recipient's device.
1845 */
1846 Title?: __string;
1847 /**
1848 * The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
1849 */
1850 Url?: __string;
1851 }
1852 export interface BaseKpiResult {
1853 /**
1854 * An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
1855 */
1856 Rows: ListOfResultRow;
1857 }
1858 export interface CampaignDateRangeKpiResponse {
1859 /**
1860 * The unique identifier for the application that the metric applies to.
1861 */
1862 ApplicationId: __string;
1863 /**
1864 * The unique identifier for the campaign that the metric applies to.
1865 */
1866 CampaignId: __string;
1867 /**
1868 * The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
1869 */
1870 EndTime: __timestampIso8601;
1871 /**
1872 * The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
1873 */
1874 KpiName: __string;
1875 /**
1876 * An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
1877 */
1878 KpiResult: BaseKpiResult;
1879 /**
1880 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
1881 */
1882 NextToken?: __string;
1883 /**
1884 * The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
1885 */
1886 StartTime: __timestampIso8601;
1887 }
1888 export interface CampaignEmailMessage {
1889 /**
1890 * The body of the email for recipients whose email clients don't render HTML content.
1891 */
1892 Body?: __string;
1893 /**
1894 * The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
1895 */
1896 FromAddress?: __string;
1897 /**
1898 * The body of the email, in HTML format, for recipients whose email clients render HTML content.
1899 */
1900 HtmlBody?: __string;
1901 /**
1902 * The subject line, or title, of the email.
1903 */
1904 Title?: __string;
1905 }
1906 export interface CampaignEventFilter {
1907 /**
1908 * The dimension settings of the event filter for the campaign.
1909 */
1910 Dimensions: EventDimensions;
1911 /**
1912 * The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.
1913 */
1914 FilterType: FilterType;
1915 }
1916 export interface CampaignHook {
1917 /**
1918 * The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
1919 */
1920 LambdaFunctionName?: __string;
1921 /**
1922 * Specifies which Lambda mode to use when invoking the AWS Lambda function.
1923 */
1924 Mode?: Mode;
1925 /**
1926 * The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
1927 */
1928 WebUrl?: __string;
1929 }
1930 export interface CampaignLimits {
1931 /**
1932 * The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
1933 */
1934 Daily?: __integer;
1935 /**
1936 * The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
1937 */
1938 MaximumDuration?: __integer;
1939 /**
1940 * The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
1941 */
1942 MessagesPerSecond?: __integer;
1943 /**
1944 * The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
1945 */
1946 Total?: __integer;
1947 }
1948 export interface CampaignResponse {
1949 /**
1950 * An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
1951 */
1952 AdditionalTreatments?: ListOfTreatmentResource;
1953 /**
1954 * The unique identifier for the application that the campaign applies to.
1955 */
1956 ApplicationId: __string;
1957 /**
1958 * The Amazon Resource Name (ARN) of the campaign.
1959 */
1960 Arn: __string;
1961 /**
1962 * The date, in ISO 8601 format, when the campaign was created.
1963 */
1964 CreationDate: __string;
1965 /**
1966 * The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
1967 */
1968 DefaultState?: CampaignState;
1969 /**
1970 * The custom description of the campaign.
1971 */
1972 Description?: __string;
1973 /**
1974 * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
1975 */
1976 HoldoutPercent?: __integer;
1977 /**
1978 * The settings for the AWS Lambda function to use as a code hook for the campaign.
1979 */
1980 Hook?: CampaignHook;
1981 /**
1982 * The unique identifier for the campaign.
1983 */
1984 Id: __string;
1985 /**
1986 * Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
1987 */
1988 IsPaused?: __boolean;
1989 /**
1990 * The date, in ISO 8601 format, when the campaign was last modified.
1991 */
1992 LastModifiedDate: __string;
1993 /**
1994 * The messaging limits for the campaign.
1995 */
1996 Limits?: CampaignLimits;
1997 /**
1998 * The message configuration settings for the campaign.
1999 */
2000 MessageConfiguration?: MessageConfiguration;
2001 /**
2002 * The name of the campaign.
2003 */
2004 Name?: __string;
2005 /**
2006 * The schedule settings for the campaign.
2007 */
2008 Schedule?: Schedule;
2009 /**
2010 * The unique identifier for the segment that's associated with the campaign.
2011 */
2012 SegmentId: __string;
2013 /**
2014 * The version number of the segment that's associated with the campaign.
2015 */
2016 SegmentVersion: __integer;
2017 /**
2018 * The current status of the campaign.
2019 */
2020 State?: CampaignState;
2021 /**
2022 * A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
2023 */
2024 tags?: MapOf__string;
2025 /**
2026 * The message template that’s used for the campaign.
2027 */
2028 TemplateConfiguration?: TemplateConfiguration;
2029 /**
2030 * The custom description of a variation of the campaign that's used for A/B testing.
2031 */
2032 TreatmentDescription?: __string;
2033 /**
2034 * The custom name of a variation of the campaign that's used for A/B testing.
2035 */
2036 TreatmentName?: __string;
2037 /**
2038 * The version number of the campaign.
2039 */
2040 Version?: __integer;
2041 }
2042 export interface CampaignSmsMessage {
2043 /**
2044 * The body of the SMS message.
2045 */
2046 Body?: __string;
2047 /**
2048 * The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
2049 */
2050 MessageType?: MessageType;
2051 /**
2052 * The sender ID to display on recipients' devices when they receive the SMS message.
2053 */
2054 SenderId?: __string;
2055 }
2056 export interface CampaignState {
2057 /**
2058 * The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.
2059 */
2060 CampaignStatus?: CampaignStatus;
2061 }
2062 export type CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|string;
2063 export interface CampaignsResponse {
2064 /**
2065 * An array of responses, one for each campaign that's associated with the application.
2066 */
2067 Item: ListOfCampaignResponse;
2068 /**
2069 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
2070 */
2071 NextToken?: __string;
2072 }
2073 export interface ChannelResponse {
2074 /**
2075 * The unique identifier for the application.
2076 */
2077 ApplicationId?: __string;
2078 /**
2079 * The date and time, in ISO 8601 format, when the channel was enabled.
2080 */
2081 CreationDate?: __string;
2082 /**
2083 * Specifies whether the channel is enabled for the application.
2084 */
2085 Enabled?: __boolean;
2086 /**
2087 * (Not used) This property is retained only for backward compatibility.
2088 */
2089 HasCredential?: __boolean;
2090 /**
2091 * (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
2092 */
2093 Id?: __string;
2094 /**
2095 * Specifies whether the channel is archived.
2096 */
2097 IsArchived?: __boolean;
2098 /**
2099 * The user who last modified the channel.
2100 */
2101 LastModifiedBy?: __string;
2102 /**
2103 * The date and time, in ISO 8601 format, when the channel was last modified.
2104 */
2105 LastModifiedDate?: __string;
2106 /**
2107 * The current version of the channel.
2108 */
2109 Version?: __integer;
2110 }
2111 export type ChannelType = "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
2112 export interface ChannelsResponse {
2113 /**
2114 * A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
2115 */
2116 Channels: MapOfChannelResponse;
2117 }
2118 export interface Condition {
2119 /**
2120 * The conditions to evaluate for the activity.
2121 */
2122 Conditions?: ListOfSimpleCondition;
2123 /**
2124 * Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
2125 */
2126 Operator?: Operator;
2127 }
2128 export interface ConditionalSplitActivity {
2129 /**
2130 * The conditions that define the paths for the activity, and the relationship between the conditions.
2131 */
2132 Condition?: Condition;
2133 /**
2134 * The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
2135 */
2136 EvaluationWaitTime?: WaitTime;
2137 /**
2138 * The unique identifier for the activity to perform if the conditions aren't met.
2139 */
2140 FalseActivity?: __string;
2141 /**
2142 * The unique identifier for the activity to perform if the conditions are met.
2143 */
2144 TrueActivity?: __string;
2145 }
2146 export interface CreateAppRequest {
2147 CreateApplicationRequest: CreateApplicationRequest;
2148 }
2149 export interface CreateAppResponse {
2150 ApplicationResponse: ApplicationResponse;
2151 }
2152 export interface CreateApplicationRequest {
2153 /**
2154 * The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
2155 */
2156 Name: __string;
2157 /**
2158 * A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
2159 */
2160 tags?: MapOf__string;
2161 }
2162 export interface CreateCampaignRequest {
2163 /**
2164 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2165 */
2166 ApplicationId: __string;
2167 WriteCampaignRequest: WriteCampaignRequest;
2168 }
2169 export interface CreateCampaignResponse {
2170 CampaignResponse: CampaignResponse;
2171 }
2172 export interface CreateEmailTemplateRequest {
2173 EmailTemplateRequest: EmailTemplateRequest;
2174 /**
2175 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2176 */
2177 TemplateName: __string;
2178 }
2179 export interface CreateEmailTemplateResponse {
2180 CreateTemplateMessageBody: CreateTemplateMessageBody;
2181 }
2182 export interface CreateExportJobRequest {
2183 /**
2184 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2185 */
2186 ApplicationId: __string;
2187 ExportJobRequest: ExportJobRequest;
2188 }
2189 export interface CreateExportJobResponse {
2190 ExportJobResponse: ExportJobResponse;
2191 }
2192 export interface CreateImportJobRequest {
2193 /**
2194 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2195 */
2196 ApplicationId: __string;
2197 ImportJobRequest: ImportJobRequest;
2198 }
2199 export interface CreateImportJobResponse {
2200 ImportJobResponse: ImportJobResponse;
2201 }
2202 export interface CreateJourneyRequest {
2203 /**
2204 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2205 */
2206 ApplicationId: __string;
2207 WriteJourneyRequest: WriteJourneyRequest;
2208 }
2209 export interface CreateJourneyResponse {
2210 JourneyResponse: JourneyResponse;
2211 }
2212 export interface CreatePushTemplateRequest {
2213 PushNotificationTemplateRequest: PushNotificationTemplateRequest;
2214 /**
2215 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2216 */
2217 TemplateName: __string;
2218 }
2219 export interface CreatePushTemplateResponse {
2220 CreateTemplateMessageBody: CreateTemplateMessageBody;
2221 }
2222 export interface CreateRecommenderConfiguration {
2223 /**
2224 * A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names: An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique. An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.
2225 */
2226 Attributes?: MapOf__string;
2227 /**
2228 * A custom description of the configuration for the recommender model. The description can contain up to 128 characters.
2229 */
2230 Description?: __string;
2231 /**
2232 * A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
2233 */
2234 Name?: __string;
2235 /**
2236 * The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are: PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
2237 */
2238 RecommendationProviderIdType?: __string;
2239 /**
2240 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
2241 */
2242 RecommendationProviderRoleArn: __string;
2243 /**
2244 * The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
2245 */
2246 RecommendationProviderUri: __string;
2247 /**
2248 * The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
2249 */
2250 RecommendationTransformerUri?: __string;
2251 /**
2252 * A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data. This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
2253 */
2254 RecommendationsDisplayName?: __string;
2255 /**
2256 * The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5. To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
2257 */
2258 RecommendationsPerMessage?: __integer;
2259 }
2260 export interface CreateRecommenderConfigurationRequest {
2261 CreateRecommenderConfiguration: CreateRecommenderConfiguration;
2262 }
2263 export interface CreateRecommenderConfigurationResponse {
2264 RecommenderConfigurationResponse: RecommenderConfigurationResponse;
2265 }
2266 export interface CreateSegmentRequest {
2267 /**
2268 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2269 */
2270 ApplicationId: __string;
2271 WriteSegmentRequest: WriteSegmentRequest;
2272 }
2273 export interface CreateSegmentResponse {
2274 SegmentResponse: SegmentResponse;
2275 }
2276 export interface CreateSmsTemplateRequest {
2277 SMSTemplateRequest: SMSTemplateRequest;
2278 /**
2279 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2280 */
2281 TemplateName: __string;
2282 }
2283 export interface CreateSmsTemplateResponse {
2284 CreateTemplateMessageBody: CreateTemplateMessageBody;
2285 }
2286 export interface CreateTemplateMessageBody {
2287 /**
2288 * The Amazon Resource Name (ARN) of the message template that was created.
2289 */
2290 Arn?: __string;
2291 /**
2292 * The message that's returned from the API for the request to create the message template.
2293 */
2294 Message?: __string;
2295 /**
2296 * The unique identifier for the request to create the message template.
2297 */
2298 RequestID?: __string;
2299 }
2300 export interface CreateVoiceTemplateRequest {
2301 /**
2302 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2303 */
2304 TemplateName: __string;
2305 VoiceTemplateRequest: VoiceTemplateRequest;
2306 }
2307 export interface CreateVoiceTemplateResponse {
2308 CreateTemplateMessageBody: CreateTemplateMessageBody;
2309 }
2310 export interface DefaultMessage {
2311 /**
2312 * The default body of the message.
2313 */
2314 Body?: __string;
2315 /**
2316 * The default message variables to use in the message. You can override these default variables with individual address variables.
2317 */
2318 Substitutions?: MapOfListOf__string;
2319 }
2320 export interface DefaultPushNotificationMessage {
2321 /**
2322 * The default action to occur if a recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
2323 */
2324 Action?: Action;
2325 /**
2326 * The default body of the notification message.
2327 */
2328 Body?: __string;
2329 /**
2330 * The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
2331 */
2332 Data?: MapOf__string;
2333 /**
2334 * Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
2335 */
2336 SilentPush?: __boolean;
2337 /**
2338 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
2339 */
2340 Substitutions?: MapOfListOf__string;
2341 /**
2342 * The default title to display above the notification message on a recipient's device.
2343 */
2344 Title?: __string;
2345 /**
2346 * The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
2347 */
2348 Url?: __string;
2349 }
2350 export interface DefaultPushNotificationTemplate {
2351 /**
2352 * The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
2353 */
2354 Action?: Action;
2355 /**
2356 * The message body to use in push notifications that are based on the message template.
2357 */
2358 Body?: __string;
2359 /**
2360 * The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
2361 */
2362 Sound?: __string;
2363 /**
2364 * The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
2365 */
2366 Title?: __string;
2367 /**
2368 * The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
2369 */
2370 Url?: __string;
2371 }
2372 export interface DeleteAdmChannelRequest {
2373 /**
2374 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2375 */
2376 ApplicationId: __string;
2377 }
2378 export interface DeleteAdmChannelResponse {
2379 ADMChannelResponse: ADMChannelResponse;
2380 }
2381 export interface DeleteApnsChannelRequest {
2382 /**
2383 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2384 */
2385 ApplicationId: __string;
2386 }
2387 export interface DeleteApnsChannelResponse {
2388 APNSChannelResponse: APNSChannelResponse;
2389 }
2390 export interface DeleteApnsSandboxChannelRequest {
2391 /**
2392 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2393 */
2394 ApplicationId: __string;
2395 }
2396 export interface DeleteApnsSandboxChannelResponse {
2397 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
2398 }
2399 export interface DeleteApnsVoipChannelRequest {
2400 /**
2401 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2402 */
2403 ApplicationId: __string;
2404 }
2405 export interface DeleteApnsVoipChannelResponse {
2406 APNSVoipChannelResponse: APNSVoipChannelResponse;
2407 }
2408 export interface DeleteApnsVoipSandboxChannelRequest {
2409 /**
2410 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2411 */
2412 ApplicationId: __string;
2413 }
2414 export interface DeleteApnsVoipSandboxChannelResponse {
2415 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
2416 }
2417 export interface DeleteAppRequest {
2418 /**
2419 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2420 */
2421 ApplicationId: __string;
2422 }
2423 export interface DeleteAppResponse {
2424 ApplicationResponse: ApplicationResponse;
2425 }
2426 export interface DeleteBaiduChannelRequest {
2427 /**
2428 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2429 */
2430 ApplicationId: __string;
2431 }
2432 export interface DeleteBaiduChannelResponse {
2433 BaiduChannelResponse: BaiduChannelResponse;
2434 }
2435 export interface DeleteCampaignRequest {
2436 /**
2437 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2438 */
2439 ApplicationId: __string;
2440 /**
2441 * The unique identifier for the campaign.
2442 */
2443 CampaignId: __string;
2444 }
2445 export interface DeleteCampaignResponse {
2446 CampaignResponse: CampaignResponse;
2447 }
2448 export interface DeleteEmailChannelRequest {
2449 /**
2450 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2451 */
2452 ApplicationId: __string;
2453 }
2454 export interface DeleteEmailChannelResponse {
2455 EmailChannelResponse: EmailChannelResponse;
2456 }
2457 export interface DeleteEmailTemplateRequest {
2458 /**
2459 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2460 */
2461 TemplateName: __string;
2462 /**
2463 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
2464 */
2465 Version?: __string;
2466 }
2467 export interface DeleteEmailTemplateResponse {
2468 MessageBody: MessageBody;
2469 }
2470 export interface DeleteEndpointRequest {
2471 /**
2472 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2473 */
2474 ApplicationId: __string;
2475 /**
2476 * The unique identifier for the endpoint.
2477 */
2478 EndpointId: __string;
2479 }
2480 export interface DeleteEndpointResponse {
2481 EndpointResponse: EndpointResponse;
2482 }
2483 export interface DeleteEventStreamRequest {
2484 /**
2485 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2486 */
2487 ApplicationId: __string;
2488 }
2489 export interface DeleteEventStreamResponse {
2490 EventStream: EventStream;
2491 }
2492 export interface DeleteGcmChannelRequest {
2493 /**
2494 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2495 */
2496 ApplicationId: __string;
2497 }
2498 export interface DeleteGcmChannelResponse {
2499 GCMChannelResponse: GCMChannelResponse;
2500 }
2501 export interface DeleteJourneyRequest {
2502 /**
2503 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2504 */
2505 ApplicationId: __string;
2506 /**
2507 * The unique identifier for the journey.
2508 */
2509 JourneyId: __string;
2510 }
2511 export interface DeleteJourneyResponse {
2512 JourneyResponse: JourneyResponse;
2513 }
2514 export interface DeletePushTemplateRequest {
2515 /**
2516 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2517 */
2518 TemplateName: __string;
2519 /**
2520 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
2521 */
2522 Version?: __string;
2523 }
2524 export interface DeletePushTemplateResponse {
2525 MessageBody: MessageBody;
2526 }
2527 export interface DeleteRecommenderConfigurationRequest {
2528 /**
2529 * The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
2530 */
2531 RecommenderId: __string;
2532 }
2533 export interface DeleteRecommenderConfigurationResponse {
2534 RecommenderConfigurationResponse: RecommenderConfigurationResponse;
2535 }
2536 export interface DeleteSegmentRequest {
2537 /**
2538 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2539 */
2540 ApplicationId: __string;
2541 /**
2542 * The unique identifier for the segment.
2543 */
2544 SegmentId: __string;
2545 }
2546 export interface DeleteSegmentResponse {
2547 SegmentResponse: SegmentResponse;
2548 }
2549 export interface DeleteSmsChannelRequest {
2550 /**
2551 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2552 */
2553 ApplicationId: __string;
2554 }
2555 export interface DeleteSmsChannelResponse {
2556 SMSChannelResponse: SMSChannelResponse;
2557 }
2558 export interface DeleteSmsTemplateRequest {
2559 /**
2560 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2561 */
2562 TemplateName: __string;
2563 /**
2564 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
2565 */
2566 Version?: __string;
2567 }
2568 export interface DeleteSmsTemplateResponse {
2569 MessageBody: MessageBody;
2570 }
2571 export interface DeleteUserEndpointsRequest {
2572 /**
2573 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2574 */
2575 ApplicationId: __string;
2576 /**
2577 * The unique identifier for the user.
2578 */
2579 UserId: __string;
2580 }
2581 export interface DeleteUserEndpointsResponse {
2582 EndpointsResponse: EndpointsResponse;
2583 }
2584 export interface DeleteVoiceChannelRequest {
2585 /**
2586 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2587 */
2588 ApplicationId: __string;
2589 }
2590 export interface DeleteVoiceChannelResponse {
2591 VoiceChannelResponse: VoiceChannelResponse;
2592 }
2593 export interface DeleteVoiceTemplateRequest {
2594 /**
2595 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
2596 */
2597 TemplateName: __string;
2598 /**
2599 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
2600 */
2601 Version?: __string;
2602 }
2603 export interface DeleteVoiceTemplateResponse {
2604 MessageBody: MessageBody;
2605 }
2606 export type DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE"|string;
2607 export type DimensionType = "INCLUSIVE"|"EXCLUSIVE"|string;
2608 export interface DirectMessageConfiguration {
2609 /**
2610 * The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2611 */
2612 ADMMessage?: ADMMessage;
2613 /**
2614 * The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2615 */
2616 APNSMessage?: APNSMessage;
2617 /**
2618 * The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2619 */
2620 BaiduMessage?: BaiduMessage;
2621 /**
2622 * The default message for all channels.
2623 */
2624 DefaultMessage?: DefaultMessage;
2625 /**
2626 * The default push notification message for all push notification channels.
2627 */
2628 DefaultPushNotificationMessage?: DefaultPushNotificationMessage;
2629 /**
2630 * The default message for the email channel. This message overrides the default message (DefaultMessage).
2631 */
2632 EmailMessage?: EmailMessage;
2633 /**
2634 * The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
2635 */
2636 GCMMessage?: GCMMessage;
2637 /**
2638 * The default message for the SMS channel. This message overrides the default message (DefaultMessage).
2639 */
2640 SMSMessage?: SMSMessage;
2641 /**
2642 * The default message for the voice channel. This message overrides the default message (DefaultMessage).
2643 */
2644 VoiceMessage?: VoiceMessage;
2645 }
2646 export type Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30"|string;
2647 export interface EmailChannelRequest {
2648 /**
2649 * The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.
2650 */
2651 ConfigurationSet?: __string;
2652 /**
2653 * Specifies whether to enable the email channel for the application.
2654 */
2655 Enabled?: __boolean;
2656 /**
2657 * The verified email address that you want to send email from when you send email through the channel.
2658 */
2659 FromAddress: __string;
2660 /**
2661 * The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
2662 */
2663 Identity: __string;
2664 /**
2665 * The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
2666 */
2667 RoleArn?: __string;
2668 }
2669 export interface EmailChannelResponse {
2670 /**
2671 * The unique identifier for the application that the email channel applies to.
2672 */
2673 ApplicationId?: __string;
2674 /**
2675 * The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.
2676 */
2677 ConfigurationSet?: __string;
2678 /**
2679 * The date and time, in ISO 8601 format, when the email channel was enabled.
2680 */
2681 CreationDate?: __string;
2682 /**
2683 * Specifies whether the email channel is enabled for the application.
2684 */
2685 Enabled?: __boolean;
2686 /**
2687 * The verified email address that you send email from when you send email through the channel.
2688 */
2689 FromAddress?: __string;
2690 /**
2691 * (Not used) This property is retained only for backward compatibility.
2692 */
2693 HasCredential?: __boolean;
2694 /**
2695 * (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
2696 */
2697 Id?: __string;
2698 /**
2699 * The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
2700 */
2701 Identity?: __string;
2702 /**
2703 * Specifies whether the email channel is archived.
2704 */
2705 IsArchived?: __boolean;
2706 /**
2707 * The user who last modified the email channel.
2708 */
2709 LastModifiedBy?: __string;
2710 /**
2711 * The date and time, in ISO 8601 format, when the email channel was last modified.
2712 */
2713 LastModifiedDate?: __string;
2714 /**
2715 * The maximum number of emails that you can send through the channel each second.
2716 */
2717 MessagesPerSecond?: __integer;
2718 /**
2719 * The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
2720 */
2721 Platform: __string;
2722 /**
2723 * The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
2724 */
2725 RoleArn?: __string;
2726 /**
2727 * The current version of the email channel.
2728 */
2729 Version?: __integer;
2730 }
2731 export interface EmailMessage {
2732 /**
2733 * The body of the email message.
2734 */
2735 Body?: __string;
2736 /**
2737 * The email address to forward bounces and complaints to, if feedback forwarding is enabled.
2738 */
2739 FeedbackForwardingAddress?: __string;
2740 /**
2741 * The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
2742 */
2743 FromAddress?: __string;
2744 /**
2745 * The email message, represented as a raw MIME message.
2746 */
2747 RawEmail?: RawEmail;
2748 /**
2749 * The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
2750 */
2751 ReplyToAddresses?: ListOf__string;
2752 /**
2753 * The email message, composed of a subject, a text part, and an HTML part.
2754 */
2755 SimpleEmail?: SimpleEmail;
2756 /**
2757 * The default message variables to use in the email message. You can override the default variables with individual address variables.
2758 */
2759 Substitutions?: MapOfListOf__string;
2760 }
2761 export interface EmailMessageActivity {
2762 /**
2763 * The "From" address to use for the message.
2764 */
2765 MessageConfig?: JourneyEmailMessage;
2766 /**
2767 * The unique identifier for the next activity to perform, after the message is sent.
2768 */
2769 NextActivity?: __string;
2770 /**
2771 * The name of the email template to use for the message.
2772 */
2773 TemplateName?: __string;
2774 /**
2775 * The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
2776 */
2777 TemplateVersion?: __string;
2778 }
2779 export interface EmailTemplateRequest {
2780 /**
2781 * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
2782 */
2783 DefaultSubstitutions?: __string;
2784 /**
2785 * The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
2786 */
2787 HtmlPart?: __string;
2788 /**
2789 * The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
2790 */
2791 RecommenderId?: __string;
2792 /**
2793 * The subject line, or title, to use in email messages that are based on the message template.
2794 */
2795 Subject?: __string;
2796 /**
2797 * A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
2798 */
2799 tags?: MapOf__string;
2800 /**
2801 * A custom description of the message template.
2802 */
2803 TemplateDescription?: __string;
2804 /**
2805 * The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
2806 */
2807 TextPart?: __string;
2808 }
2809 export interface EmailTemplateResponse {
2810 /**
2811 * The Amazon Resource Name (ARN) of the message template.
2812 */
2813 Arn?: __string;
2814 /**
2815 * The date, in ISO 8601 format, when the message template was created.
2816 */
2817 CreationDate: __string;
2818 /**
2819 * The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
2820 */
2821 DefaultSubstitutions?: __string;
2822 /**
2823 * The message body, in HTML format, that's used in email messages that are based on the message template.
2824 */
2825 HtmlPart?: __string;
2826 /**
2827 * The date, in ISO 8601 format, when the message template was last modified.
2828 */
2829 LastModifiedDate: __string;
2830 /**
2831 * The unique identifier for the recommender model that's used by the message template.
2832 */
2833 RecommenderId?: __string;
2834 /**
2835 * The subject line, or title, that's used in email messages that are based on the message template.
2836 */
2837 Subject?: __string;
2838 /**
2839 * A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
2840 */
2841 tags?: MapOf__string;
2842 /**
2843 * The custom description of the message template.
2844 */
2845 TemplateDescription?: __string;
2846 /**
2847 * The name of the message template.
2848 */
2849 TemplateName: __string;
2850 /**
2851 * The type of channel that the message template is designed for. For an email template, this value is EMAIL.
2852 */
2853 TemplateType: TemplateType;
2854 /**
2855 * The message body, in plain text format, that's used in email messages that are based on the message template.
2856 */
2857 TextPart?: __string;
2858 /**
2859 * The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
2860 */
2861 Version?: __string;
2862 }
2863 export interface EndpointBatchItem {
2864 /**
2865 * The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
2866 */
2867 Address?: __string;
2868 /**
2869 * One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
2870 */
2871 Attributes?: MapOfListOf__string;
2872 /**
2873 * The channel to use when sending messages or push notifications to the endpoint.
2874 */
2875 ChannelType?: ChannelType;
2876 /**
2877 * The demographic information for the endpoint, such as the time zone and platform.
2878 */
2879 Demographic?: EndpointDemographic;
2880 /**
2881 * The date and time, in ISO 8601 format, when the endpoint was created or updated.
2882 */
2883 EffectiveDate?: __string;
2884 /**
2885 * Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
2886 */
2887 EndpointStatus?: __string;
2888 /**
2889 * The unique identifier for the endpoint in the context of the batch.
2890 */
2891 Id?: __string;
2892 /**
2893 * The geographic information for the endpoint.
2894 */
2895 Location?: EndpointLocation;
2896 /**
2897 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
2898 */
2899 Metrics?: MapOf__double;
2900 /**
2901 * Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
2902 */
2903 OptOut?: __string;
2904 /**
2905 * The unique identifier for the request to create or update the endpoint.
2906 */
2907 RequestId?: __string;
2908 /**
2909 * One or more custom user attributes that describe the user who's associated with the endpoint.
2910 */
2911 User?: EndpointUser;
2912 }
2913 export interface EndpointBatchRequest {
2914 /**
2915 * An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
2916 */
2917 Item: ListOfEndpointBatchItem;
2918 }
2919 export interface EndpointDemographic {
2920 /**
2921 * The version of the app that's associated with the endpoint.
2922 */
2923 AppVersion?: __string;
2924 /**
2925 * The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
2926 */
2927 Locale?: __string;
2928 /**
2929 * The manufacturer of the endpoint device, such as apple or samsung.
2930 */
2931 Make?: __string;
2932 /**
2933 * The model name or number of the endpoint device, such as iPhone or SM-G900F.
2934 */
2935 Model?: __string;
2936 /**
2937 * The model version of the endpoint device.
2938 */
2939 ModelVersion?: __string;
2940 /**
2941 * The platform of the endpoint device, such as ios.
2942 */
2943 Platform?: __string;
2944 /**
2945 * The platform version of the endpoint device.
2946 */
2947 PlatformVersion?: __string;
2948 /**
2949 * The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
2950 */
2951 Timezone?: __string;
2952 }
2953 export interface EndpointItemResponse {
2954 /**
2955 * The custom message that's returned in the response as a result of processing the endpoint data.
2956 */
2957 Message?: __string;
2958 /**
2959 * The status code that's returned in the response as a result of processing the endpoint data.
2960 */
2961 StatusCode?: __integer;
2962 }
2963 export interface EndpointLocation {
2964 /**
2965 * The name of the city where the endpoint is located.
2966 */
2967 City?: __string;
2968 /**
2969 * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
2970 */
2971 Country?: __string;
2972 /**
2973 * The latitude coordinate of the endpoint location, rounded to one decimal place.
2974 */
2975 Latitude?: __double;
2976 /**
2977 * The longitude coordinate of the endpoint location, rounded to one decimal place.
2978 */
2979 Longitude?: __double;
2980 /**
2981 * The postal or ZIP code for the area where the endpoint is located.
2982 */
2983 PostalCode?: __string;
2984 /**
2985 * The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
2986 */
2987 Region?: __string;
2988 }
2989 export interface EndpointMessageResult {
2990 /**
2991 * The endpoint address that the message was delivered to.
2992 */
2993 Address?: __string;
2994 /**
2995 * The delivery status of the message. Possible values are: DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again. OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again. PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. SUCCESSFUL - The message was successfully delivered to the endpoint. TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again. THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint. TIMEOUT - The message couldn't be sent within the timeout period. UNKNOWN_FAILURE - An unknown error occurred.
2996 */
2997 DeliveryStatus: DeliveryStatus;
2998 /**
2999 * The unique identifier for the message that was sent.
3000 */
3001 MessageId?: __string;
3002 /**
3003 * The downstream service status code for delivering the message.
3004 */
3005 StatusCode: __integer;
3006 /**
3007 * The status message for delivering the message.
3008 */
3009 StatusMessage?: __string;
3010 /**
3011 * For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
3012 */
3013 UpdatedToken?: __string;
3014 }
3015 export interface EndpointRequest {
3016 /**
3017 * The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
3018 */
3019 Address?: __string;
3020 /**
3021 * One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
3022 */
3023 Attributes?: MapOfListOf__string;
3024 /**
3025 * The channel to use when sending messages or push notifications to the endpoint.
3026 */
3027 ChannelType?: ChannelType;
3028 /**
3029 * The demographic information for the endpoint, such as the time zone and platform.
3030 */
3031 Demographic?: EndpointDemographic;
3032 /**
3033 * The date and time, in ISO 8601 format, when the endpoint is updated.
3034 */
3035 EffectiveDate?: __string;
3036 /**
3037 * Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
3038 */
3039 EndpointStatus?: __string;
3040 /**
3041 * The geographic information for the endpoint.
3042 */
3043 Location?: EndpointLocation;
3044 /**
3045 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
3046 */
3047 Metrics?: MapOf__double;
3048 /**
3049 * Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
3050 */
3051 OptOut?: __string;
3052 /**
3053 * The unique identifier for the most recent request to update the endpoint.
3054 */
3055 RequestId?: __string;
3056 /**
3057 * One or more custom user attributes that describe the user who's associated with the endpoint.
3058 */
3059 User?: EndpointUser;
3060 }
3061 export interface EndpointResponse {
3062 /**
3063 * The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
3064 */
3065 Address?: __string;
3066 /**
3067 * The unique identifier for the application that's associated with the endpoint.
3068 */
3069 ApplicationId?: __string;
3070 /**
3071 * One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
3072 */
3073 Attributes?: MapOfListOf__string;
3074 /**
3075 * The channel that's used when sending messages or push notifications to the endpoint.
3076 */
3077 ChannelType?: ChannelType;
3078 /**
3079 * A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
3080 */
3081 CohortId?: __string;
3082 /**
3083 * The date and time, in ISO 8601 format, when the endpoint was created.
3084 */
3085 CreationDate?: __string;
3086 /**
3087 * The demographic information for the endpoint, such as the time zone and platform.
3088 */
3089 Demographic?: EndpointDemographic;
3090 /**
3091 * The date and time, in ISO 8601 format, when the endpoint was last updated.
3092 */
3093 EffectiveDate?: __string;
3094 /**
3095 * Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
3096 */
3097 EndpointStatus?: __string;
3098 /**
3099 * The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
3100 */
3101 Id?: __string;
3102 /**
3103 * The geographic information for the endpoint.
3104 */
3105 Location?: EndpointLocation;
3106 /**
3107 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
3108 */
3109 Metrics?: MapOf__double;
3110 /**
3111 * Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
3112 */
3113 OptOut?: __string;
3114 /**
3115 * The unique identifier for the most recent request to update the endpoint.
3116 */
3117 RequestId?: __string;
3118 /**
3119 * One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
3120 */
3121 User?: EndpointUser;
3122 }
3123 export interface EndpointSendConfiguration {
3124 /**
3125 * The body of the message. If specified, this value overrides the default message body.
3126 */
3127 BodyOverride?: __string;
3128 /**
3129 * A map of custom attributes to attach to the message for the address. Attribute names are case sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
3130 */
3131 Context?: MapOf__string;
3132 /**
3133 * The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
3134 */
3135 RawContent?: __string;
3136 /**
3137 * A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
3138 */
3139 Substitutions?: MapOfListOf__string;
3140 /**
3141 * The title or subject line of the message. If specified, this value overrides the default message title or subject line.
3142 */
3143 TitleOverride?: __string;
3144 }
3145 export interface EndpointUser {
3146 /**
3147 * One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
3148 */
3149 UserAttributes?: MapOfListOf__string;
3150 /**
3151 * The unique identifier for the user.
3152 */
3153 UserId?: __string;
3154 }
3155 export interface EndpointsResponse {
3156 /**
3157 * An array of responses, one for each endpoint that's associated with the user ID.
3158 */
3159 Item: ListOfEndpointResponse;
3160 }
3161 export interface Event {
3162 /**
3163 * The package name of the app that's recording the event.
3164 */
3165 AppPackageName?: __string;
3166 /**
3167 * The title of the app that's recording the event.
3168 */
3169 AppTitle?: __string;
3170 /**
3171 * The version number of the app that's recording the event.
3172 */
3173 AppVersionCode?: __string;
3174 /**
3175 * One or more custom attributes that are associated with the event.
3176 */
3177 Attributes?: MapOf__string;
3178 /**
3179 * The version of the SDK that's running on the client device.
3180 */
3181 ClientSdkVersion?: __string;
3182 /**
3183 * The name of the event.
3184 */
3185 EventType: __string;
3186 /**
3187 * One or more custom metrics that are associated with the event.
3188 */
3189 Metrics?: MapOf__double;
3190 /**
3191 * The name of the SDK that's being used to record the event.
3192 */
3193 SdkName?: __string;
3194 /**
3195 * Information about the session in which the event occurred.
3196 */
3197 Session?: Session;
3198 /**
3199 * The date and time, in ISO 8601 format, when the event occurred.
3200 */
3201 Timestamp: __string;
3202 }
3203 export interface EventCondition {
3204 /**
3205 * The dimensions for the event filter to use for the activity.
3206 */
3207 Dimensions: EventDimensions;
3208 /**
3209 * The message identifier (message_id) for the message to use when determining whether message events meet the condition.
3210 */
3211 MessageActivity?: __string;
3212 }
3213 export interface EventDimensions {
3214 /**
3215 * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
3216 */
3217 Attributes?: MapOfAttributeDimension;
3218 /**
3219 * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
3220 */
3221 EventType?: SetDimension;
3222 /**
3223 * One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
3224 */
3225 Metrics?: MapOfMetricDimension;
3226 }
3227 export interface EventItemResponse {
3228 /**
3229 * A custom message that's returned in the response as a result of processing the event.
3230 */
3231 Message?: __string;
3232 /**
3233 * The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
3234 */
3235 StatusCode?: __integer;
3236 }
3237 export interface EventStream {
3238 /**
3239 * The unique identifier for the application to publish event data for.
3240 */
3241 ApplicationId: __string;
3242 /**
3243 * The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
3244 For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
3245
3246 */
3247 DestinationStreamArn: __string;
3248 /**
3249 * (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
3250 */
3251 ExternalId?: __string;
3252 /**
3253 * The date, in ISO 8601 format, when the event stream was last modified.
3254 */
3255 LastModifiedDate?: __string;
3256 /**
3257 * The IAM user who last modified the event stream.
3258 */
3259 LastUpdatedBy?: __string;
3260 /**
3261 * The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
3262 */
3263 RoleArn: __string;
3264 }
3265 export interface EventsBatch {
3266 /**
3267 * A set of properties and attributes that are associated with the endpoint.
3268 */
3269 Endpoint: PublicEndpoint;
3270 /**
3271 * A set of properties that are associated with the event.
3272 */
3273 Events: MapOfEvent;
3274 }
3275 export interface EventsRequest {
3276 /**
3277 * The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
3278 */
3279 BatchItem: MapOfEventsBatch;
3280 }
3281 export interface EventsResponse {
3282 /**
3283 * A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
3284 */
3285 Results?: MapOfItemResponse;
3286 }
3287 export interface ExportJobRequest {
3288 /**
3289 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
3290 */
3291 RoleArn: __string;
3292 /**
3293 * The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
3294 */
3295 S3UrlPrefix: __string;
3296 /**
3297 * The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
3298 */
3299 SegmentId?: __string;
3300 /**
3301 * The version of the segment to export endpoint definitions from, if specified.
3302 */
3303 SegmentVersion?: __integer;
3304 }
3305 export interface ExportJobResource {
3306 /**
3307 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
3308 */
3309 RoleArn: __string;
3310 /**
3311 * The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
3312 */
3313 S3UrlPrefix: __string;
3314 /**
3315 * The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
3316 */
3317 SegmentId?: __string;
3318 /**
3319 * The version of the segment that the endpoint definitions were exported from.
3320 */
3321 SegmentVersion?: __integer;
3322 }
3323 export interface ExportJobResponse {
3324 /**
3325 * The unique identifier for the application that's associated with the export job.
3326 */
3327 ApplicationId: __string;
3328 /**
3329 * The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
3330 */
3331 CompletedPieces?: __integer;
3332 /**
3333 * The date, in ISO 8601 format, when the export job was completed.
3334 */
3335 CompletionDate?: __string;
3336 /**
3337 * The date, in ISO 8601 format, when the export job was created.
3338 */
3339 CreationDate: __string;
3340 /**
3341 * The resource settings that apply to the export job.
3342 */
3343 Definition: ExportJobResource;
3344 /**
3345 * The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
3346 */
3347 FailedPieces?: __integer;
3348 /**
3349 * An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
3350 */
3351 Failures?: ListOf__string;
3352 /**
3353 * The unique identifier for the export job.
3354 */
3355 Id: __string;
3356 /**
3357 * The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
3358 */
3359 JobStatus: JobStatus;
3360 /**
3361 * The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
3362 */
3363 TotalFailures?: __integer;
3364 /**
3365 * The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
3366 */
3367 TotalPieces?: __integer;
3368 /**
3369 * The total number of endpoint definitions that were processed by the export job.
3370 */
3371 TotalProcessed?: __integer;
3372 /**
3373 * The job type. This value is EXPORT for export jobs.
3374 */
3375 Type: __string;
3376 }
3377 export interface ExportJobsResponse {
3378 /**
3379 * An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
3380 */
3381 Item: ListOfExportJobResponse;
3382 /**
3383 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
3384 */
3385 NextToken?: __string;
3386 }
3387 export type FilterType = "SYSTEM"|"ENDPOINT"|string;
3388 export type Format = "CSV"|"JSON"|string;
3389 export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string;
3390 export interface GCMChannelRequest {
3391 /**
3392 * The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
3393 */
3394 ApiKey: __string;
3395 /**
3396 * Specifies whether to enable the GCM channel for the application.
3397 */
3398 Enabled?: __boolean;
3399 }
3400 export interface GCMChannelResponse {
3401 /**
3402 * The unique identifier for the application that the GCM channel applies to.
3403 */
3404 ApplicationId?: __string;
3405 /**
3406 * The date and time when the GCM channel was enabled.
3407 */
3408 CreationDate?: __string;
3409 /**
3410 * The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
3411 */
3412 Credential: __string;
3413 /**
3414 * Specifies whether the GCM channel is enabled for the application.
3415 */
3416 Enabled?: __boolean;
3417 /**
3418 * (Not used) This property is retained only for backward compatibility.
3419 */
3420 HasCredential?: __boolean;
3421 /**
3422 * (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
3423 */
3424 Id?: __string;
3425 /**
3426 * Specifies whether the GCM channel is archived.
3427 */
3428 IsArchived?: __boolean;
3429 /**
3430 * The user who last modified the GCM channel.
3431 */
3432 LastModifiedBy?: __string;
3433 /**
3434 * The date and time when the GCM channel was last modified.
3435 */
3436 LastModifiedDate?: __string;
3437 /**
3438 * The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
3439 */
3440 Platform: __string;
3441 /**
3442 * The current version of the GCM channel.
3443 */
3444 Version?: __integer;
3445 }
3446 export interface GCMMessage {
3447 /**
3448 * The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
3449 */
3450 Action?: Action;
3451 /**
3452 * The body of the notification message.
3453 */
3454 Body?: __string;
3455 /**
3456 * An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
3457 */
3458 CollapseKey?: __string;
3459 /**
3460 * The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
3461 */
3462 Data?: MapOf__string;
3463 /**
3464 * The icon image name of the asset saved in your app.
3465 */
3466 IconReference?: __string;
3467 /**
3468 * The URL of the large icon image to display in the content view of the push notification.
3469 */
3470 ImageIconUrl?: __string;
3471 /**
3472 * The URL of an image to display in the push notification.
3473 */
3474 ImageUrl?: __string;
3475 /**
3476 * para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required./listitem> high - The notification is sent immediately and might wake a sleeping device./para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
3477 */
3478 Priority?: __string;
3479 /**
3480 * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
3481 */
3482 RawContent?: __string;
3483 /**
3484 * The package name of the application where registration tokens must match in order for the recipient to receive the message.
3485 */
3486 RestrictedPackageName?: __string;
3487 /**
3488 * Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
3489 */
3490 SilentPush?: __boolean;
3491 /**
3492 * The URL of the small icon image to display in the status bar and the content view of the push notification.
3493 */
3494 SmallImageIconUrl?: __string;
3495 /**
3496 * The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
3497 */
3498 Sound?: __string;
3499 /**
3500 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
3501 */
3502 Substitutions?: MapOfListOf__string;
3503 /**
3504 * The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
3505 */
3506 TimeToLive?: __integer;
3507 /**
3508 * The title to display above the notification message on the recipient's device.
3509 */
3510 Title?: __string;
3511 /**
3512 * The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
3513 */
3514 Url?: __string;
3515 }
3516 export interface GPSCoordinates {
3517 /**
3518 * The latitude coordinate of the location.
3519 */
3520 Latitude: __double;
3521 /**
3522 * The longitude coordinate of the location.
3523 */
3524 Longitude: __double;
3525 }
3526 export interface GPSPointDimension {
3527 /**
3528 * The GPS coordinates to measure distance from.
3529 */
3530 Coordinates: GPSCoordinates;
3531 /**
3532 * The range, in kilometers, from the GPS coordinates.
3533 */
3534 RangeInKilometers?: __double;
3535 }
3536 export interface GetAdmChannelRequest {
3537 /**
3538 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3539 */
3540 ApplicationId: __string;
3541 }
3542 export interface GetAdmChannelResponse {
3543 ADMChannelResponse: ADMChannelResponse;
3544 }
3545 export interface GetApnsChannelRequest {
3546 /**
3547 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3548 */
3549 ApplicationId: __string;
3550 }
3551 export interface GetApnsChannelResponse {
3552 APNSChannelResponse: APNSChannelResponse;
3553 }
3554 export interface GetApnsSandboxChannelRequest {
3555 /**
3556 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3557 */
3558 ApplicationId: __string;
3559 }
3560 export interface GetApnsSandboxChannelResponse {
3561 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
3562 }
3563 export interface GetApnsVoipChannelRequest {
3564 /**
3565 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3566 */
3567 ApplicationId: __string;
3568 }
3569 export interface GetApnsVoipChannelResponse {
3570 APNSVoipChannelResponse: APNSVoipChannelResponse;
3571 }
3572 export interface GetApnsVoipSandboxChannelRequest {
3573 /**
3574 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3575 */
3576 ApplicationId: __string;
3577 }
3578 export interface GetApnsVoipSandboxChannelResponse {
3579 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
3580 }
3581 export interface GetAppRequest {
3582 /**
3583 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3584 */
3585 ApplicationId: __string;
3586 }
3587 export interface GetAppResponse {
3588 ApplicationResponse: ApplicationResponse;
3589 }
3590 export interface GetApplicationDateRangeKpiRequest {
3591 /**
3592 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3593 */
3594 ApplicationId: __string;
3595 /**
3596 * The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
3597 */
3598 EndTime?: __timestampIso8601;
3599 /**
3600 * The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
3601 */
3602 KpiName: __string;
3603 /**
3604 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3605 */
3606 NextToken?: __string;
3607 /**
3608 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3609 */
3610 PageSize?: __string;
3611 /**
3612 * The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
3613 */
3614 StartTime?: __timestampIso8601;
3615 }
3616 export interface GetApplicationDateRangeKpiResponse {
3617 ApplicationDateRangeKpiResponse: ApplicationDateRangeKpiResponse;
3618 }
3619 export interface GetApplicationSettingsRequest {
3620 /**
3621 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3622 */
3623 ApplicationId: __string;
3624 }
3625 export interface GetApplicationSettingsResponse {
3626 ApplicationSettingsResource: ApplicationSettingsResource;
3627 }
3628 export interface GetAppsRequest {
3629 /**
3630 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3631 */
3632 PageSize?: __string;
3633 /**
3634 * The NextToken string that specifies which page of results to return in a paginated response.
3635 */
3636 Token?: __string;
3637 }
3638 export interface GetAppsResponse {
3639 ApplicationsResponse: ApplicationsResponse;
3640 }
3641 export interface GetBaiduChannelRequest {
3642 /**
3643 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3644 */
3645 ApplicationId: __string;
3646 }
3647 export interface GetBaiduChannelResponse {
3648 BaiduChannelResponse: BaiduChannelResponse;
3649 }
3650 export interface GetCampaignActivitiesRequest {
3651 /**
3652 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3653 */
3654 ApplicationId: __string;
3655 /**
3656 * The unique identifier for the campaign.
3657 */
3658 CampaignId: __string;
3659 /**
3660 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3661 */
3662 PageSize?: __string;
3663 /**
3664 * The NextToken string that specifies which page of results to return in a paginated response.
3665 */
3666 Token?: __string;
3667 }
3668 export interface GetCampaignActivitiesResponse {
3669 ActivitiesResponse: ActivitiesResponse;
3670 }
3671 export interface GetCampaignDateRangeKpiRequest {
3672 /**
3673 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3674 */
3675 ApplicationId: __string;
3676 /**
3677 * The unique identifier for the campaign.
3678 */
3679 CampaignId: __string;
3680 /**
3681 * The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
3682 */
3683 EndTime?: __timestampIso8601;
3684 /**
3685 * The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
3686 */
3687 KpiName: __string;
3688 /**
3689 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3690 */
3691 NextToken?: __string;
3692 /**
3693 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3694 */
3695 PageSize?: __string;
3696 /**
3697 * The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
3698 */
3699 StartTime?: __timestampIso8601;
3700 }
3701 export interface GetCampaignDateRangeKpiResponse {
3702 CampaignDateRangeKpiResponse: CampaignDateRangeKpiResponse;
3703 }
3704 export interface GetCampaignRequest {
3705 /**
3706 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3707 */
3708 ApplicationId: __string;
3709 /**
3710 * The unique identifier for the campaign.
3711 */
3712 CampaignId: __string;
3713 }
3714 export interface GetCampaignResponse {
3715 CampaignResponse: CampaignResponse;
3716 }
3717 export interface GetCampaignVersionRequest {
3718 /**
3719 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3720 */
3721 ApplicationId: __string;
3722 /**
3723 * The unique identifier for the campaign.
3724 */
3725 CampaignId: __string;
3726 /**
3727 * The unique version number (Version property) for the campaign version.
3728 */
3729 Version: __string;
3730 }
3731 export interface GetCampaignVersionResponse {
3732 CampaignResponse: CampaignResponse;
3733 }
3734 export interface GetCampaignVersionsRequest {
3735 /**
3736 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3737 */
3738 ApplicationId: __string;
3739 /**
3740 * The unique identifier for the campaign.
3741 */
3742 CampaignId: __string;
3743 /**
3744 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3745 */
3746 PageSize?: __string;
3747 /**
3748 * The NextToken string that specifies which page of results to return in a paginated response.
3749 */
3750 Token?: __string;
3751 }
3752 export interface GetCampaignVersionsResponse {
3753 CampaignsResponse: CampaignsResponse;
3754 }
3755 export interface GetCampaignsRequest {
3756 /**
3757 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3758 */
3759 ApplicationId: __string;
3760 /**
3761 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3762 */
3763 PageSize?: __string;
3764 /**
3765 * The NextToken string that specifies which page of results to return in a paginated response.
3766 */
3767 Token?: __string;
3768 }
3769 export interface GetCampaignsResponse {
3770 CampaignsResponse: CampaignsResponse;
3771 }
3772 export interface GetChannelsRequest {
3773 /**
3774 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3775 */
3776 ApplicationId: __string;
3777 }
3778 export interface GetChannelsResponse {
3779 ChannelsResponse: ChannelsResponse;
3780 }
3781 export interface GetEmailChannelRequest {
3782 /**
3783 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3784 */
3785 ApplicationId: __string;
3786 }
3787 export interface GetEmailChannelResponse {
3788 EmailChannelResponse: EmailChannelResponse;
3789 }
3790 export interface GetEmailTemplateRequest {
3791 /**
3792 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
3793 */
3794 TemplateName: __string;
3795 /**
3796 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
3797 */
3798 Version?: __string;
3799 }
3800 export interface GetEmailTemplateResponse {
3801 EmailTemplateResponse: EmailTemplateResponse;
3802 }
3803 export interface GetEndpointRequest {
3804 /**
3805 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3806 */
3807 ApplicationId: __string;
3808 /**
3809 * The unique identifier for the endpoint.
3810 */
3811 EndpointId: __string;
3812 }
3813 export interface GetEndpointResponse {
3814 EndpointResponse: EndpointResponse;
3815 }
3816 export interface GetEventStreamRequest {
3817 /**
3818 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3819 */
3820 ApplicationId: __string;
3821 }
3822 export interface GetEventStreamResponse {
3823 EventStream: EventStream;
3824 }
3825 export interface GetExportJobRequest {
3826 /**
3827 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3828 */
3829 ApplicationId: __string;
3830 /**
3831 * The unique identifier for the job.
3832 */
3833 JobId: __string;
3834 }
3835 export interface GetExportJobResponse {
3836 ExportJobResponse: ExportJobResponse;
3837 }
3838 export interface GetExportJobsRequest {
3839 /**
3840 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3841 */
3842 ApplicationId: __string;
3843 /**
3844 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3845 */
3846 PageSize?: __string;
3847 /**
3848 * The NextToken string that specifies which page of results to return in a paginated response.
3849 */
3850 Token?: __string;
3851 }
3852 export interface GetExportJobsResponse {
3853 ExportJobsResponse: ExportJobsResponse;
3854 }
3855 export interface GetGcmChannelRequest {
3856 /**
3857 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3858 */
3859 ApplicationId: __string;
3860 }
3861 export interface GetGcmChannelResponse {
3862 GCMChannelResponse: GCMChannelResponse;
3863 }
3864 export interface GetImportJobRequest {
3865 /**
3866 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3867 */
3868 ApplicationId: __string;
3869 /**
3870 * The unique identifier for the job.
3871 */
3872 JobId: __string;
3873 }
3874 export interface GetImportJobResponse {
3875 ImportJobResponse: ImportJobResponse;
3876 }
3877 export interface GetImportJobsRequest {
3878 /**
3879 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3880 */
3881 ApplicationId: __string;
3882 /**
3883 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3884 */
3885 PageSize?: __string;
3886 /**
3887 * The NextToken string that specifies which page of results to return in a paginated response.
3888 */
3889 Token?: __string;
3890 }
3891 export interface GetImportJobsResponse {
3892 ImportJobsResponse: ImportJobsResponse;
3893 }
3894 export interface GetJourneyDateRangeKpiRequest {
3895 /**
3896 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3897 */
3898 ApplicationId: __string;
3899 /**
3900 * The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
3901 */
3902 EndTime?: __timestampIso8601;
3903 /**
3904 * The unique identifier for the journey.
3905 */
3906 JourneyId: __string;
3907 /**
3908 * The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
3909 */
3910 KpiName: __string;
3911 /**
3912 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3913 */
3914 NextToken?: __string;
3915 /**
3916 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3917 */
3918 PageSize?: __string;
3919 /**
3920 * The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
3921 */
3922 StartTime?: __timestampIso8601;
3923 }
3924 export interface GetJourneyDateRangeKpiResponse {
3925 JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponse;
3926 }
3927 export interface GetJourneyExecutionActivityMetricsRequest {
3928 /**
3929 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3930 */
3931 ApplicationId: __string;
3932 /**
3933 * The unique identifier for the journey activity.
3934 */
3935 JourneyActivityId: __string;
3936 /**
3937 * The unique identifier for the journey.
3938 */
3939 JourneyId: __string;
3940 /**
3941 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3942 */
3943 NextToken?: __string;
3944 /**
3945 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3946 */
3947 PageSize?: __string;
3948 }
3949 export interface GetJourneyExecutionActivityMetricsResponse {
3950 JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponse;
3951 }
3952 export interface GetJourneyExecutionMetricsRequest {
3953 /**
3954 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3955 */
3956 ApplicationId: __string;
3957 /**
3958 * The unique identifier for the journey.
3959 */
3960 JourneyId: __string;
3961 /**
3962 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3963 */
3964 NextToken?: __string;
3965 /**
3966 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
3967 */
3968 PageSize?: __string;
3969 }
3970 export interface GetJourneyExecutionMetricsResponse {
3971 JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse;
3972 }
3973 export interface GetJourneyRequest {
3974 /**
3975 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3976 */
3977 ApplicationId: __string;
3978 /**
3979 * The unique identifier for the journey.
3980 */
3981 JourneyId: __string;
3982 }
3983 export interface GetJourneyResponse {
3984 JourneyResponse: JourneyResponse;
3985 }
3986 export interface GetPushTemplateRequest {
3987 /**
3988 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
3989 */
3990 TemplateName: __string;
3991 /**
3992 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
3993 */
3994 Version?: __string;
3995 }
3996 export interface GetPushTemplateResponse {
3997 PushNotificationTemplateResponse: PushNotificationTemplateResponse;
3998 }
3999 export interface GetRecommenderConfigurationRequest {
4000 /**
4001 * The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
4002 */
4003 RecommenderId: __string;
4004 }
4005 export interface GetRecommenderConfigurationResponse {
4006 RecommenderConfigurationResponse: RecommenderConfigurationResponse;
4007 }
4008 export interface GetRecommenderConfigurationsRequest {
4009 /**
4010 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4011 */
4012 PageSize?: __string;
4013 /**
4014 * The NextToken string that specifies which page of results to return in a paginated response.
4015 */
4016 Token?: __string;
4017 }
4018 export interface GetRecommenderConfigurationsResponse {
4019 ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponse;
4020 }
4021 export interface GetSegmentExportJobsRequest {
4022 /**
4023 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4024 */
4025 ApplicationId: __string;
4026 /**
4027 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4028 */
4029 PageSize?: __string;
4030 /**
4031 * The unique identifier for the segment.
4032 */
4033 SegmentId: __string;
4034 /**
4035 * The NextToken string that specifies which page of results to return in a paginated response.
4036 */
4037 Token?: __string;
4038 }
4039 export interface GetSegmentExportJobsResponse {
4040 ExportJobsResponse: ExportJobsResponse;
4041 }
4042 export interface GetSegmentImportJobsRequest {
4043 /**
4044 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4045 */
4046 ApplicationId: __string;
4047 /**
4048 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4049 */
4050 PageSize?: __string;
4051 /**
4052 * The unique identifier for the segment.
4053 */
4054 SegmentId: __string;
4055 /**
4056 * The NextToken string that specifies which page of results to return in a paginated response.
4057 */
4058 Token?: __string;
4059 }
4060 export interface GetSegmentImportJobsResponse {
4061 ImportJobsResponse: ImportJobsResponse;
4062 }
4063 export interface GetSegmentRequest {
4064 /**
4065 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4066 */
4067 ApplicationId: __string;
4068 /**
4069 * The unique identifier for the segment.
4070 */
4071 SegmentId: __string;
4072 }
4073 export interface GetSegmentResponse {
4074 SegmentResponse: SegmentResponse;
4075 }
4076 export interface GetSegmentVersionRequest {
4077 /**
4078 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4079 */
4080 ApplicationId: __string;
4081 /**
4082 * The unique identifier for the segment.
4083 */
4084 SegmentId: __string;
4085 /**
4086 * The unique version number (Version property) for the campaign version.
4087 */
4088 Version: __string;
4089 }
4090 export interface GetSegmentVersionResponse {
4091 SegmentResponse: SegmentResponse;
4092 }
4093 export interface GetSegmentVersionsRequest {
4094 /**
4095 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4096 */
4097 ApplicationId: __string;
4098 /**
4099 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4100 */
4101 PageSize?: __string;
4102 /**
4103 * The unique identifier for the segment.
4104 */
4105 SegmentId: __string;
4106 /**
4107 * The NextToken string that specifies which page of results to return in a paginated response.
4108 */
4109 Token?: __string;
4110 }
4111 export interface GetSegmentVersionsResponse {
4112 SegmentsResponse: SegmentsResponse;
4113 }
4114 export interface GetSegmentsRequest {
4115 /**
4116 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4117 */
4118 ApplicationId: __string;
4119 /**
4120 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4121 */
4122 PageSize?: __string;
4123 /**
4124 * The NextToken string that specifies which page of results to return in a paginated response.
4125 */
4126 Token?: __string;
4127 }
4128 export interface GetSegmentsResponse {
4129 SegmentsResponse: SegmentsResponse;
4130 }
4131 export interface GetSmsChannelRequest {
4132 /**
4133 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4134 */
4135 ApplicationId: __string;
4136 }
4137 export interface GetSmsChannelResponse {
4138 SMSChannelResponse: SMSChannelResponse;
4139 }
4140 export interface GetSmsTemplateRequest {
4141 /**
4142 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
4143 */
4144 TemplateName: __string;
4145 /**
4146 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
4147 */
4148 Version?: __string;
4149 }
4150 export interface GetSmsTemplateResponse {
4151 SMSTemplateResponse: SMSTemplateResponse;
4152 }
4153 export interface GetUserEndpointsRequest {
4154 /**
4155 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4156 */
4157 ApplicationId: __string;
4158 /**
4159 * The unique identifier for the user.
4160 */
4161 UserId: __string;
4162 }
4163 export interface GetUserEndpointsResponse {
4164 EndpointsResponse: EndpointsResponse;
4165 }
4166 export interface GetVoiceChannelRequest {
4167 /**
4168 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4169 */
4170 ApplicationId: __string;
4171 }
4172 export interface GetVoiceChannelResponse {
4173 VoiceChannelResponse: VoiceChannelResponse;
4174 }
4175 export interface GetVoiceTemplateRequest {
4176 /**
4177 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
4178 */
4179 TemplateName: __string;
4180 /**
4181 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
4182 */
4183 Version?: __string;
4184 }
4185 export interface GetVoiceTemplateResponse {
4186 VoiceTemplateResponse: VoiceTemplateResponse;
4187 }
4188 export interface HoldoutActivity {
4189 /**
4190 * The unique identifier for the next activity to perform, after performing the holdout activity.
4191 */
4192 NextActivity?: __string;
4193 /**
4194 * The percentage of participants who shouldn't continue the journey. To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
4195 */
4196 Percentage: __integer;
4197 }
4198 export interface ImportJobRequest {
4199 /**
4200 * Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
4201 */
4202 DefineSegment?: __boolean;
4203 /**
4204 * (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
4205 */
4206 ExternalId?: __string;
4207 /**
4208 * The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
4209 */
4210 Format: Format;
4211 /**
4212 * Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
4213 */
4214 RegisterEndpoints?: __boolean;
4215 /**
4216 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
4217 */
4218 RoleArn: __string;
4219 /**
4220 * The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
4221 */
4222 S3Url: __string;
4223 /**
4224 * The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
4225 */
4226 SegmentId?: __string;
4227 /**
4228 * A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
4229 */
4230 SegmentName?: __string;
4231 }
4232 export interface ImportJobResource {
4233 /**
4234 * Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
4235 */
4236 DefineSegment?: __boolean;
4237 /**
4238 * (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
4239 */
4240 ExternalId?: __string;
4241 /**
4242 * The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
4243 */
4244 Format: Format;
4245 /**
4246 * Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
4247 */
4248 RegisterEndpoints?: __boolean;
4249 /**
4250 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
4251 */
4252 RoleArn: __string;
4253 /**
4254 * The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
4255 */
4256 S3Url: __string;
4257 /**
4258 * The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
4259 */
4260 SegmentId?: __string;
4261 /**
4262 * The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
4263 */
4264 SegmentName?: __string;
4265 }
4266 export interface ImportJobResponse {
4267 /**
4268 * The unique identifier for the application that's associated with the import job.
4269 */
4270 ApplicationId: __string;
4271 /**
4272 * The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
4273 */
4274 CompletedPieces?: __integer;
4275 /**
4276 * The date, in ISO 8601 format, when the import job was completed.
4277 */
4278 CompletionDate?: __string;
4279 /**
4280 * The date, in ISO 8601 format, when the import job was created.
4281 */
4282 CreationDate: __string;
4283 /**
4284 * The resource settings that apply to the import job.
4285 */
4286 Definition: ImportJobResource;
4287 /**
4288 * The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
4289 */
4290 FailedPieces?: __integer;
4291 /**
4292 * An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
4293 */
4294 Failures?: ListOf__string;
4295 /**
4296 * The unique identifier for the import job.
4297 */
4298 Id: __string;
4299 /**
4300 * The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
4301 */
4302 JobStatus: JobStatus;
4303 /**
4304 * The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
4305 */
4306 TotalFailures?: __integer;
4307 /**
4308 * The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
4309 */
4310 TotalPieces?: __integer;
4311 /**
4312 * The total number of endpoint definitions that were processed by the import job.
4313 */
4314 TotalProcessed?: __integer;
4315 /**
4316 * The job type. This value is IMPORT for import jobs.
4317 */
4318 Type: __string;
4319 }
4320 export interface ImportJobsResponse {
4321 /**
4322 * An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
4323 */
4324 Item: ListOfImportJobResponse;
4325 /**
4326 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
4327 */
4328 NextToken?: __string;
4329 }
4330 export type Include = "ALL"|"ANY"|"NONE"|string;
4331 export interface ItemResponse {
4332 /**
4333 * The response that was received after the endpoint data was accepted.
4334 */
4335 EndpointItemResponse?: EndpointItemResponse;
4336 /**
4337 * A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
4338 */
4339 EventsItemResponse?: MapOfEventItemResponse;
4340 }
4341 export type JobStatus = "CREATED"|"PREPARING_FOR_INITIALIZATION"|"INITIALIZING"|"PROCESSING"|"PENDING_JOB"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED"|string;
4342 export interface JourneyDateRangeKpiResponse {
4343 /**
4344 * The unique identifier for the application that the metric applies to.
4345 */
4346 ApplicationId: __string;
4347 /**
4348 * The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
4349 */
4350 EndTime: __timestampIso8601;
4351 /**
4352 * The unique identifier for the journey that the metric applies to.
4353 */
4354 JourneyId: __string;
4355 /**
4356 * The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
4357 */
4358 KpiName: __string;
4359 /**
4360 * An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
4361 */
4362 KpiResult: BaseKpiResult;
4363 /**
4364 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
4365 */
4366 NextToken?: __string;
4367 /**
4368 * The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
4369 */
4370 StartTime: __timestampIso8601;
4371 }
4372 export interface JourneyEmailMessage {
4373 /**
4374 * The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
4375 */
4376 FromAddress?: __string;
4377 }
4378 export interface JourneyExecutionActivityMetricsResponse {
4379 /**
4380 * The type of activity that the metric applies to. Possible values are: CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey. HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants. MESSAGE - For an email activity, which is an activity that sends an email message to participants. MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey. RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey. WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
4381 */
4382 ActivityType: __string;
4383 /**
4384 * The unique identifier for the application that the metric applies to.
4385 */
4386 ApplicationId: __string;
4387 /**
4388 * The unique identifier for the activity that the metric applies to.
4389 */
4390 JourneyActivityId: __string;
4391 /**
4392 * The unique identifier for the journey that the metric applies to.
4393 */
4394 JourneyId: __string;
4395 /**
4396 * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
4397 */
4398 LastEvaluatedTime: __string;
4399 /**
4400 * A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
4401 */
4402 Metrics: MapOf__string;
4403 }
4404 export interface JourneyExecutionMetricsResponse {
4405 /**
4406 * The unique identifier for the application that the metric applies to.
4407 */
4408 ApplicationId: __string;
4409 /**
4410 * The unique identifier for the journey that the metric applies to.
4411 */
4412 JourneyId: __string;
4413 /**
4414 * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
4415 */
4416 LastEvaluatedTime: __string;
4417 /**
4418 * A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
4419 */
4420 Metrics: MapOf__string;
4421 }
4422 export interface JourneyLimits {
4423 /**
4424 * The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
4425 */
4426 DailyCap?: __integer;
4427 /**
4428 * The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
4429 */
4430 EndpointReentryCap?: __integer;
4431 /**
4432 * The maximum number of messages that the journey can send each second.
4433 */
4434 MessagesPerSecond?: __integer;
4435 }
4436 export interface JourneyResponse {
4437 /**
4438 * A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
4439 */
4440 Activities?: MapOfActivity;
4441 /**
4442 * The unique identifier for the application that the journey applies to.
4443 */
4444 ApplicationId: __string;
4445 /**
4446 * The date, in ISO 8601 format, when the journey was created.
4447 */
4448 CreationDate?: __string;
4449 /**
4450 * The unique identifier for the journey.
4451 */
4452 Id: __string;
4453 /**
4454 * The date, in ISO 8601 format, when the journey was last modified.
4455 */
4456 LastModifiedDate?: __string;
4457 /**
4458 * The messaging and entry limits for the journey.
4459 */
4460 Limits?: JourneyLimits;
4461 /**
4462 * Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
4463 */
4464 LocalTime?: __boolean;
4465 /**
4466 * The name of the journey.
4467 */
4468 Name: __string;
4469 /**
4470 * The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value. The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey. The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey. If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
4471 */
4472 QuietTime?: QuietTime;
4473 /**
4474 * The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
4475 */
4476 RefreshFrequency?: __string;
4477 /**
4478 * The schedule settings for the journey.
4479 */
4480 Schedule?: JourneySchedule;
4481 /**
4482 * The unique identifier for the first activity in the journey.
4483 */
4484 StartActivity?: __string;
4485 /**
4486 * The segment that defines which users are participants in the journey.
4487 */
4488 StartCondition?: StartCondition;
4489 /**
4490 * The current status of the journey. Possible values are: DRAFT - The journey is being developed and hasn't been published yet. ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it. COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey. CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey. CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
4491 */
4492 State?: State;
4493 /**
4494 * This object is not used or supported.
4495 */
4496 tags?: MapOf__string;
4497 }
4498 export interface JourneySchedule {
4499 /**
4500 * The scheduled time, in ISO 8601 format, when the journey ended or will end.
4501 */
4502 EndTime?: __timestampIso8601;
4503 /**
4504 * The scheduled time, in ISO 8601 format, when the journey began or will begin.
4505 */
4506 StartTime?: __timestampIso8601;
4507 /**
4508 * The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC,
4509 UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,
4510 UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30,
4511 UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02,
4512 UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09,
4513 UTC-09:30, UTC-10, and UTC-11.
4514 */
4515 Timezone?: __string;
4516 }
4517 export interface JourneyStateRequest {
4518 /**
4519 * The status of the journey. Currently, the only supported value is CANCELLED. If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey. After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
4520 */
4521 State?: State;
4522 }
4523 export interface JourneysResponse {
4524 /**
4525 * An array of responses, one for each journey that's associated with the application.
4526 */
4527 Item: ListOfJourneyResponse;
4528 /**
4529 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
4530 */
4531 NextToken?: __string;
4532 }
4533 export interface ListJourneysRequest {
4534 /**
4535 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4536 */
4537 ApplicationId: __string;
4538 /**
4539 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4540 */
4541 PageSize?: __string;
4542 /**
4543 * The NextToken string that specifies which page of results to return in a paginated response.
4544 */
4545 Token?: __string;
4546 }
4547 export interface ListJourneysResponse {
4548 JourneysResponse: JourneysResponse;
4549 }
4550 export interface ListRecommenderConfigurationsResponse {
4551 /**
4552 * An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
4553 */
4554 Item: ListOfRecommenderConfigurationResponse;
4555 /**
4556 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
4557 */
4558 NextToken?: __string;
4559 }
4560 export interface ListTagsForResourceRequest {
4561 /**
4562 * The Amazon Resource Name (ARN) of the resource.
4563 */
4564 ResourceArn: __string;
4565 }
4566 export interface ListTagsForResourceResponse {
4567 TagsModel: TagsModel;
4568 }
4569 export interface ListTemplateVersionsRequest {
4570 /**
4571 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4572 */
4573 NextToken?: __string;
4574 /**
4575 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4576 */
4577 PageSize?: __string;
4578 /**
4579 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
4580 */
4581 TemplateName: __string;
4582 /**
4583 * The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
4584 */
4585 TemplateType: __string;
4586 }
4587 export interface ListTemplateVersionsResponse {
4588 TemplateVersionsResponse: TemplateVersionsResponse;
4589 }
4590 export interface ListTemplatesRequest {
4591 /**
4592 * The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4593 */
4594 NextToken?: __string;
4595 /**
4596 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.
4597 */
4598 PageSize?: __string;
4599 /**
4600 * The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
4601 */
4602 Prefix?: __string;
4603 /**
4604 * The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.
4605 */
4606 TemplateType?: __string;
4607 }
4608 export interface ListTemplatesResponse {
4609 TemplatesResponse: TemplatesResponse;
4610 }
4611 export interface Message {
4612 /**
4613 * The action to occur if a recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
4614 */
4615 Action?: Action;
4616 /**
4617 * The body of the notification message. The maximum number of characters is 200.
4618 */
4619 Body?: __string;
4620 /**
4621 * The URL of the image to display as the push-notification icon, such as the icon for the app.
4622 */
4623 ImageIconUrl?: __string;
4624 /**
4625 * The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
4626 */
4627 ImageSmallIconUrl?: __string;
4628 /**
4629 * The URL of an image to display in the push notification.
4630 */
4631 ImageUrl?: __string;
4632 /**
4633 * The JSON payload to use for a silent push notification.
4634 */
4635 JsonBody?: __string;
4636 /**
4637 * The URL of the image or video to display in the push notification.
4638 */
4639 MediaUrl?: __string;
4640 /**
4641 * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
4642 */
4643 RawContent?: __string;
4644 /**
4645 * Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
4646 */
4647 SilentPush?: __boolean;
4648 /**
4649 * The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
4650 */
4651 TimeToLive?: __integer;
4652 /**
4653 * The title to display above the notification message on a recipient's device.
4654 */
4655 Title?: __string;
4656 /**
4657 * The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
4658 */
4659 Url?: __string;
4660 }
4661 export interface MessageBody {
4662 /**
4663 * The message that's returned from the API.
4664 */
4665 Message?: __string;
4666 /**
4667 * The unique identifier for the request or response.
4668 */
4669 RequestID?: __string;
4670 }
4671 export interface MessageConfiguration {
4672 /**
4673 * The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
4674 */
4675 ADMMessage?: Message;
4676 /**
4677 * The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
4678 */
4679 APNSMessage?: Message;
4680 /**
4681 * The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
4682 */
4683 BaiduMessage?: Message;
4684 /**
4685 * The default message that the campaign sends through all the channels that are configured for the campaign.
4686 */
4687 DefaultMessage?: Message;
4688 /**
4689 * The message that the campaign sends through the email channel.
4690 */
4691 EmailMessage?: CampaignEmailMessage;
4692 /**
4693 * The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
4694 */
4695 GCMMessage?: Message;
4696 /**
4697 * The message that the campaign sends through the SMS channel.
4698 */
4699 SMSMessage?: CampaignSmsMessage;
4700 }
4701 export interface MessageRequest {
4702 /**
4703 * A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
4704 */
4705 Addresses?: MapOfAddressConfiguration;
4706 /**
4707 * A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
4708 */
4709 Context?: MapOf__string;
4710 /**
4711 * A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
4712 */
4713 Endpoints?: MapOfEndpointSendConfiguration;
4714 /**
4715 * The settings and content for the default message and any default messages that you defined for specific channels.
4716 */
4717 MessageConfiguration: DirectMessageConfiguration;
4718 /**
4719 * The message template to use for the message.
4720 */
4721 TemplateConfiguration?: TemplateConfiguration;
4722 /**
4723 * The unique identifier for tracing the message. This identifier is visible to message recipients.
4724 */
4725 TraceId?: __string;
4726 }
4727 export interface MessageResponse {
4728 /**
4729 * The unique identifier for the application that was used to send the message.
4730 */
4731 ApplicationId: __string;
4732 /**
4733 * A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
4734 */
4735 EndpointResult?: MapOfEndpointMessageResult;
4736 /**
4737 * The identifier for the original request that the message was delivered for.
4738 */
4739 RequestId?: __string;
4740 /**
4741 * A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
4742 */
4743 Result?: MapOfMessageResult;
4744 }
4745 export interface MessageResult {
4746 /**
4747 * The delivery status of the message. Possible values are: DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again. OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again. PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again. SUCCESSFUL - The message was successfully delivered to the endpoint address. TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again. THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address. TIMEOUT - The message couldn't be sent within the timeout period. UNKNOWN_FAILURE - An unknown error occurred.
4748 */
4749 DeliveryStatus: DeliveryStatus;
4750 /**
4751 * The unique identifier for the message that was sent.
4752 */
4753 MessageId?: __string;
4754 /**
4755 * The downstream service status code for delivering the message.
4756 */
4757 StatusCode: __integer;
4758 /**
4759 * The status message for delivering the message.
4760 */
4761 StatusMessage?: __string;
4762 /**
4763 * For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
4764 */
4765 UpdatedToken?: __string;
4766 }
4767 export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string;
4768 export interface MetricDimension {
4769 /**
4770 * The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
4771 */
4772 ComparisonOperator: __string;
4773 /**
4774 * The value to compare.
4775 */
4776 Value: __double;
4777 }
4778 export type Mode = "DELIVERY"|"FILTER"|string;
4779 export interface MultiConditionalBranch {
4780 /**
4781 * The condition to evaluate for the activity path.
4782 */
4783 Condition?: SimpleCondition;
4784 /**
4785 * The unique identifier for the next activity to perform, after completing the activity for the path.
4786 */
4787 NextActivity?: __string;
4788 }
4789 export interface MultiConditionalSplitActivity {
4790 /**
4791 * The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
4792 */
4793 Branches?: ListOfMultiConditionalBranch;
4794 /**
4795 * The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
4796 */
4797 DefaultActivity?: __string;
4798 /**
4799 * The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
4800 */
4801 EvaluationWaitTime?: WaitTime;
4802 }
4803 export interface NumberValidateRequest {
4804 /**
4805 * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
4806 */
4807 IsoCountryCode?: __string;
4808 /**
4809 * The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
4810 */
4811 PhoneNumber?: __string;
4812 }
4813 export interface NumberValidateResponse {
4814 /**
4815 * The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
4816 */
4817 Carrier?: __string;
4818 /**
4819 * The name of the city where the phone number was originally registered.
4820 */
4821 City?: __string;
4822 /**
4823 * The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
4824 */
4825 CleansedPhoneNumberE164?: __string;
4826 /**
4827 * The cleansed phone number, in the format for the location where the phone number was originally registered.
4828 */
4829 CleansedPhoneNumberNational?: __string;
4830 /**
4831 * The name of the country or region where the phone number was originally registered.
4832 */
4833 Country?: __string;
4834 /**
4835 * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
4836 */
4837 CountryCodeIso2?: __string;
4838 /**
4839 * The numeric code for the country or region where the phone number was originally registered.
4840 */
4841 CountryCodeNumeric?: __string;
4842 /**
4843 * The name of the county where the phone number was originally registered.
4844 */
4845 County?: __string;
4846 /**
4847 * The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
4848 */
4849 OriginalCountryCodeIso2?: __string;
4850 /**
4851 * The phone number that was sent in the request body.
4852 */
4853 OriginalPhoneNumber?: __string;
4854 /**
4855 * The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
4856 INVALID, PREPAID, and OTHER.
4857 */
4858 PhoneType?: __string;
4859 /**
4860 * The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
4861 */
4862 PhoneTypeCode?: __integer;
4863 /**
4864 * The time zone for the location where the phone number was originally registered.
4865 */
4866 Timezone?: __string;
4867 /**
4868 * The postal or ZIP code for the location where the phone number was originally registered.
4869 */
4870 ZipCode?: __string;
4871 }
4872 export type Operator = "ALL"|"ANY"|string;
4873 export interface PhoneNumberValidateRequest {
4874 NumberValidateRequest: NumberValidateRequest;
4875 }
4876 export interface PhoneNumberValidateResponse {
4877 NumberValidateResponse: NumberValidateResponse;
4878 }
4879 export interface PublicEndpoint {
4880 /**
4881 * The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
4882 */
4883 Address?: __string;
4884 /**
4885 * One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
4886 */
4887 Attributes?: MapOfListOf__string;
4888 /**
4889 * The channel that's used when sending messages or push notifications to the endpoint.
4890 */
4891 ChannelType?: ChannelType;
4892 /**
4893 * The demographic information for the endpoint, such as the time zone and platform.
4894 */
4895 Demographic?: EndpointDemographic;
4896 /**
4897 * The date and time, in ISO 8601 format, when the endpoint was last updated.
4898 */
4899 EffectiveDate?: __string;
4900 /**
4901 * Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
4902 */
4903 EndpointStatus?: __string;
4904 /**
4905 * The geographic information for the endpoint.
4906 */
4907 Location?: EndpointLocation;
4908 /**
4909 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
4910 */
4911 Metrics?: MapOf__double;
4912 /**
4913 * Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
4914 */
4915 OptOut?: __string;
4916 /**
4917 * A unique identifier that's generated each time the endpoint is updated.
4918 */
4919 RequestId?: __string;
4920 /**
4921 * One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
4922 */
4923 User?: EndpointUser;
4924 }
4925 export interface PushNotificationTemplateRequest {
4926 /**
4927 * The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4928 */
4929 ADM?: AndroidPushNotificationTemplate;
4930 /**
4931 * The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4932 */
4933 APNS?: APNSPushNotificationTemplate;
4934 /**
4935 * The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4936 */
4937 Baidu?: AndroidPushNotificationTemplate;
4938 /**
4939 * The default message template to use for push notification channels.
4940 */
4941 Default?: DefaultPushNotificationTemplate;
4942 /**
4943 * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
4944 */
4945 DefaultSubstitutions?: __string;
4946 /**
4947 * The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4948 */
4949 GCM?: AndroidPushNotificationTemplate;
4950 /**
4951 * The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
4952 */
4953 RecommenderId?: __string;
4954 /**
4955 * A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
4956 */
4957 tags?: MapOf__string;
4958 /**
4959 * A custom description of the message template.
4960 */
4961 TemplateDescription?: __string;
4962 }
4963 export interface PushNotificationTemplateResponse {
4964 /**
4965 * The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4966 */
4967 ADM?: AndroidPushNotificationTemplate;
4968 /**
4969 * The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4970 */
4971 APNS?: APNSPushNotificationTemplate;
4972 /**
4973 * The Amazon Resource Name (ARN) of the message template.
4974 */
4975 Arn?: __string;
4976 /**
4977 * The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4978 */
4979 Baidu?: AndroidPushNotificationTemplate;
4980 /**
4981 * The date, in ISO 8601 format, when the message template was created.
4982 */
4983 CreationDate: __string;
4984 /**
4985 * The default message template that's used for push notification channels.
4986 */
4987 Default?: DefaultPushNotificationTemplate;
4988 /**
4989 * The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
4990 */
4991 DefaultSubstitutions?: __string;
4992 /**
4993 * The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4994 */
4995 GCM?: AndroidPushNotificationTemplate;
4996 /**
4997 * The date, in ISO 8601 format, when the message template was last modified.
4998 */
4999 LastModifiedDate: __string;
5000 /**
5001 * The unique identifier for the recommender model that's used by the message template.
5002 */
5003 RecommenderId?: __string;
5004 /**
5005 * A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
5006 */
5007 tags?: MapOf__string;
5008 /**
5009 * The custom description of the message template.
5010 */
5011 TemplateDescription?: __string;
5012 /**
5013 * The name of the message template.
5014 */
5015 TemplateName: __string;
5016 /**
5017 * The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
5018 */
5019 TemplateType: TemplateType;
5020 /**
5021 * The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
5022 */
5023 Version?: __string;
5024 }
5025 export interface PutEventStreamRequest {
5026 /**
5027 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5028 */
5029 ApplicationId: __string;
5030 WriteEventStream: WriteEventStream;
5031 }
5032 export interface PutEventStreamResponse {
5033 EventStream: EventStream;
5034 }
5035 export interface PutEventsRequest {
5036 /**
5037 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5038 */
5039 ApplicationId: __string;
5040 EventsRequest: EventsRequest;
5041 }
5042 export interface PutEventsResponse {
5043 EventsResponse: EventsResponse;
5044 }
5045 export interface QuietTime {
5046 /**
5047 * The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
5048 */
5049 End?: __string;
5050 /**
5051 * The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
5052 */
5053 Start?: __string;
5054 }
5055 export interface RandomSplitActivity {
5056 /**
5057 * The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
5058 */
5059 Branches?: ListOfRandomSplitEntry;
5060 }
5061 export interface RandomSplitEntry {
5062 /**
5063 * The unique identifier for the next activity to perform, after completing the activity for the path.
5064 */
5065 NextActivity?: __string;
5066 /**
5067 * The percentage of participants to send down the activity path. To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
5068 */
5069 Percentage?: __integer;
5070 }
5071 export interface RawEmail {
5072 /**
5073 * The email message, represented as a raw MIME message. The entire message must be base64 encoded.
5074 */
5075 Data?: __blob;
5076 }
5077 export type __blob = Buffer|Uint8Array|Blob|string;
5078 export interface RecencyDimension {
5079 /**
5080 * The duration to use when determining whether an endpoint is active or inactive.
5081 */
5082 Duration: Duration;
5083 /**
5084 * The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
5085 */
5086 RecencyType: RecencyType;
5087 }
5088 export type RecencyType = "ACTIVE"|"INACTIVE"|string;
5089 export interface RecommenderConfigurationResponse {
5090 /**
5091 * A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
5092 */
5093 Attributes?: MapOf__string;
5094 /**
5095 * The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
5096 */
5097 CreationDate: __string;
5098 /**
5099 * The custom description of the configuration for the recommender model.
5100 */
5101 Description?: __string;
5102 /**
5103 * The unique identifier for the recommender model configuration.
5104 */
5105 Id: __string;
5106 /**
5107 * The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
5108 */
5109 LastModifiedDate: __string;
5110 /**
5111 * The custom name of the configuration for the recommender model.
5112 */
5113 Name?: __string;
5114 /**
5115 * The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are: PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
5116 */
5117 RecommendationProviderIdType?: __string;
5118 /**
5119 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
5120 */
5121 RecommendationProviderRoleArn: __string;
5122 /**
5123 * The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
5124 */
5125 RecommendationProviderUri: __string;
5126 /**
5127 * The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
5128 */
5129 RecommendationTransformerUri?: __string;
5130 /**
5131 * The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
5132 */
5133 RecommendationsDisplayName?: __string;
5134 /**
5135 * The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates.
5136 */
5137 RecommendationsPerMessage?: __integer;
5138 }
5139 export interface RemoveAttributesRequest {
5140 /**
5141 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5142 */
5143 ApplicationId: __string;
5144 /**
5145 * The type of attribute or attributes to remove. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel. endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart. endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
5146 */
5147 AttributeType: __string;
5148 UpdateAttributesRequest: UpdateAttributesRequest;
5149 }
5150 export interface RemoveAttributesResponse {
5151 AttributesResource: AttributesResource;
5152 }
5153 export interface ResultRow {
5154 /**
5155 * An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
5156 */
5157 GroupedBys: ListOfResultRowValue;
5158 /**
5159 * An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
5160 */
5161 Values: ListOfResultRowValue;
5162 }
5163 export interface ResultRowValue {
5164 /**
5165 * The friendly name of the metric whose value is specified by the Value property.
5166 */
5167 Key: __string;
5168 /**
5169 * The data type of the value specified by the Value property.
5170 */
5171 Type: __string;
5172 /**
5173 * In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
5174 */
5175 Value: __string;
5176 }
5177 export interface SMSChannelRequest {
5178 /**
5179 * Specifies whether to enable the SMS channel for the application.
5180 */
5181 Enabled?: __boolean;
5182 /**
5183 * The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
5184 */
5185 SenderId?: __string;
5186 /**
5187 * The registered short code that you want to use when you send messages through the SMS channel.
5188 */
5189 ShortCode?: __string;
5190 }
5191 export interface SMSChannelResponse {
5192 /**
5193 * The unique identifier for the application that the SMS channel applies to.
5194 */
5195 ApplicationId?: __string;
5196 /**
5197 * The date and time, in ISO 8601 format, when the SMS channel was enabled.
5198 */
5199 CreationDate?: __string;
5200 /**
5201 * Specifies whether the SMS channel is enabled for the application.
5202 */
5203 Enabled?: __boolean;
5204 /**
5205 * (Not used) This property is retained only for backward compatibility.
5206 */
5207 HasCredential?: __boolean;
5208 /**
5209 * (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
5210 */
5211 Id?: __string;
5212 /**
5213 * Specifies whether the SMS channel is archived.
5214 */
5215 IsArchived?: __boolean;
5216 /**
5217 * The user who last modified the SMS channel.
5218 */
5219 LastModifiedBy?: __string;
5220 /**
5221 * The date and time, in ISO 8601 format, when the SMS channel was last modified.
5222 */
5223 LastModifiedDate?: __string;
5224 /**
5225 * The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
5226 */
5227 Platform: __string;
5228 /**
5229 * The maximum number of promotional messages that you can send through the SMS channel each second.
5230 */
5231 PromotionalMessagesPerSecond?: __integer;
5232 /**
5233 * The identity that displays on recipients' devices when they receive messages from the SMS channel.
5234 */
5235 SenderId?: __string;
5236 /**
5237 * The registered short code to use when you send messages through the SMS channel.
5238 */
5239 ShortCode?: __string;
5240 /**
5241 * The maximum number of transactional messages that you can send through the SMS channel each second.
5242 */
5243 TransactionalMessagesPerSecond?: __integer;
5244 /**
5245 * The current version of the SMS channel.
5246 */
5247 Version?: __integer;
5248 }
5249 export interface SMSMessage {
5250 /**
5251 * The body of the SMS message.
5252 */
5253 Body?: __string;
5254 /**
5255 * The SMS program name that you provided to AWS Support when you requested your dedicated number.
5256 */
5257 Keyword?: __string;
5258 /**
5259 * The URL of an image or video to display in the SMS message.
5260 */
5261 MediaUrl?: __string;
5262 /**
5263 * The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
5264 */
5265 MessageType?: MessageType;
5266 /**
5267 * The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
5268 */
5269 OriginationNumber?: __string;
5270 /**
5271 * The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
5272 */
5273 SenderId?: __string;
5274 /**
5275 * The message variables to use in the SMS message. You can override the default variables with individual address variables.
5276 */
5277 Substitutions?: MapOfListOf__string;
5278 }
5279 export interface SMSTemplateRequest {
5280 /**
5281 * The message body to use in text messages that are based on the message template.
5282 */
5283 Body?: __string;
5284 /**
5285 * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
5286 */
5287 DefaultSubstitutions?: __string;
5288 /**
5289 * The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
5290 */
5291 RecommenderId?: __string;
5292 /**
5293 * A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
5294 */
5295 tags?: MapOf__string;
5296 /**
5297 * A custom description of the message template.
5298 */
5299 TemplateDescription?: __string;
5300 }
5301 export interface SMSTemplateResponse {
5302 /**
5303 * The Amazon Resource Name (ARN) of the message template.
5304 */
5305 Arn?: __string;
5306 /**
5307 * The message body that's used in text messages that are based on the message template.
5308 */
5309 Body?: __string;
5310 /**
5311 * The date, in ISO 8601 format, when the message template was created.
5312 */
5313 CreationDate: __string;
5314 /**
5315 * The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
5316 */
5317 DefaultSubstitutions?: __string;
5318 /**
5319 * The date, in ISO 8601 format, when the message template was last modified.
5320 */
5321 LastModifiedDate: __string;
5322 /**
5323 * The unique identifier for the recommender model that's used by the message template.
5324 */
5325 RecommenderId?: __string;
5326 /**
5327 * A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
5328 */
5329 tags?: MapOf__string;
5330 /**
5331 * The custom description of the message template.
5332 */
5333 TemplateDescription?: __string;
5334 /**
5335 * The name of the message template.
5336 */
5337 TemplateName: __string;
5338 /**
5339 * The type of channel that the message template is designed for. For an SMS template, this value is SMS.
5340 */
5341 TemplateType: TemplateType;
5342 /**
5343 * The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
5344 */
5345 Version?: __string;
5346 }
5347 export interface Schedule {
5348 /**
5349 * The scheduled time, in ISO 8601 format, when the campaign ended or will end.
5350 */
5351 EndTime?: __string;
5352 /**
5353 * The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
5354 */
5355 EventFilter?: CampaignEventFilter;
5356 /**
5357 * Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
5358 */
5359 Frequency?: Frequency;
5360 /**
5361 * Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
5362 */
5363 IsLocalTime?: __boolean;
5364 /**
5365 * The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign. The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign. If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
5366 */
5367 QuietTime?: QuietTime;
5368 /**
5369 * The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
5370 */
5371 StartTime: __string;
5372 /**
5373 * The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,
5374 UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,
5375 UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,
5376 UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
5377 */
5378 Timezone?: __string;
5379 }
5380 export interface SegmentBehaviors {
5381 /**
5382 * The dimension settings that are based on how recently an endpoint was active.
5383 */
5384 Recency?: RecencyDimension;
5385 }
5386 export interface SegmentCondition {
5387 /**
5388 * The unique identifier for the segment to associate with the activity.
5389 */
5390 SegmentId: __string;
5391 }
5392 export interface SegmentDemographics {
5393 /**
5394 * The app version criteria for the segment.
5395 */
5396 AppVersion?: SetDimension;
5397 /**
5398 * The channel criteria for the segment.
5399 */
5400 Channel?: SetDimension;
5401 /**
5402 * The device type criteria for the segment.
5403 */
5404 DeviceType?: SetDimension;
5405 /**
5406 * The device make criteria for the segment.
5407 */
5408 Make?: SetDimension;
5409 /**
5410 * The device model criteria for the segment.
5411 */
5412 Model?: SetDimension;
5413 /**
5414 * The device platform criteria for the segment.
5415 */
5416 Platform?: SetDimension;
5417 }
5418 export interface SegmentDimensions {
5419 /**
5420 * One or more custom attributes to use as criteria for the segment.
5421 */
5422 Attributes?: MapOfAttributeDimension;
5423 /**
5424 * The behavior-based criteria, such as how recently users have used your app, for the segment.
5425 */
5426 Behavior?: SegmentBehaviors;
5427 /**
5428 * The demographic-based criteria, such as device platform, for the segment.
5429 */
5430 Demographic?: SegmentDemographics;
5431 /**
5432 * The location-based criteria, such as region or GPS coordinates, for the segment.
5433 */
5434 Location?: SegmentLocation;
5435 /**
5436 * One or more custom metrics to use as criteria for the segment.
5437 */
5438 Metrics?: MapOfMetricDimension;
5439 /**
5440 * One or more custom user attributes to use as criteria for the segment.
5441 */
5442 UserAttributes?: MapOfAttributeDimension;
5443 }
5444 export interface SegmentGroup {
5445 /**
5446 * An array that defines the dimensions for the segment.
5447 */
5448 Dimensions?: ListOfSegmentDimensions;
5449 /**
5450 * The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
5451 */
5452 SourceSegments?: ListOfSegmentReference;
5453 /**
5454 * Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
5455 */
5456 SourceType?: SourceType;
5457 /**
5458 * Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
5459 */
5460 Type?: Type;
5461 }
5462 export interface SegmentGroupList {
5463 /**
5464 * An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
5465 */
5466 Groups?: ListOfSegmentGroup;
5467 /**
5468 * Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
5469 */
5470 Include?: Include;
5471 }
5472 export interface SegmentImportResource {
5473 /**
5474 * The number of channel types in the endpoint definitions that were imported to create the segment.
5475 */
5476 ChannelCounts?: MapOf__integer;
5477 /**
5478 * (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
5479 */
5480 ExternalId: __string;
5481 /**
5482 * The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
5483 */
5484 Format: Format;
5485 /**
5486 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
5487 */
5488 RoleArn: __string;
5489 /**
5490 * The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
5491 */
5492 S3Url: __string;
5493 /**
5494 * The number of endpoint definitions that were imported successfully to create the segment.
5495 */
5496 Size: __integer;
5497 }
5498 export interface SegmentLocation {
5499 /**
5500 * The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
5501 */
5502 Country?: SetDimension;
5503 /**
5504 * The GPS location and range for the segment.
5505 */
5506 GPSPoint?: GPSPointDimension;
5507 }
5508 export interface SegmentReference {
5509 /**
5510 * The unique identifier for the segment.
5511 */
5512 Id: __string;
5513 /**
5514 * The version number of the segment.
5515 */
5516 Version?: __integer;
5517 }
5518 export interface SegmentResponse {
5519 /**
5520 * The unique identifier for the application that the segment is associated with.
5521 */
5522 ApplicationId: __string;
5523 /**
5524 * The Amazon Resource Name (ARN) of the segment.
5525 */
5526 Arn: __string;
5527 /**
5528 * The date and time when the segment was created.
5529 */
5530 CreationDate: __string;
5531 /**
5532 * The dimension settings for the segment.
5533 */
5534 Dimensions?: SegmentDimensions;
5535 /**
5536 * The unique identifier for the segment.
5537 */
5538 Id: __string;
5539 /**
5540 * The settings for the import job that's associated with the segment.
5541 */
5542 ImportDefinition?: SegmentImportResource;
5543 /**
5544 * The date and time when the segment was last modified.
5545 */
5546 LastModifiedDate?: __string;
5547 /**
5548 * The name of the segment.
5549 */
5550 Name?: __string;
5551 /**
5552 * A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
5553 */
5554 SegmentGroups?: SegmentGroupList;
5555 /**
5556 * The segment type. Valid values are: DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time. IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
5557 */
5558 SegmentType: SegmentType;
5559 /**
5560 * A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
5561 */
5562 tags?: MapOf__string;
5563 /**
5564 * The version number of the segment.
5565 */
5566 Version?: __integer;
5567 }
5568 export type SegmentType = "DIMENSIONAL"|"IMPORT"|string;
5569 export interface SegmentsResponse {
5570 /**
5571 * An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
5572 */
5573 Item: ListOfSegmentResponse;
5574 /**
5575 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
5576 */
5577 NextToken?: __string;
5578 }
5579 export interface SendMessagesRequest {
5580 /**
5581 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5582 */
5583 ApplicationId: __string;
5584 MessageRequest: MessageRequest;
5585 }
5586 export interface SendMessagesResponse {
5587 MessageResponse: MessageResponse;
5588 }
5589 export interface SendUsersMessageRequest {
5590 /**
5591 * A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
5592 */
5593 Context?: MapOf__string;
5594 /**
5595 * The settings and content for the default message and any default messages that you defined for specific channels.
5596 */
5597 MessageConfiguration: DirectMessageConfiguration;
5598 /**
5599 * The message template to use for the message.
5600 */
5601 TemplateConfiguration?: TemplateConfiguration;
5602 /**
5603 * The unique identifier for tracing the message. This identifier is visible to message recipients.
5604 */
5605 TraceId?: __string;
5606 /**
5607 * A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
5608 */
5609 Users: MapOfEndpointSendConfiguration;
5610 }
5611 export interface SendUsersMessageResponse {
5612 /**
5613 * The unique identifier for the application that was used to send the message.
5614 */
5615 ApplicationId: __string;
5616 /**
5617 * The unique identifier that was assigned to the message request.
5618 */
5619 RequestId?: __string;
5620 /**
5621 * An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
5622 */
5623 Result?: MapOfMapOfEndpointMessageResult;
5624 }
5625 export interface SendUsersMessagesRequest {
5626 /**
5627 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5628 */
5629 ApplicationId: __string;
5630 SendUsersMessageRequest: SendUsersMessageRequest;
5631 }
5632 export interface SendUsersMessagesResponse {
5633 SendUsersMessageResponse: SendUsersMessageResponse;
5634 }
5635 export interface Session {
5636 /**
5637 * The duration of the session, in milliseconds.
5638 */
5639 Duration?: __integer;
5640 /**
5641 * The unique identifier for the session.
5642 */
5643 Id: __string;
5644 /**
5645 * The date and time when the session began.
5646 */
5647 StartTimestamp: __string;
5648 /**
5649 * The date and time when the session ended.
5650 */
5651 StopTimestamp?: __string;
5652 }
5653 export interface SetDimension {
5654 /**
5655 * The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
5656 */
5657 DimensionType?: DimensionType;
5658 /**
5659 * The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
5660 */
5661 Values: ListOf__string;
5662 }
5663 export interface SimpleCondition {
5664 /**
5665 * The dimension settings for the event that's associated with the activity.
5666 */
5667 EventCondition?: EventCondition;
5668 /**
5669 * The segment that's associated with the activity.
5670 */
5671 SegmentCondition?: SegmentCondition;
5672 /**
5673 * The dimension settings for the segment that's associated with the activity.
5674 */
5675 SegmentDimensions?: SegmentDimensions;
5676 }
5677 export interface SimpleEmail {
5678 /**
5679 * The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
5680 */
5681 HtmlPart?: SimpleEmailPart;
5682 /**
5683 * The subject line, or title, of the email.
5684 */
5685 Subject?: SimpleEmailPart;
5686 /**
5687 * The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
5688 */
5689 TextPart?: SimpleEmailPart;
5690 }
5691 export interface SimpleEmailPart {
5692 /**
5693 * The applicable character set for the message content.
5694 */
5695 Charset?: __string;
5696 /**
5697 * The textual data of the message content.
5698 */
5699 Data?: __string;
5700 }
5701 export type SourceType = "ALL"|"ANY"|"NONE"|string;
5702 export interface StartCondition {
5703 /**
5704 * The custom description of the condition.
5705 */
5706 Description?: __string;
5707 /**
5708 * The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
5709 */
5710 SegmentStartCondition?: SegmentCondition;
5711 }
5712 export type State = "DRAFT"|"ACTIVE"|"COMPLETED"|"CANCELLED"|"CLOSED"|string;
5713 export interface TagResourceRequest {
5714 /**
5715 * The Amazon Resource Name (ARN) of the resource.
5716 */
5717 ResourceArn: __string;
5718 TagsModel: TagsModel;
5719 }
5720 export interface TagsModel {
5721 /**
5722 * A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
5723 */
5724 tags: MapOf__string;
5725 }
5726 export interface Template {
5727 /**
5728 * The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
5729 */
5730 Name?: __string;
5731 /**
5732 * The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
5733 */
5734 Version?: __string;
5735 }
5736 export interface TemplateActiveVersionRequest {
5737 /**
5738 * The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
5739 */
5740 Version?: __string;
5741 }
5742 export interface TemplateConfiguration {
5743 /**
5744 * The email template to use for the message.
5745 */
5746 EmailTemplate?: Template;
5747 /**
5748 * The push notification template to use for the message.
5749 */
5750 PushTemplate?: Template;
5751 /**
5752 * The SMS template to use for the message.
5753 */
5754 SMSTemplate?: Template;
5755 /**
5756 * The voice template to use for the message. This object isn't supported for campaigns.
5757 */
5758 VoiceTemplate?: Template;
5759 }
5760 export interface TemplateResponse {
5761 /**
5762 * The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
5763 */
5764 Arn?: __string;
5765 /**
5766 * The date, in ISO 8601 format, when the message template was created.
5767 */
5768 CreationDate: __string;
5769 /**
5770 * The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
5771 */
5772 DefaultSubstitutions?: __string;
5773 /**
5774 * The date, in ISO 8601 format, when the message template was last modified.
5775 */
5776 LastModifiedDate: __string;
5777 /**
5778 * A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
5779 */
5780 tags?: MapOf__string;
5781 /**
5782 * The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
5783 */
5784 TemplateDescription?: __string;
5785 /**
5786 * The name of the message template.
5787 */
5788 TemplateName: __string;
5789 /**
5790 * The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
5791 */
5792 TemplateType: TemplateType;
5793 /**
5794 * The unique identifier, as an integer, for the active version of the message template.
5795 */
5796 Version?: __string;
5797 }
5798 export type TemplateType = "EMAIL"|"SMS"|"VOICE"|"PUSH"|string;
5799 export interface TemplateVersionResponse {
5800 /**
5801 * The date, in ISO 8601 format, when the version of the message template was created.
5802 */
5803 CreationDate: __string;
5804 /**
5805 * A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
5806 */
5807 DefaultSubstitutions?: __string;
5808 /**
5809 * The date, in ISO 8601 format, when the version of the message template was last modified.
5810 */
5811 LastModifiedDate: __string;
5812 /**
5813 * The custom description of the version of the message template.
5814 */
5815 TemplateDescription?: __string;
5816 /**
5817 * The name of the message template.
5818 */
5819 TemplateName: __string;
5820 /**
5821 * The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
5822 */
5823 TemplateType: __string;
5824 /**
5825 * The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
5826 */
5827 Version?: __string;
5828 }
5829 export interface TemplateVersionsResponse {
5830 /**
5831 * An array of responses, one for each version of the message template.
5832 */
5833 Item: ListOfTemplateVersionResponse;
5834 /**
5835 * The message that's returned from the API for the request to retrieve information about all the versions of the message template.
5836 */
5837 Message?: __string;
5838 /**
5839 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
5840 */
5841 NextToken?: __string;
5842 /**
5843 * The unique identifier for the request to retrieve information about all the versions of the message template.
5844 */
5845 RequestID?: __string;
5846 }
5847 export interface TemplatesResponse {
5848 /**
5849 * An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
5850 */
5851 Item: ListOfTemplateResponse;
5852 /**
5853 * The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
5854 */
5855 NextToken?: __string;
5856 }
5857 export interface TreatmentResource {
5858 /**
5859 * The unique identifier for the treatment.
5860 */
5861 Id: __string;
5862 /**
5863 * The message configuration settings for the treatment.
5864 */
5865 MessageConfiguration?: MessageConfiguration;
5866 /**
5867 * The schedule settings for the treatment.
5868 */
5869 Schedule?: Schedule;
5870 /**
5871 * The allocated percentage of users (segment members) that the treatment is sent to.
5872 */
5873 SizePercent: __integer;
5874 /**
5875 * The current status of the treatment.
5876 */
5877 State?: CampaignState;
5878 /**
5879 * The message template to use for the treatment.
5880 */
5881 TemplateConfiguration?: TemplateConfiguration;
5882 /**
5883 * The custom description of the treatment.
5884 */
5885 TreatmentDescription?: __string;
5886 /**
5887 * The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
5888 */
5889 TreatmentName?: __string;
5890 }
5891 export type Type = "ALL"|"ANY"|"NONE"|string;
5892 export interface UntagResourceRequest {
5893 /**
5894 * The Amazon Resource Name (ARN) of the resource.
5895 */
5896 ResourceArn: __string;
5897 /**
5898 * The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&amp;).
5899 */
5900 TagKeys: ListOf__string;
5901 }
5902 export interface UpdateAdmChannelRequest {
5903 ADMChannelRequest: ADMChannelRequest;
5904 /**
5905 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5906 */
5907 ApplicationId: __string;
5908 }
5909 export interface UpdateAdmChannelResponse {
5910 ADMChannelResponse: ADMChannelResponse;
5911 }
5912 export interface UpdateApnsChannelRequest {
5913 APNSChannelRequest: APNSChannelRequest;
5914 /**
5915 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5916 */
5917 ApplicationId: __string;
5918 }
5919 export interface UpdateApnsChannelResponse {
5920 APNSChannelResponse: APNSChannelResponse;
5921 }
5922 export interface UpdateApnsSandboxChannelRequest {
5923 APNSSandboxChannelRequest: APNSSandboxChannelRequest;
5924 /**
5925 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5926 */
5927 ApplicationId: __string;
5928 }
5929 export interface UpdateApnsSandboxChannelResponse {
5930 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
5931 }
5932 export interface UpdateApnsVoipChannelRequest {
5933 APNSVoipChannelRequest: APNSVoipChannelRequest;
5934 /**
5935 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5936 */
5937 ApplicationId: __string;
5938 }
5939 export interface UpdateApnsVoipChannelResponse {
5940 APNSVoipChannelResponse: APNSVoipChannelResponse;
5941 }
5942 export interface UpdateApnsVoipSandboxChannelRequest {
5943 APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest;
5944 /**
5945 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5946 */
5947 ApplicationId: __string;
5948 }
5949 export interface UpdateApnsVoipSandboxChannelResponse {
5950 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
5951 }
5952 export interface UpdateApplicationSettingsRequest {
5953 /**
5954 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5955 */
5956 ApplicationId: __string;
5957 WriteApplicationSettingsRequest: WriteApplicationSettingsRequest;
5958 }
5959 export interface UpdateApplicationSettingsResponse {
5960 ApplicationSettingsResource: ApplicationSettingsResource;
5961 }
5962 export interface UpdateAttributesRequest {
5963 /**
5964 * An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
5965 */
5966 Blacklist?: ListOf__string;
5967 }
5968 export interface UpdateBaiduChannelRequest {
5969 /**
5970 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5971 */
5972 ApplicationId: __string;
5973 BaiduChannelRequest: BaiduChannelRequest;
5974 }
5975 export interface UpdateBaiduChannelResponse {
5976 BaiduChannelResponse: BaiduChannelResponse;
5977 }
5978 export interface UpdateCampaignRequest {
5979 /**
5980 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5981 */
5982 ApplicationId: __string;
5983 /**
5984 * The unique identifier for the campaign.
5985 */
5986 CampaignId: __string;
5987 WriteCampaignRequest: WriteCampaignRequest;
5988 }
5989 export interface UpdateCampaignResponse {
5990 CampaignResponse: CampaignResponse;
5991 }
5992 export interface UpdateEmailChannelRequest {
5993 /**
5994 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5995 */
5996 ApplicationId: __string;
5997 EmailChannelRequest: EmailChannelRequest;
5998 }
5999 export interface UpdateEmailChannelResponse {
6000 EmailChannelResponse: EmailChannelResponse;
6001 }
6002 export interface UpdateEmailTemplateRequest {
6003 /**
6004 * Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
6005 */
6006 CreateNewVersion?: __boolean;
6007 EmailTemplateRequest: EmailTemplateRequest;
6008 /**
6009 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
6010 */
6011 TemplateName: __string;
6012 /**
6013 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
6014 */
6015 Version?: __string;
6016 }
6017 export interface UpdateEmailTemplateResponse {
6018 MessageBody: MessageBody;
6019 }
6020 export interface UpdateEndpointRequest {
6021 /**
6022 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6023 */
6024 ApplicationId: __string;
6025 /**
6026 * The unique identifier for the endpoint.
6027 */
6028 EndpointId: __string;
6029 EndpointRequest: EndpointRequest;
6030 }
6031 export interface UpdateEndpointResponse {
6032 MessageBody: MessageBody;
6033 }
6034 export interface UpdateEndpointsBatchRequest {
6035 /**
6036 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6037 */
6038 ApplicationId: __string;
6039 EndpointBatchRequest: EndpointBatchRequest;
6040 }
6041 export interface UpdateEndpointsBatchResponse {
6042 MessageBody: MessageBody;
6043 }
6044 export interface UpdateGcmChannelRequest {
6045 /**
6046 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6047 */
6048 ApplicationId: __string;
6049 GCMChannelRequest: GCMChannelRequest;
6050 }
6051 export interface UpdateGcmChannelResponse {
6052 GCMChannelResponse: GCMChannelResponse;
6053 }
6054 export interface UpdateJourneyRequest {
6055 /**
6056 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6057 */
6058 ApplicationId: __string;
6059 /**
6060 * The unique identifier for the journey.
6061 */
6062 JourneyId: __string;
6063 WriteJourneyRequest: WriteJourneyRequest;
6064 }
6065 export interface UpdateJourneyResponse {
6066 JourneyResponse: JourneyResponse;
6067 }
6068 export interface UpdateJourneyStateRequest {
6069 /**
6070 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6071 */
6072 ApplicationId: __string;
6073 /**
6074 * The unique identifier for the journey.
6075 */
6076 JourneyId: __string;
6077 JourneyStateRequest: JourneyStateRequest;
6078 }
6079 export interface UpdateJourneyStateResponse {
6080 JourneyResponse: JourneyResponse;
6081 }
6082 export interface UpdatePushTemplateRequest {
6083 /**
6084 * Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
6085 */
6086 CreateNewVersion?: __boolean;
6087 PushNotificationTemplateRequest: PushNotificationTemplateRequest;
6088 /**
6089 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
6090 */
6091 TemplateName: __string;
6092 /**
6093 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
6094 */
6095 Version?: __string;
6096 }
6097 export interface UpdatePushTemplateResponse {
6098 MessageBody: MessageBody;
6099 }
6100 export interface UpdateRecommenderConfiguration {
6101 /**
6102 * A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names: An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique. An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.
6103 */
6104 Attributes?: MapOf__string;
6105 /**
6106 * A custom description of the configuration for the recommender model. The description can contain up to 128 characters.
6107 */
6108 Description?: __string;
6109 /**
6110 * A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
6111 */
6112 Name?: __string;
6113 /**
6114 * The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are: PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
6115 */
6116 RecommendationProviderIdType?: __string;
6117 /**
6118 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
6119 */
6120 RecommendationProviderRoleArn: __string;
6121 /**
6122 * The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
6123 */
6124 RecommendationProviderUri: __string;
6125 /**
6126 * The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
6127 */
6128 RecommendationTransformerUri?: __string;
6129 /**
6130 * A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data. This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
6131 */
6132 RecommendationsDisplayName?: __string;
6133 /**
6134 * The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5. To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.
6135 */
6136 RecommendationsPerMessage?: __integer;
6137 }
6138 export interface UpdateRecommenderConfigurationRequest {
6139 /**
6140 * The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
6141 */
6142 RecommenderId: __string;
6143 UpdateRecommenderConfiguration: UpdateRecommenderConfiguration;
6144 }
6145 export interface UpdateRecommenderConfigurationResponse {
6146 RecommenderConfigurationResponse: RecommenderConfigurationResponse;
6147 }
6148 export interface UpdateSegmentRequest {
6149 /**
6150 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6151 */
6152 ApplicationId: __string;
6153 /**
6154 * The unique identifier for the segment.
6155 */
6156 SegmentId: __string;
6157 WriteSegmentRequest: WriteSegmentRequest;
6158 }
6159 export interface UpdateSegmentResponse {
6160 SegmentResponse: SegmentResponse;
6161 }
6162 export interface UpdateSmsChannelRequest {
6163 /**
6164 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6165 */
6166 ApplicationId: __string;
6167 SMSChannelRequest: SMSChannelRequest;
6168 }
6169 export interface UpdateSmsChannelResponse {
6170 SMSChannelResponse: SMSChannelResponse;
6171 }
6172 export interface UpdateSmsTemplateRequest {
6173 /**
6174 * Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
6175 */
6176 CreateNewVersion?: __boolean;
6177 SMSTemplateRequest: SMSTemplateRequest;
6178 /**
6179 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
6180 */
6181 TemplateName: __string;
6182 /**
6183 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
6184 */
6185 Version?: __string;
6186 }
6187 export interface UpdateSmsTemplateResponse {
6188 MessageBody: MessageBody;
6189 }
6190 export interface UpdateTemplateActiveVersionRequest {
6191 TemplateActiveVersionRequest: TemplateActiveVersionRequest;
6192 /**
6193 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
6194 */
6195 TemplateName: __string;
6196 /**
6197 * The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
6198 */
6199 TemplateType: __string;
6200 }
6201 export interface UpdateTemplateActiveVersionResponse {
6202 MessageBody: MessageBody;
6203 }
6204 export interface UpdateVoiceChannelRequest {
6205 /**
6206 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
6207 */
6208 ApplicationId: __string;
6209 VoiceChannelRequest: VoiceChannelRequest;
6210 }
6211 export interface UpdateVoiceChannelResponse {
6212 VoiceChannelResponse: VoiceChannelResponse;
6213 }
6214 export interface UpdateVoiceTemplateRequest {
6215 /**
6216 * Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
6217 */
6218 CreateNewVersion?: __boolean;
6219 /**
6220 * The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
6221 */
6222 TemplateName: __string;
6223 /**
6224 * The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
6225 */
6226 Version?: __string;
6227 VoiceTemplateRequest: VoiceTemplateRequest;
6228 }
6229 export interface UpdateVoiceTemplateResponse {
6230 MessageBody: MessageBody;
6231 }
6232 export interface VoiceChannelRequest {
6233 /**
6234 * Specifies whether to enable the voice channel for the application.
6235 */
6236 Enabled?: __boolean;
6237 }
6238 export interface VoiceChannelResponse {
6239 /**
6240 * The unique identifier for the application that the voice channel applies to.
6241 */
6242 ApplicationId?: __string;
6243 /**
6244 * The date and time, in ISO 8601 format, when the voice channel was enabled.
6245 */
6246 CreationDate?: __string;
6247 /**
6248 * Specifies whether the voice channel is enabled for the application.
6249 */
6250 Enabled?: __boolean;
6251 /**
6252 * (Not used) This property is retained only for backward compatibility.
6253 */
6254 HasCredential?: __boolean;
6255 /**
6256 * (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
6257 */
6258 Id?: __string;
6259 /**
6260 * Specifies whether the voice channel is archived.
6261 */
6262 IsArchived?: __boolean;
6263 /**
6264 * The user who last modified the voice channel.
6265 */
6266 LastModifiedBy?: __string;
6267 /**
6268 * The date and time, in ISO 8601 format, when the voice channel was last modified.
6269 */
6270 LastModifiedDate?: __string;
6271 /**
6272 * The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
6273 */
6274 Platform: __string;
6275 /**
6276 * The current version of the voice channel.
6277 */
6278 Version?: __integer;
6279 }
6280 export interface VoiceMessage {
6281 /**
6282 * The text of the script to use for the voice message.
6283 */
6284 Body?: __string;
6285 /**
6286 * The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
6287 */
6288 LanguageCode?: __string;
6289 /**
6290 * The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
6291 */
6292 OriginationNumber?: __string;
6293 /**
6294 * The default message variables to use in the voice message. You can override the default variables with individual address variables.
6295 */
6296 Substitutions?: MapOfListOf__string;
6297 /**
6298 * The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
6299 */
6300 VoiceId?: __string;
6301 }
6302 export interface VoiceTemplateRequest {
6303 /**
6304 * The text of the script to use in messages that are based on the message template, in plain text format.
6305 */
6306 Body?: __string;
6307 /**
6308 * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
6309 */
6310 DefaultSubstitutions?: __string;
6311 /**
6312 * The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
6313 */
6314 LanguageCode?: __string;
6315 /**
6316 * A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
6317 */
6318 tags?: MapOf__string;
6319 /**
6320 * A custom description of the message template.
6321 */
6322 TemplateDescription?: __string;
6323 /**
6324 * The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
6325 */
6326 VoiceId?: __string;
6327 }
6328 export interface VoiceTemplateResponse {
6329 /**
6330 * The Amazon Resource Name (ARN) of the message template.
6331 */
6332 Arn?: __string;
6333 /**
6334 * The text of the script that's used in messages that are based on the message template, in plain text format.
6335 */
6336 Body?: __string;
6337 /**
6338 * The date, in ISO 8601 format, when the message template was created.
6339 */
6340 CreationDate: __string;
6341 /**
6342 * The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
6343 */
6344 DefaultSubstitutions?: __string;
6345 /**
6346 * The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
6347 */
6348 LanguageCode?: __string;
6349 /**
6350 * The date, in ISO 8601 format, when the message template was last modified.
6351 */
6352 LastModifiedDate: __string;
6353 /**
6354 * A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
6355 */
6356 tags?: MapOf__string;
6357 /**
6358 * The custom description of the message template.
6359 */
6360 TemplateDescription?: __string;
6361 /**
6362 * The name of the message template.
6363 */
6364 TemplateName: __string;
6365 /**
6366 * The type of channel that the message template is designed for. For a voice template, this value is VOICE.
6367 */
6368 TemplateType: TemplateType;
6369 /**
6370 * The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
6371 */
6372 Version?: __string;
6373 /**
6374 * The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
6375 */
6376 VoiceId?: __string;
6377 }
6378 export interface WaitActivity {
6379 /**
6380 * The unique identifier for the next activity to perform, after performing the wait activity.
6381 */
6382 NextActivity?: __string;
6383 /**
6384 * The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
6385 */
6386 WaitTime?: WaitTime;
6387 }
6388 export interface WaitTime {
6389 /**
6390 * The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
6391 */
6392 WaitFor?: __string;
6393 /**
6394 * The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
6395 */
6396 WaitUntil?: __string;
6397 }
6398 export interface WriteApplicationSettingsRequest {
6399 /**
6400 * The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
6401 */
6402 CampaignHook?: CampaignHook;
6403 /**
6404 * Specifies whether to enable application-related alarms in Amazon CloudWatch.
6405 */
6406 CloudWatchMetricsEnabled?: __boolean;
6407 /**
6408 * The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
6409 */
6410 Limits?: CampaignLimits;
6411 /**
6412 * The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled. To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
6413 */
6414 QuietTime?: QuietTime;
6415 }
6416 export interface WriteCampaignRequest {
6417 /**
6418 * An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
6419 */
6420 AdditionalTreatments?: ListOfWriteTreatmentResource;
6421 /**
6422 * A custom description of the campaign.
6423 */
6424 Description?: __string;
6425 /**
6426 * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
6427 */
6428 HoldoutPercent?: __integer;
6429 /**
6430 * The settings for the AWS Lambda function to use as a code hook for the campaign.
6431 */
6432 Hook?: CampaignHook;
6433 /**
6434 * Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
6435 */
6436 IsPaused?: __boolean;
6437 /**
6438 * The messaging limits for the campaign.
6439 */
6440 Limits?: CampaignLimits;
6441 /**
6442 * The message configuration settings for the campaign.
6443 */
6444 MessageConfiguration?: MessageConfiguration;
6445 /**
6446 * A custom name for the campaign.
6447 */
6448 Name?: __string;
6449 /**
6450 * The schedule settings for the campaign.
6451 */
6452 Schedule?: Schedule;
6453 /**
6454 * The unique identifier for the segment to associate with the campaign.
6455 */
6456 SegmentId?: __string;
6457 /**
6458 * The version of the segment to associate with the campaign.
6459 */
6460 SegmentVersion?: __integer;
6461 /**
6462 * A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
6463 */
6464 tags?: MapOf__string;
6465 /**
6466 * The message template to use for the campaign.
6467 */
6468 TemplateConfiguration?: TemplateConfiguration;
6469 /**
6470 * A custom description of a variation of the campaign to use for A/B testing.
6471 */
6472 TreatmentDescription?: __string;
6473 /**
6474 * A custom name for a variation of the campaign to use for A/B testing.
6475 */
6476 TreatmentName?: __string;
6477 }
6478 export interface WriteEventStream {
6479 /**
6480 * The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
6481 For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
6482
6483 */
6484 DestinationStreamArn: __string;
6485 /**
6486 * The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
6487 */
6488 RoleArn: __string;
6489 }
6490 export interface WriteJourneyRequest {
6491 /**
6492 * A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
6493 */
6494 Activities?: MapOfActivity;
6495 /**
6496 * The date, in ISO 8601 format, when the journey was created.
6497 */
6498 CreationDate?: __string;
6499 /**
6500 * The date, in ISO 8601 format, when the journey was last modified.
6501 */
6502 LastModifiedDate?: __string;
6503 /**
6504 * The messaging and entry limits for the journey.
6505 */
6506 Limits?: JourneyLimits;
6507 /**
6508 * Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
6509 */
6510 LocalTime?: __boolean;
6511 /**
6512 * The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
6513 */
6514 Name: __string;
6515 /**
6516 * The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value. The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey. The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey. If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
6517 */
6518 QuietTime?: QuietTime;
6519 /**
6520 * The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
6521 */
6522 RefreshFrequency?: __string;
6523 /**
6524 * The schedule settings for the journey.
6525 */
6526 Schedule?: JourneySchedule;
6527 /**
6528 * The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
6529 */
6530 StartActivity?: __string;
6531 /**
6532 * The segment that defines which users are participants in the journey.
6533 */
6534 StartCondition?: StartCondition;
6535 /**
6536 * The status of the journey. Valid values are: DRAFT - Saves the journey and doesn't publish it. ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it. The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.
6537 */
6538 State?: State;
6539 }
6540 export interface WriteSegmentRequest {
6541 /**
6542 * The criteria that define the dimensions for the segment.
6543 */
6544 Dimensions?: SegmentDimensions;
6545 /**
6546 * The name of the segment.
6547 */
6548 Name?: __string;
6549 /**
6550 * The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
6551 */
6552 SegmentGroups?: SegmentGroupList;
6553 /**
6554 * A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
6555 */
6556 tags?: MapOf__string;
6557 }
6558 export interface WriteTreatmentResource {
6559 /**
6560 * The message configuration settings for the treatment.
6561 */
6562 MessageConfiguration?: MessageConfiguration;
6563 /**
6564 * The schedule settings for the treatment.
6565 */
6566 Schedule?: Schedule;
6567 /**
6568 * The allocated percentage of users (segment members) to send the treatment to.
6569 */
6570 SizePercent: __integer;
6571 /**
6572 * The message template to use for the treatment.
6573 */
6574 TemplateConfiguration?: TemplateConfiguration;
6575 /**
6576 * A custom description of the treatment.
6577 */
6578 TreatmentDescription?: __string;
6579 /**
6580 * A custom name for the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
6581 */
6582 TreatmentName?: __string;
6583 }
6584 export type __boolean = boolean;
6585 export type __double = number;
6586 export type __integer = number;
6587 export type ListOfActivityResponse = ActivityResponse[];
6588 export type ListOfApplicationResponse = ApplicationResponse[];
6589 export type ListOfCampaignResponse = CampaignResponse[];
6590 export type ListOfEndpointBatchItem = EndpointBatchItem[];
6591 export type ListOfEndpointResponse = EndpointResponse[];
6592 export type ListOfExportJobResponse = ExportJobResponse[];
6593 export type ListOfImportJobResponse = ImportJobResponse[];
6594 export type ListOfJourneyResponse = JourneyResponse[];
6595 export type ListOfMultiConditionalBranch = MultiConditionalBranch[];
6596 export type ListOfRandomSplitEntry = RandomSplitEntry[];
6597 export type ListOfRecommenderConfigurationResponse = RecommenderConfigurationResponse[];
6598 export type ListOfResultRow = ResultRow[];
6599 export type ListOfResultRowValue = ResultRowValue[];
6600 export type ListOfSegmentDimensions = SegmentDimensions[];
6601 export type ListOfSegmentGroup = SegmentGroup[];
6602 export type ListOfSegmentReference = SegmentReference[];
6603 export type ListOfSegmentResponse = SegmentResponse[];
6604 export type ListOfSimpleCondition = SimpleCondition[];
6605 export type ListOfTemplateResponse = TemplateResponse[];
6606 export type ListOfTemplateVersionResponse = TemplateVersionResponse[];
6607 export type ListOfTreatmentResource = TreatmentResource[];
6608 export type ListOfWriteTreatmentResource = WriteTreatmentResource[];
6609 export type ListOf__string = __string[];
6610 export type MapOfActivity = {[key: string]: Activity};
6611 export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration};
6612 export type MapOfAttributeDimension = {[key: string]: AttributeDimension};
6613 export type MapOfChannelResponse = {[key: string]: ChannelResponse};
6614 export type MapOfEndpointMessageResult = {[key: string]: EndpointMessageResult};
6615 export type MapOfEndpointSendConfiguration = {[key: string]: EndpointSendConfiguration};
6616 export type MapOfEvent = {[key: string]: Event};
6617 export type MapOfEventItemResponse = {[key: string]: EventItemResponse};
6618 export type MapOfEventsBatch = {[key: string]: EventsBatch};
6619 export type MapOfItemResponse = {[key: string]: ItemResponse};
6620 export type MapOfMessageResult = {[key: string]: MessageResult};
6621 export type MapOfMetricDimension = {[key: string]: MetricDimension};
6622 export type MapOf__double = {[key: string]: __double};
6623 export type MapOf__integer = {[key: string]: __integer};
6624 export type MapOfListOf__string = {[key: string]: ListOf__string};
6625 export type MapOfMapOfEndpointMessageResult = {[key: string]: MapOfEndpointMessageResult};
6626 export type MapOf__string = {[key: string]: __string};
6627 export type __string = string;
6628 export type __timestampIso8601 = Date;
6629 /**
6630 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
6631 */
6632 export type apiVersion = "2016-12-01"|"latest"|string;
6633 export interface ClientApiVersions {
6634 /**
6635 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
6636 */
6637 apiVersion?: apiVersion;
6638 }
6639 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
6640 /**
6641 * Contains interfaces for use with the Pinpoint client.
6642 */
6643 export import Types = Pinpoint;
6644}
6645export = Pinpoint;