UNPKG

255 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 that you can use in 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 that you can use in 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 message template that you can use in messages that are sent through a push notification channel.
56 */
57 createPushTemplate(params: Pinpoint.Types.CreatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
58 /**
59 * Creates a message template that you can use in messages that are sent through a push notification channel.
60 */
61 createPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
62 /**
63 * 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.
64 */
65 createSegment(params: Pinpoint.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
66 /**
67 * 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.
68 */
69 createSegment(callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
70 /**
71 * Creates a message template that you can use in messages that are sent through the SMS channel.
72 */
73 createSmsTemplate(params: Pinpoint.Types.CreateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
74 /**
75 * Creates a message template that you can use in messages that are sent through the SMS channel.
76 */
77 createSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
78 /**
79 * Disables the ADM channel for an application and deletes any existing settings for the channel.
80 */
81 deleteAdmChannel(params: Pinpoint.Types.DeleteAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
82 /**
83 * Disables the ADM channel for an application and deletes any existing settings for the channel.
84 */
85 deleteAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
86 /**
87 * Disables the APNs channel for an application and deletes any existing settings for the channel.
88 */
89 deleteApnsChannel(params: Pinpoint.Types.DeleteApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
90 /**
91 * Disables the APNs channel for an application and deletes any existing settings for the channel.
92 */
93 deleteApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
94 /**
95 * Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
96 */
97 deleteApnsSandboxChannel(params: Pinpoint.Types.DeleteApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
98 /**
99 * Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
100 */
101 deleteApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
102 /**
103 * Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
104 */
105 deleteApnsVoipChannel(params: Pinpoint.Types.DeleteApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
106 /**
107 * Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
108 */
109 deleteApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
110 /**
111 * Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
112 */
113 deleteApnsVoipSandboxChannel(params: Pinpoint.Types.DeleteApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
114 /**
115 * Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
116 */
117 deleteApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
118 /**
119 * Deletes an application.
120 */
121 deleteApp(params: Pinpoint.Types.DeleteAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
122 /**
123 * Deletes an application.
124 */
125 deleteApp(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
126 /**
127 * Disables the Baidu channel for an application and deletes any existing settings for the channel.
128 */
129 deleteBaiduChannel(params: Pinpoint.Types.DeleteBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
130 /**
131 * Disables the Baidu channel for an application and deletes any existing settings for the channel.
132 */
133 deleteBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
134 /**
135 * Deletes a campaign from an application.
136 */
137 deleteCampaign(params: Pinpoint.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
138 /**
139 * Deletes a campaign from an application.
140 */
141 deleteCampaign(callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
142 /**
143 * Disables the email channel for an application and deletes any existing settings for the channel.
144 */
145 deleteEmailChannel(params: Pinpoint.Types.DeleteEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
146 /**
147 * Disables the email channel for an application and deletes any existing settings for the channel.
148 */
149 deleteEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
150 /**
151 * Deletes a message template that was designed for use in messages that were sent through the email channel.
152 */
153 deleteEmailTemplate(params: Pinpoint.Types.DeleteEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
154 /**
155 * Deletes a message template that was designed for use in messages that were sent through the email channel.
156 */
157 deleteEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
158 /**
159 * Deletes an endpoint from an application.
160 */
161 deleteEndpoint(params: Pinpoint.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
162 /**
163 * Deletes an endpoint from an application.
164 */
165 deleteEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
166 /**
167 * Deletes the event stream for an application.
168 */
169 deleteEventStream(params: Pinpoint.Types.DeleteEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
170 /**
171 * Deletes the event stream for an application.
172 */
173 deleteEventStream(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
174 /**
175 * Disables the GCM channel for an application and deletes any existing settings for the channel.
176 */
177 deleteGcmChannel(params: Pinpoint.Types.DeleteGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
178 /**
179 * Disables the GCM channel for an application and deletes any existing settings for the channel.
180 */
181 deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
182 /**
183 * Deletes a message template that was designed for use in messages that were sent through a push notification channel.
184 */
185 deletePushTemplate(params: Pinpoint.Types.DeletePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
186 /**
187 * Deletes a message template that was designed for use in messages that were sent through a push notification channel.
188 */
189 deletePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
190 /**
191 * Deletes a segment from an application.
192 */
193 deleteSegment(params: Pinpoint.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
194 /**
195 * Deletes a segment from an application.
196 */
197 deleteSegment(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
198 /**
199 * Disables the SMS channel for an application and deletes any existing settings for the channel.
200 */
201 deleteSmsChannel(params: Pinpoint.Types.DeleteSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
202 /**
203 * Disables the SMS channel for an application and deletes any existing settings for the channel.
204 */
205 deleteSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
206 /**
207 * Deletes a message template that was designed for use in messages that were sent through the SMS channel.
208 */
209 deleteSmsTemplate(params: Pinpoint.Types.DeleteSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
210 /**
211 * Deletes a message template that was designed for use in messages that were sent through the SMS channel.
212 */
213 deleteSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
214 /**
215 * Deletes all the endpoints that are associated with a specific user ID.
216 */
217 deleteUserEndpoints(params: Pinpoint.Types.DeleteUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
218 /**
219 * Deletes all the endpoints that are associated with a specific user ID.
220 */
221 deleteUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
222 /**
223 * Disables the voice channel for an application and deletes any existing settings for the channel.
224 */
225 deleteVoiceChannel(params: Pinpoint.Types.DeleteVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
226 /**
227 * Disables the voice channel for an application and deletes any existing settings for the channel.
228 */
229 deleteVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
230 /**
231 * Retrieves information about the status and settings of the ADM channel for an application.
232 */
233 getAdmChannel(params: Pinpoint.Types.GetAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
234 /**
235 * Retrieves information about the status and settings of the ADM channel for an application.
236 */
237 getAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
238 /**
239 * Retrieves information about the status and settings of the APNs channel for an application.
240 */
241 getApnsChannel(params: Pinpoint.Types.GetApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
242 /**
243 * Retrieves information about the status and settings of the APNs channel for an application.
244 */
245 getApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
246 /**
247 * Retrieves information about the status and settings of the APNs sandbox channel for an application.
248 */
249 getApnsSandboxChannel(params: Pinpoint.Types.GetApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
250 /**
251 * Retrieves information about the status and settings of the APNs sandbox channel for an application.
252 */
253 getApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
254 /**
255 * Retrieves information about the status and settings of the APNs VoIP channel for an application.
256 */
257 getApnsVoipChannel(params: Pinpoint.Types.GetApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
258 /**
259 * Retrieves information about the status and settings of the APNs VoIP channel for an application.
260 */
261 getApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
262 /**
263 * Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
264 */
265 getApnsVoipSandboxChannel(params: Pinpoint.Types.GetApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
266 /**
267 * Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
268 */
269 getApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
270 /**
271 * Retrieves information about an application.
272 */
273 getApp(params: Pinpoint.Types.GetAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
274 /**
275 * Retrieves information about an application.
276 */
277 getApp(callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
278 /**
279 * Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
280 */
281 getApplicationDateRangeKpi(params: Pinpoint.Types.GetApplicationDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
282 /**
283 * Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
284 */
285 getApplicationDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
286 /**
287 * Retrieves information about the settings for an application.
288 */
289 getApplicationSettings(params: Pinpoint.Types.GetApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
290 /**
291 * Retrieves information about the settings for an application.
292 */
293 getApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
294 /**
295 * Retrieves information about all of your applications.
296 */
297 getApps(params: Pinpoint.Types.GetAppsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
298 /**
299 * Retrieves information about all of your applications.
300 */
301 getApps(callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
302 /**
303 * Retrieves information about the status and settings of the Baidu channel for an application.
304 */
305 getBaiduChannel(params: Pinpoint.Types.GetBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
306 /**
307 * Retrieves information about the status and settings of the Baidu channel for an application.
308 */
309 getBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
310 /**
311 * Retrieves information about the status, configuration, and other settings for a campaign.
312 */
313 getCampaign(params: Pinpoint.Types.GetCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
314 /**
315 * Retrieves information about the status, configuration, and other settings for a campaign.
316 */
317 getCampaign(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
318 /**
319 * Retrieves information about the activity performed by a campaign.
320 */
321 getCampaignActivities(params: Pinpoint.Types.GetCampaignActivitiesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
322 /**
323 * Retrieves information about the activity performed by a campaign.
324 */
325 getCampaignActivities(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
326 /**
327 * Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
328 */
329 getCampaignDateRangeKpi(params: Pinpoint.Types.GetCampaignDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
330 /**
331 * Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
332 */
333 getCampaignDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
334 /**
335 * Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
336 */
337 getCampaignVersion(params: Pinpoint.Types.GetCampaignVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
338 /**
339 * Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
340 */
341 getCampaignVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
342 /**
343 * Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.
344 */
345 getCampaignVersions(params: Pinpoint.Types.GetCampaignVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
346 /**
347 * Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.
348 */
349 getCampaignVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
350 /**
351 * Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
352 */
353 getCampaigns(params: Pinpoint.Types.GetCampaignsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
354 /**
355 * Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
356 */
357 getCampaigns(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
358 /**
359 * Retrieves information about the history and status of each channel for an application.
360 */
361 getChannels(params: Pinpoint.Types.GetChannelsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
362 /**
363 * Retrieves information about the history and status of each channel for an application.
364 */
365 getChannels(callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
366 /**
367 * Retrieves information about the status and settings of the email channel for an application.
368 */
369 getEmailChannel(params: Pinpoint.Types.GetEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
370 /**
371 * Retrieves information about the status and settings of the email channel for an application.
372 */
373 getEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
374 /**
375 * Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel.
376 */
377 getEmailTemplate(params: Pinpoint.Types.GetEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
378 /**
379 * Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel.
380 */
381 getEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
382 /**
383 * Retrieves information about the settings and attributes of a specific endpoint for an application.
384 */
385 getEndpoint(params: Pinpoint.Types.GetEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
386 /**
387 * Retrieves information about the settings and attributes of a specific endpoint for an application.
388 */
389 getEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
390 /**
391 * Retrieves information about the event stream settings for an application.
392 */
393 getEventStream(params: Pinpoint.Types.GetEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
394 /**
395 * Retrieves information about the event stream settings for an application.
396 */
397 getEventStream(callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
398 /**
399 * Retrieves information about the status and settings of a specific export job for an application.
400 */
401 getExportJob(params: Pinpoint.Types.GetExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
402 /**
403 * Retrieves information about the status and settings of a specific export job for an application.
404 */
405 getExportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
406 /**
407 * Retrieves information about the status and settings of all the export jobs for an application.
408 */
409 getExportJobs(params: Pinpoint.Types.GetExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
410 /**
411 * Retrieves information about the status and settings of all the export jobs for an application.
412 */
413 getExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
414 /**
415 * Retrieves information about the status and settings of the GCM channel for an application.
416 */
417 getGcmChannel(params: Pinpoint.Types.GetGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
418 /**
419 * Retrieves information about the status and settings of the GCM channel for an application.
420 */
421 getGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
422 /**
423 * Retrieves information about the status and settings of a specific import job for an application.
424 */
425 getImportJob(params: Pinpoint.Types.GetImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
426 /**
427 * Retrieves information about the status and settings of a specific import job for an application.
428 */
429 getImportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
430 /**
431 * Retrieves information about the status and settings of all the import jobs for an application.
432 */
433 getImportJobs(params: Pinpoint.Types.GetImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
434 /**
435 * Retrieves information about the status and settings of all the import jobs for an application.
436 */
437 getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
438 /**
439 * Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel.
440 */
441 getPushTemplate(params: Pinpoint.Types.GetPushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
442 /**
443 * Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel.
444 */
445 getPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
446 /**
447 * Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
448 */
449 getSegment(params: Pinpoint.Types.GetSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
450 /**
451 * Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
452 */
453 getSegment(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
454 /**
455 * Retrieves information about the status and settings of the export jobs for a segment.
456 */
457 getSegmentExportJobs(params: Pinpoint.Types.GetSegmentExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
458 /**
459 * Retrieves information about the status and settings of the export jobs for a segment.
460 */
461 getSegmentExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
462 /**
463 * Retrieves information about the status and settings of the import jobs for a segment.
464 */
465 getSegmentImportJobs(params: Pinpoint.Types.GetSegmentImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
466 /**
467 * Retrieves information about the status and settings of the import jobs for a segment.
468 */
469 getSegmentImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
470 /**
471 * Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
472 */
473 getSegmentVersion(params: Pinpoint.Types.GetSegmentVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
474 /**
475 * Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
476 */
477 getSegmentVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
478 /**
479 * Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.
480 */
481 getSegmentVersions(params: Pinpoint.Types.GetSegmentVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
482 /**
483 * Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.
484 */
485 getSegmentVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
486 /**
487 * Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
488 */
489 getSegments(params: Pinpoint.Types.GetSegmentsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
490 /**
491 * Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
492 */
493 getSegments(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
494 /**
495 * Retrieves information about the status and settings of the SMS channel for an application.
496 */
497 getSmsChannel(params: Pinpoint.Types.GetSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
498 /**
499 * Retrieves information about the status and settings of the SMS channel for an application.
500 */
501 getSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
502 /**
503 * Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.
504 */
505 getSmsTemplate(params: Pinpoint.Types.GetSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
506 /**
507 * Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.
508 */
509 getSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
510 /**
511 * Retrieves information about all the endpoints that are associated with a specific user ID.
512 */
513 getUserEndpoints(params: Pinpoint.Types.GetUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
514 /**
515 * Retrieves information about all the endpoints that are associated with a specific user ID.
516 */
517 getUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
518 /**
519 * Retrieves information about the status and settings of the voice channel for an application.
520 */
521 getVoiceChannel(params: Pinpoint.Types.GetVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
522 /**
523 * Retrieves information about the status and settings of the voice channel for an application.
524 */
525 getVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
526 /**
527 * Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
528 */
529 listTagsForResource(params: Pinpoint.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
530 /**
531 * Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
532 */
533 listTagsForResource(callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
534 /**
535 * Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
536 */
537 listTemplates(params: Pinpoint.Types.ListTemplatesRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
538 /**
539 * Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
540 */
541 listTemplates(callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
542 /**
543 * Retrieves information about a phone number.
544 */
545 phoneNumberValidate(params: Pinpoint.Types.PhoneNumberValidateRequest, callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
546 /**
547 * Retrieves information about a phone number.
548 */
549 phoneNumberValidate(callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
550 /**
551 * Creates a new event stream for an application or updates the settings of an existing event stream for an application.
552 */
553 putEventStream(params: Pinpoint.Types.PutEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
554 /**
555 * Creates a new event stream for an application or updates the settings of an existing event stream for an application.
556 */
557 putEventStream(callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
558 /**
559 * Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
560 */
561 putEvents(params: Pinpoint.Types.PutEventsRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
562 /**
563 * Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
564 */
565 putEvents(callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
566 /**
567 * Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
568 */
569 removeAttributes(params: Pinpoint.Types.RemoveAttributesRequest, callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
570 /**
571 * Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
572 */
573 removeAttributes(callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
574 /**
575 * Creates and sends a direct message.
576 */
577 sendMessages(params: Pinpoint.Types.SendMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
578 /**
579 * Creates and sends a direct message.
580 */
581 sendMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
582 /**
583 * Creates and sends a message to a list of users.
584 */
585 sendUsersMessages(params: Pinpoint.Types.SendUsersMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
586 /**
587 * Creates and sends a message to a list of users.
588 */
589 sendUsersMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
590 /**
591 * Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
592 */
593 tagResource(params: Pinpoint.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
594 /**
595 * Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
596 */
597 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
598 /**
599 * Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
600 */
601 untagResource(params: Pinpoint.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
602 /**
603 * Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
604 */
605 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
606 /**
607 * Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
608 */
609 updateAdmChannel(params: Pinpoint.Types.UpdateAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
610 /**
611 * Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
612 */
613 updateAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
614 /**
615 * Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
616 */
617 updateApnsChannel(params: Pinpoint.Types.UpdateApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
618 /**
619 * Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
620 */
621 updateApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
622 /**
623 * Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
624 */
625 updateApnsSandboxChannel(params: Pinpoint.Types.UpdateApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
626 /**
627 * Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
628 */
629 updateApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
630 /**
631 * Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
632 */
633 updateApnsVoipChannel(params: Pinpoint.Types.UpdateApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
634 /**
635 * Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
636 */
637 updateApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
638 /**
639 * Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
640 */
641 updateApnsVoipSandboxChannel(params: Pinpoint.Types.UpdateApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
642 /**
643 * Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
644 */
645 updateApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
646 /**
647 * Updates the settings for an application.
648 */
649 updateApplicationSettings(params: Pinpoint.Types.UpdateApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
650 /**
651 * Updates the settings for an application.
652 */
653 updateApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
654 /**
655 * Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
656 */
657 updateBaiduChannel(params: Pinpoint.Types.UpdateBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
658 /**
659 * Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
660 */
661 updateBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
662 /**
663 * Updates the settings for a campaign.
664 */
665 updateCampaign(params: Pinpoint.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
666 /**
667 * Updates the settings for a campaign.
668 */
669 updateCampaign(callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
670 /**
671 * Enables the email channel for an application or updates the status and settings of the email channel for an application.
672 */
673 updateEmailChannel(params: Pinpoint.Types.UpdateEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
674 /**
675 * Enables the email channel for an application or updates the status and settings of the email channel for an application.
676 */
677 updateEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
678 /**
679 * Updates an existing message template that you can use in messages that are sent through the email channel.
680 */
681 updateEmailTemplate(params: Pinpoint.Types.UpdateEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
682 /**
683 * Updates an existing message template that you can use in messages that are sent through the email channel.
684 */
685 updateEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
686 /**
687 * 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.
688 */
689 updateEndpoint(params: Pinpoint.Types.UpdateEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
690 /**
691 * 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.
692 */
693 updateEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
694 /**
695 * 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.
696 */
697 updateEndpointsBatch(params: Pinpoint.Types.UpdateEndpointsBatchRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
698 /**
699 * 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.
700 */
701 updateEndpointsBatch(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
702 /**
703 * Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
704 */
705 updateGcmChannel(params: Pinpoint.Types.UpdateGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
706 /**
707 * Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
708 */
709 updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
710 /**
711 * Updates an existing message template that you can use in messages that are sent through a push notification channel.
712 */
713 updatePushTemplate(params: Pinpoint.Types.UpdatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
714 /**
715 * Updates an existing message template that you can use in messages that are sent through a push notification channel.
716 */
717 updatePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
718 /**
719 * 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.
720 */
721 updateSegment(params: Pinpoint.Types.UpdateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
722 /**
723 * 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.
724 */
725 updateSegment(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
726 /**
727 * Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
728 */
729 updateSmsChannel(params: Pinpoint.Types.UpdateSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
730 /**
731 * Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
732 */
733 updateSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
734 /**
735 * Updates an existing message template that you can use in messages that are sent through the SMS channel.
736 */
737 updateSmsTemplate(params: Pinpoint.Types.UpdateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
738 /**
739 * Updates an existing message template that you can use in messages that are sent through the SMS channel.
740 */
741 updateSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
742 /**
743 * Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
744 */
745 updateVoiceChannel(params: Pinpoint.Types.UpdateVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
746 /**
747 * Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
748 */
749 updateVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
750}
751declare namespace Pinpoint {
752 export interface ADMChannelRequest {
753 /**
754 * The Client ID that you received from Amazon to send messages by using ADM.
755 */
756 ClientId: __string;
757 /**
758 * The Client Secret that you received from Amazon to send messages by using ADM.
759 */
760 ClientSecret: __string;
761 /**
762 * Specifies whether to enable the ADM channel for the application.
763 */
764 Enabled?: __boolean;
765 }
766 export interface ADMChannelResponse {
767 /**
768 * The unique identifier for the application that the ADM channel applies to.
769 */
770 ApplicationId?: __string;
771 /**
772 * The date and time when the ADM channel was enabled.
773 */
774 CreationDate?: __string;
775 /**
776 * Specifies whether the ADM channel is enabled for the application.
777 */
778 Enabled?: __boolean;
779 /**
780 * (Not used) This property is retained only for backward compatibility.
781 */
782 HasCredential?: __boolean;
783 /**
784 * (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
785 */
786 Id?: __string;
787 /**
788 * Specifies whether the ADM channel is archived.
789 */
790 IsArchived?: __boolean;
791 /**
792 * The user who last modified the ADM channel.
793 */
794 LastModifiedBy?: __string;
795 /**
796 * The date and time when the ADM channel was last modified.
797 */
798 LastModifiedDate?: __string;
799 /**
800 * The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
801 */
802 Platform: __string;
803 /**
804 * The current version of the ADM channel.
805 */
806 Version?: __integer;
807 }
808 export interface ADMMessage {
809 /**
810 * 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.
811 */
812 Action?: Action;
813 /**
814 * The body of the notification message.
815 */
816 Body?: __string;
817 /**
818 * 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.
819 */
820 ConsolidationKey?: __string;
821 /**
822 * 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.
823 */
824 Data?: MapOf__string;
825 /**
826 * 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.
827 */
828 ExpiresAfter?: __string;
829 /**
830 * The icon image name of the asset saved in your app.
831 */
832 IconReference?: __string;
833 /**
834 * The URL of the large icon image to display in the content view of the push notification.
835 */
836 ImageIconUrl?: __string;
837 /**
838 * The URL of an image to display in the push notification.
839 */
840 ImageUrl?: __string;
841 /**
842 * 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.
843 */
844 MD5?: __string;
845 /**
846 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
847 */
848 RawContent?: __string;
849 /**
850 * 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.
851 */
852 SilentPush?: __boolean;
853 /**
854 * The URL of the small icon image to display in the status bar and the content view of the push notification.
855 */
856 SmallImageIconUrl?: __string;
857 /**
858 * 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/.
859 */
860 Sound?: __string;
861 /**
862 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
863 */
864 Substitutions?: MapOfListOf__string;
865 /**
866 * The title to display above the notification message on the recipient's device.
867 */
868 Title?: __string;
869 /**
870 * 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.
871 */
872 Url?: __string;
873 }
874 export interface APNSChannelRequest {
875 /**
876 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
877 */
878 BundleId?: __string;
879 /**
880 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
881 */
882 Certificate?: __string;
883 /**
884 * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
885 */
886 DefaultAuthenticationMethod?: __string;
887 /**
888 * Specifies whether to enable the APNs channel for the application.
889 */
890 Enabled?: __boolean;
891 /**
892 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
893 */
894 PrivateKey?: __string;
895 /**
896 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
897 */
898 TeamId?: __string;
899 /**
900 * The authentication key to use for APNs tokens.
901 */
902 TokenKey?: __string;
903 /**
904 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
905 */
906 TokenKeyId?: __string;
907 }
908 export interface APNSChannelResponse {
909 /**
910 * The unique identifier for the application that the APNs channel applies to.
911 */
912 ApplicationId?: __string;
913 /**
914 * The date and time when the APNs channel was enabled.
915 */
916 CreationDate?: __string;
917 /**
918 * The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
919 */
920 DefaultAuthenticationMethod?: __string;
921 /**
922 * Specifies whether the APNs channel is enabled for the application.
923 */
924 Enabled?: __boolean;
925 /**
926 * (Not used) This property is retained only for backward compatibility.
927 */
928 HasCredential?: __boolean;
929 /**
930 * 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.
931 */
932 HasTokenKey?: __boolean;
933 /**
934 * (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
935 */
936 Id?: __string;
937 /**
938 * Specifies whether the APNs channel is archived.
939 */
940 IsArchived?: __boolean;
941 /**
942 * The user who last modified the APNs channel.
943 */
944 LastModifiedBy?: __string;
945 /**
946 * The date and time when the APNs channel was last modified.
947 */
948 LastModifiedDate?: __string;
949 /**
950 * The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
951 */
952 Platform: __string;
953 /**
954 * The current version of the APNs channel.
955 */
956 Version?: __integer;
957 }
958 export interface APNSMessage {
959 /**
960 * 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.
961 */
962 Action?: Action;
963 /**
964 * 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.
965 */
966 Badge?: __integer;
967 /**
968 * The body of the notification message.
969 */
970 Body?: __string;
971 /**
972 * 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.
973 */
974 Category?: __string;
975 /**
976 * 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.
977 */
978 CollapseId?: __string;
979 /**
980 * The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
981 */
982 Data?: MapOf__string;
983 /**
984 * The URL of an image or video to display in the push notification.
985 */
986 MediaUrl?: __string;
987 /**
988 * The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
989 */
990 PreferredAuthenticationMethod?: __string;
991 /**
992 * 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.
993 */
994 Priority?: __string;
995 /**
996 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides 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.
997 */
998 RawContent?: __string;
999 /**
1000 * 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.
1001 */
1002 SilentPush?: __boolean;
1003 /**
1004 * 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.
1005 */
1006 Sound?: __string;
1007 /**
1008 * The default message variables to use in the notification message. You can override these default variables with individual address variables.
1009 */
1010 Substitutions?: MapOfListOf__string;
1011 /**
1012 * 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.
1013 */
1014 ThreadId?: __string;
1015 /**
1016 * 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.
1017 */
1018 TimeToLive?: __integer;
1019 /**
1020 * The title to display above the notification message on the recipient's device.
1021 */
1022 Title?: __string;
1023 /**
1024 * 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.
1025 */
1026 Url?: __string;
1027 }
1028 export interface APNSPushNotificationTemplate {
1029 /**
1030 * 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.
1031 */
1032 Action?: Action;
1033 /**
1034 * The message body to use in push notifications that are based on the message template.
1035 */
1036 Body?: __string;
1037 /**
1038 * The URL of an image or video to display in push notifications that are based on the message template.
1039 */
1040 MediaUrl?: __string;
1041 /**
1042 * 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.
1043 */
1044 Sound?: __string;
1045 /**
1046 * 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.
1047 */
1048 Title?: __string;
1049 /**
1050 * 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.
1051 */
1052 Url?: __string;
1053 }
1054 export interface APNSSandboxChannelRequest {
1055 /**
1056 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1057 */
1058 BundleId?: __string;
1059 /**
1060 * 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.
1061 */
1062 Certificate?: __string;
1063 /**
1064 * The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
1065 */
1066 DefaultAuthenticationMethod?: __string;
1067 /**
1068 * Specifies whether to enable the APNs sandbox channel for the application.
1069 */
1070 Enabled?: __boolean;
1071 /**
1072 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
1073 */
1074 PrivateKey?: __string;
1075 /**
1076 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1077 */
1078 TeamId?: __string;
1079 /**
1080 * The authentication key to use for APNs tokens.
1081 */
1082 TokenKey?: __string;
1083 /**
1084 * 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.
1085 */
1086 TokenKeyId?: __string;
1087 }
1088 export interface APNSSandboxChannelResponse {
1089 /**
1090 * The unique identifier for the application that the APNs sandbox channel applies to.
1091 */
1092 ApplicationId?: __string;
1093 /**
1094 * The date and time when the APNs sandbox channel was enabled.
1095 */
1096 CreationDate?: __string;
1097 /**
1098 * The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
1099 */
1100 DefaultAuthenticationMethod?: __string;
1101 /**
1102 * Specifies whether the APNs sandbox channel is enabled for the application.
1103 */
1104 Enabled?: __boolean;
1105 /**
1106 * (Not used) This property is retained only for backward compatibility.
1107 */
1108 HasCredential?: __boolean;
1109 /**
1110 * 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.
1111 */
1112 HasTokenKey?: __boolean;
1113 /**
1114 * (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
1115 */
1116 Id?: __string;
1117 /**
1118 * Specifies whether the APNs sandbox channel is archived.
1119 */
1120 IsArchived?: __boolean;
1121 /**
1122 * The user who last modified the APNs sandbox channel.
1123 */
1124 LastModifiedBy?: __string;
1125 /**
1126 * The date and time when the APNs sandbox channel was last modified.
1127 */
1128 LastModifiedDate?: __string;
1129 /**
1130 * The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
1131 */
1132 Platform: __string;
1133 /**
1134 * The current version of the APNs sandbox channel.
1135 */
1136 Version?: __integer;
1137 }
1138 export interface APNSVoipChannelRequest {
1139 /**
1140 * The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
1141 */
1142 BundleId?: __string;
1143 /**
1144 * The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
1145 */
1146 Certificate?: __string;
1147 /**
1148 * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
1149 */
1150 DefaultAuthenticationMethod?: __string;
1151 /**
1152 * Specifies whether to enable the APNs VoIP channel for the application.
1153 */
1154 Enabled?: __boolean;
1155 /**
1156 * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
1157 */
1158 PrivateKey?: __string;
1159 /**
1160 * The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
1161 */
1162 TeamId?: __string;
1163 /**
1164 * The authentication key to use for APNs tokens.
1165 */
1166 TokenKey?: __string;
1167 /**
1168 * The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
1169 */
1170 TokenKeyId?: __string;
1171 }
1172 export interface APNSVoipChannelResponse {
1173 /**
1174 * The unique identifier for the application that the APNs VoIP channel applies to.
1175 */
1176 ApplicationId?: __string;
1177 /**
1178 * The date and time when the APNs VoIP channel was enabled.
1179 */
1180 CreationDate?: __string;
1181 /**
1182 * The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
1183 */
1184 DefaultAuthenticationMethod?: __string;
1185 /**
1186 * Specifies whether the APNs VoIP channel is enabled for the application.
1187 */
1188 Enabled?: __boolean;
1189 /**
1190 * (Not used) This property is retained only for backward compatibility.
1191 */
1192 HasCredential?: __boolean;
1193 /**
1194 * 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.
1195 */
1196 HasTokenKey?: __boolean;
1197 /**
1198 * (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
1199 */
1200 Id?: __string;
1201 /**
1202 * Specifies whether the APNs VoIP channel is archived.
1203 */
1204 IsArchived?: __boolean;
1205 /**
1206 * The user who last modified the APNs VoIP channel.
1207 */
1208 LastModifiedBy?: __string;
1209 /**
1210 * The date and time when the APNs VoIP channel was last modified.
1211 */
1212 LastModifiedDate?: __string;
1213 /**
1214 * The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
1215 */
1216 Platform: __string;
1217 /**
1218 * The current version of the APNs VoIP channel.
1219 */
1220 Version?: __integer;
1221 }
1222 export interface APNSVoipSandboxChannelRequest {
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 for this channel, key or certificate.
1233 */
1234 DefaultAuthenticationMethod?: __string;
1235 /**
1236 * Specifies whether the APNs VoIP sandbox channel is enabled 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 APNSVoipSandboxChannelResponse {
1257 /**
1258 * The unique identifier for the application that the APNs VoIP sandbox channel applies to.
1259 */
1260 ApplicationId?: __string;
1261 /**
1262 * The date and time when the APNs VoIP 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 VoIP 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 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.
1279 */
1280 HasTokenKey?: __boolean;
1281 /**
1282 * (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
1283 */
1284 Id?: __string;
1285 /**
1286 * Specifies whether the APNs VoIP sandbox channel is archived.
1287 */
1288 IsArchived?: __boolean;
1289 /**
1290 * The user who last modified the APNs VoIP sandbox channel.
1291 */
1292 LastModifiedBy?: __string;
1293 /**
1294 * The date and time when the APNs VoIP sandbox channel was last modified.
1295 */
1296 LastModifiedDate?: __string;
1297 /**
1298 * The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
1299 */
1300 Platform: __string;
1301 /**
1302 * The current version of the APNs VoIP sandbox channel.
1303 */
1304 Version?: __integer;
1305 }
1306 export type Action = "OPEN_APP"|"DEEP_LINK"|"URL"|string;
1307 export interface ActivitiesResponse {
1308 /**
1309 * An array of responses, one for each activity that was performed by the campaign.
1310 */
1311 Item: ListOfActivityResponse;
1312 /**
1313 * 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.
1314 */
1315 NextToken?: __string;
1316 }
1317 export interface ActivityResponse {
1318 /**
1319 * The unique identifier for the application that the campaign applies to.
1320 */
1321 ApplicationId: __string;
1322 /**
1323 * The unique identifier for the campaign that the activity applies to.
1324 */
1325 CampaignId: __string;
1326 /**
1327 * The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
1328 */
1329 End?: __string;
1330 /**
1331 * The unique identifier for the activity.
1332 */
1333 Id: __string;
1334 /**
1335 * Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
1336 */
1337 Result?: __string;
1338 /**
1339 * The scheduled start time, in ISO 8601 format, for the activity.
1340 */
1341 ScheduledStart?: __string;
1342 /**
1343 * The actual start time, in ISO 8601 format, of the activity.
1344 */
1345 Start?: __string;
1346 /**
1347 * The state of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
1348 */
1349 State?: __string;
1350 /**
1351 * The total number of endpoints that the campaign successfully delivered messages to.
1352 */
1353 SuccessfulEndpointCount?: __integer;
1354 /**
1355 * The total number of time zones that were completed.
1356 */
1357 TimezonesCompletedCount?: __integer;
1358 /**
1359 * The total number of unique time zones that are in the segment for the campaign.
1360 */
1361 TimezonesTotalCount?: __integer;
1362 /**
1363 * The total number of endpoints that the campaign attempted to deliver messages to.
1364 */
1365 TotalEndpointCount?: __integer;
1366 /**
1367 * 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.
1368 */
1369 TreatmentId?: __string;
1370 }
1371 export interface AddressConfiguration {
1372 /**
1373 * The message body to use instead of the default message body. This value overrides the default message body.
1374 */
1375 BodyOverride?: __string;
1376 /**
1377 * The channel to use when sending the message.
1378 */
1379 ChannelType?: ChannelType;
1380 /**
1381 * An object that maps custom attributes to attributes for the address and is attached 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.
1382 */
1383 Context?: MapOf__string;
1384 /**
1385 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
1386 */
1387 RawContent?: __string;
1388 /**
1389 * An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
1390 */
1391 Substitutions?: MapOfListOf__string;
1392 /**
1393 * The message title to use instead of the default message title. This value overrides the default message title.
1394 */
1395 TitleOverride?: __string;
1396 }
1397 export interface AndroidPushNotificationTemplate {
1398 /**
1399 * 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.
1400 */
1401 Action?: Action;
1402 /**
1403 * The message body to use in a push notification that's based on the message template.
1404 */
1405 Body?: __string;
1406 /**
1407 * The URL of the large icon image to display in the content view of a push notification that's based on the message template.
1408 */
1409 ImageIconUrl?: __string;
1410 /**
1411 * The URL of an image to display in a push notification that's based on the message template.
1412 */
1413 ImageUrl?: __string;
1414 /**
1415 * 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.
1416 */
1417 SmallImageIconUrl?: __string;
1418 /**
1419 * 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/.
1420 */
1421 Sound?: __string;
1422 /**
1423 * 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.
1424 */
1425 Title?: __string;
1426 /**
1427 * The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
1428 */
1429 Url?: __string;
1430 }
1431 export interface ApplicationDateRangeKpiResponse {
1432 /**
1433 * The unique identifier for the application that the metric applies to.
1434 */
1435 ApplicationId: __string;
1436 /**
1437 * 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.
1438 */
1439 EndTime: __timestampIso8601;
1440 /**
1441 * 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 valid values, see the Amazon Pinpoint Developer Guide.
1442 */
1443 KpiName: __string;
1444 /**
1445 * An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
1446 */
1447 KpiResult: BaseKpiResult;
1448 /**
1449 * 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. The Application Metrics resource returns all results in a single page.
1450 */
1451 NextToken?: __string;
1452 /**
1453 * 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.
1454 */
1455 StartTime: __timestampIso8601;
1456 }
1457 export interface ApplicationResponse {
1458 /**
1459 * The Amazon Resource Name (ARN) of the application.
1460 */
1461 Arn: __string;
1462 /**
1463 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1464 */
1465 Id: __string;
1466 /**
1467 * The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
1468 */
1469 Name: __string;
1470 /**
1471 * 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.
1472 */
1473 tags?: MapOf__string;
1474 }
1475 export interface ApplicationSettingsResource {
1476 /**
1477 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1478 */
1479 ApplicationId: __string;
1480 /**
1481 * The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
1482 */
1483 CampaignHook?: CampaignHook;
1484 /**
1485 * The date and time, in ISO 8601 format, when the application's settings were last modified.
1486 */
1487 LastModifiedDate?: __string;
1488 /**
1489 * The default sending limits for campaigns in the application.
1490 */
1491 Limits?: CampaignLimits;
1492 /**
1493 * The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don'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 application (or a campaign 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 that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
1494 */
1495 QuietTime?: QuietTime;
1496 }
1497 export interface ApplicationsResponse {
1498 /**
1499 * An array of responses, one for each application that was returned.
1500 */
1501 Item?: ListOfApplicationResponse;
1502 /**
1503 * 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.
1504 */
1505 NextToken?: __string;
1506 }
1507 export interface AttributeDimension {
1508 /**
1509 * 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.
1510 */
1511 AttributeType?: AttributeType;
1512 /**
1513 * 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.
1514 */
1515 Values: ListOf__string;
1516 }
1517 export type AttributeType = "INCLUSIVE"|"EXCLUSIVE"|string;
1518 export interface AttributesResource {
1519 /**
1520 * The unique identifier for the application.
1521 */
1522 ApplicationId: __string;
1523 /**
1524 * The type of attribute or attributes that were removed from the endpoints. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints. endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints. endpoint-user-attributes - Custom attributes that describe users.
1525 */
1526 AttributeType: __string;
1527 /**
1528 * An array that specifies the names of the attributes that were removed from the endpoints.
1529 */
1530 Attributes?: ListOf__string;
1531 }
1532 export interface BaiduChannelRequest {
1533 /**
1534 * The API key that you received from the Baidu Cloud Push service to communicate with the service.
1535 */
1536 ApiKey: __string;
1537 /**
1538 * Specifies whether to enable the Baidu channel for the application.
1539 */
1540 Enabled?: __boolean;
1541 /**
1542 * The secret key that you received from the Baidu Cloud Push service to communicate with the service.
1543 */
1544 SecretKey: __string;
1545 }
1546 export interface BaiduChannelResponse {
1547 /**
1548 * The unique identifier for the application that the Baidu channel applies to.
1549 */
1550 ApplicationId?: __string;
1551 /**
1552 * The date and time when the Baidu channel was enabled.
1553 */
1554 CreationDate?: __string;
1555 /**
1556 * The API key that you received from the Baidu Cloud Push service to communicate with the service.
1557 */
1558 Credential: __string;
1559 /**
1560 * Specifies whether the Baidu channel is enabled for the application.
1561 */
1562 Enabled?: __boolean;
1563 /**
1564 * (Not used) This property is retained only for backward compatibility.
1565 */
1566 HasCredential?: __boolean;
1567 /**
1568 * (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
1569 */
1570 Id?: __string;
1571 /**
1572 * Specifies whether the Baidu channel is archived.
1573 */
1574 IsArchived?: __boolean;
1575 /**
1576 * The user who last modified the Baidu channel.
1577 */
1578 LastModifiedBy?: __string;
1579 /**
1580 * The date and time when the Baidu channel was last modified.
1581 */
1582 LastModifiedDate?: __string;
1583 /**
1584 * The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
1585 */
1586 Platform: __string;
1587 /**
1588 * The current version of the Baidu channel.
1589 */
1590 Version?: __integer;
1591 }
1592 export interface BaiduMessage {
1593 /**
1594 * 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.
1595 */
1596 Action?: Action;
1597 /**
1598 * The body of the notification message.
1599 */
1600 Body?: __string;
1601 /**
1602 * 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.
1603 */
1604 Data?: MapOf__string;
1605 /**
1606 * The icon image name of the asset saved in your app.
1607 */
1608 IconReference?: __string;
1609 /**
1610 * The URL of the large icon image to display in the content view of the push notification.
1611 */
1612 ImageIconUrl?: __string;
1613 /**
1614 * The URL of an image to display in the push notification.
1615 */
1616 ImageUrl?: __string;
1617 /**
1618 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
1619 */
1620 RawContent?: __string;
1621 /**
1622 * 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.
1623 */
1624 SilentPush?: __boolean;
1625 /**
1626 * The URL of the small icon image to display in the status bar and the content view of the push notification.
1627 */
1628 SmallImageIconUrl?: __string;
1629 /**
1630 * 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/.
1631 */
1632 Sound?: __string;
1633 /**
1634 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
1635 */
1636 Substitutions?: MapOfListOf__string;
1637 /**
1638 * 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).
1639 */
1640 TimeToLive?: __integer;
1641 /**
1642 * The title to display above the notification message on the recipient's device.
1643 */
1644 Title?: __string;
1645 /**
1646 * 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.
1647 */
1648 Url?: __string;
1649 }
1650 export interface BaseKpiResult {
1651 /**
1652 * An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application or campaign.
1653 */
1654 Rows: ListOfResultRow;
1655 }
1656 export interface CampaignDateRangeKpiResponse {
1657 /**
1658 * The unique identifier for the application that the metric applies to.
1659 */
1660 ApplicationId: __string;
1661 /**
1662 * The unique identifier for the campaign that the metric applies to.
1663 */
1664 CampaignId: __string;
1665 /**
1666 * 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.
1667 */
1668 EndTime: __timestampIso8601;
1669 /**
1670 * 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 valid values, see the Amazon Pinpoint Developer Guide.
1671 */
1672 KpiName: __string;
1673 /**
1674 * An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
1675 */
1676 KpiResult: BaseKpiResult;
1677 /**
1678 * 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. The Campaign Metrics resource returns all results in a single page.
1679 */
1680 NextToken?: __string;
1681 /**
1682 * 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.
1683 */
1684 StartTime: __timestampIso8601;
1685 }
1686 export interface CampaignEmailMessage {
1687 /**
1688 * The body of the email for recipients whose email clients don't support HTML content.
1689 */
1690 Body?: __string;
1691 /**
1692 * The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
1693 */
1694 FromAddress?: __string;
1695 /**
1696 * The body of the email, in HTML format, for recipients whose email clients support HTML content.
1697 */
1698 HtmlBody?: __string;
1699 /**
1700 * The subject line, or title, of the email.
1701 */
1702 Title: __string;
1703 }
1704 export interface CampaignEventFilter {
1705 /**
1706 * The dimension settings of the event filter for the campaign.
1707 */
1708 Dimensions: EventDimensions;
1709 /**
1710 * 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.
1711 */
1712 FilterType: FilterType;
1713 }
1714 export interface CampaignHook {
1715 /**
1716 * The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
1717 */
1718 LambdaFunctionName?: __string;
1719 /**
1720 * Specifies which Lambda mode to use when invoking the AWS Lambda function.
1721 */
1722 Mode?: Mode;
1723 /**
1724 * The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
1725 */
1726 WebUrl?: __string;
1727 }
1728 export interface CampaignLimits {
1729 /**
1730 * The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
1731 */
1732 Daily?: __integer;
1733 /**
1734 * 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.
1735 */
1736 MaximumDuration?: __integer;
1737 /**
1738 * The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
1739 */
1740 MessagesPerSecond?: __integer;
1741 /**
1742 * 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.
1743 */
1744 Total?: __integer;
1745 }
1746 export interface CampaignResponse {
1747 /**
1748 * An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
1749 */
1750 AdditionalTreatments?: ListOfTreatmentResource;
1751 /**
1752 * The unique identifier for the application that the campaign applies to.
1753 */
1754 ApplicationId: __string;
1755 /**
1756 * The Amazon Resource Name (ARN) of the campaign.
1757 */
1758 Arn: __string;
1759 /**
1760 * The date, ISO 8601 format, when the campaign was created.
1761 */
1762 CreationDate: __string;
1763 /**
1764 * 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.
1765 */
1766 DefaultState?: CampaignState;
1767 /**
1768 * The custom description of the campaign.
1769 */
1770 Description?: __string;
1771 /**
1772 * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
1773 */
1774 HoldoutPercent?: __integer;
1775 /**
1776 * The settings for the AWS Lambda function to use as a code hook for the campaign.
1777 */
1778 Hook?: CampaignHook;
1779 /**
1780 * The unique identifier for the campaign.
1781 */
1782 Id: __string;
1783 /**
1784 * Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
1785 */
1786 IsPaused?: __boolean;
1787 /**
1788 * The date, in ISO 8601 format, when the campaign was last modified.
1789 */
1790 LastModifiedDate: __string;
1791 /**
1792 * The messaging limits for the campaign.
1793 */
1794 Limits?: CampaignLimits;
1795 /**
1796 * The message configuration settings for the campaign.
1797 */
1798 MessageConfiguration?: MessageConfiguration;
1799 /**
1800 * The name of the campaign.
1801 */
1802 Name?: __string;
1803 /**
1804 * The schedule settings for the campaign.
1805 */
1806 Schedule?: Schedule;
1807 /**
1808 * The unique identifier for the segment that's associated with the campaign.
1809 */
1810 SegmentId: __string;
1811 /**
1812 * The version number of the segment that's associated with the campaign.
1813 */
1814 SegmentVersion: __integer;
1815 /**
1816 * The current status of the campaign.
1817 */
1818 State?: CampaignState;
1819 /**
1820 * 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.
1821 */
1822 tags?: MapOf__string;
1823 TemplateConfiguration?: TemplateConfiguration;
1824 /**
1825 * The custom description of a variation of the campaign that's used for A/B testing.
1826 */
1827 TreatmentDescription?: __string;
1828 /**
1829 * The custom name of a variation of the campaign that's used for A/B testing.
1830 */
1831 TreatmentName?: __string;
1832 /**
1833 * The version number of the campaign.
1834 */
1835 Version?: __integer;
1836 }
1837 export interface CampaignSmsMessage {
1838 /**
1839 * The body of the SMS message.
1840 */
1841 Body?: __string;
1842 /**
1843 * 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.
1844 */
1845 MessageType?: MessageType;
1846 /**
1847 * The sender ID to display on recipients' devices when they receive the SMS message.
1848 */
1849 SenderId?: __string;
1850 }
1851 export interface CampaignState {
1852 /**
1853 * The status of the campaign, or the 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 when all campaign treatments have a status of COMPLETED.
1854 */
1855 CampaignStatus?: CampaignStatus;
1856 }
1857 export type CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|string;
1858 export interface CampaignsResponse {
1859 /**
1860 * An array of responses, one for each campaign that's associated with the application.
1861 */
1862 Item: ListOfCampaignResponse;
1863 /**
1864 * 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.
1865 */
1866 NextToken?: __string;
1867 }
1868 export interface ChannelResponse {
1869 /**
1870 * The unique identifier for the application.
1871 */
1872 ApplicationId?: __string;
1873 /**
1874 * The date and time, in ISO 8601 format, when the channel was enabled.
1875 */
1876 CreationDate?: __string;
1877 /**
1878 * Specifies whether the channel is enabled for the application.
1879 */
1880 Enabled?: __boolean;
1881 /**
1882 * (Not used) This property is retained only for backward compatibility.
1883 */
1884 HasCredential?: __boolean;
1885 /**
1886 * (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
1887 */
1888 Id?: __string;
1889 /**
1890 * Specifies whether the channel is archived.
1891 */
1892 IsArchived?: __boolean;
1893 /**
1894 * The user who last modified the channel.
1895 */
1896 LastModifiedBy?: __string;
1897 /**
1898 * The date and time, in ISO 8601 format, when the channel was last modified.
1899 */
1900 LastModifiedDate?: __string;
1901 /**
1902 * The current version of the channel.
1903 */
1904 Version?: __integer;
1905 }
1906 export type ChannelType = "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
1907 export interface ChannelsResponse {
1908 /**
1909 * 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.
1910 */
1911 Channels: MapOfChannelResponse;
1912 }
1913 export interface CreateAppRequest {
1914 CreateApplicationRequest: CreateApplicationRequest;
1915 }
1916 export interface CreateAppResponse {
1917 ApplicationResponse: ApplicationResponse;
1918 }
1919 export interface CreateApplicationRequest {
1920 /**
1921 * The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
1922 */
1923 Name: __string;
1924 /**
1925 * 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.
1926 */
1927 tags?: MapOf__string;
1928 }
1929 export interface CreateCampaignRequest {
1930 /**
1931 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1932 */
1933 ApplicationId: __string;
1934 WriteCampaignRequest: WriteCampaignRequest;
1935 }
1936 export interface CreateCampaignResponse {
1937 CampaignResponse: CampaignResponse;
1938 }
1939 export interface CreateEmailTemplateRequest {
1940 /**
1941 * Creates a new message template that you can use in messages that are sent through the email channel.
1942 */
1943 EmailTemplateRequest: EmailTemplateRequest;
1944 /**
1945 * 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.
1946 */
1947 TemplateName: __string;
1948 }
1949 export interface CreateEmailTemplateResponse {
1950 CreateTemplateMessageBody: CreateTemplateMessageBody;
1951 }
1952 export interface CreateExportJobRequest {
1953 /**
1954 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1955 */
1956 ApplicationId: __string;
1957 ExportJobRequest: ExportJobRequest;
1958 }
1959 export interface CreateExportJobResponse {
1960 ExportJobResponse: ExportJobResponse;
1961 }
1962 export interface CreateImportJobRequest {
1963 /**
1964 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1965 */
1966 ApplicationId: __string;
1967 ImportJobRequest: ImportJobRequest;
1968 }
1969 export interface CreateImportJobResponse {
1970 ImportJobResponse: ImportJobResponse;
1971 }
1972 export interface CreatePushTemplateRequest {
1973 /**
1974 * Creates a message template that you can use in messages that are sent through a push notification channel.
1975 */
1976 PushNotificationTemplateRequest: PushNotificationTemplateRequest;
1977 /**
1978 * 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.
1979 */
1980 TemplateName: __string;
1981 }
1982 export interface CreatePushTemplateResponse {
1983 CreateTemplateMessageBody: CreateTemplateMessageBody;
1984 }
1985 export interface CreateSegmentRequest {
1986 /**
1987 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
1988 */
1989 ApplicationId: __string;
1990 WriteSegmentRequest: WriteSegmentRequest;
1991 }
1992 export interface CreateSegmentResponse {
1993 SegmentResponse: SegmentResponse;
1994 }
1995 export interface CreateSmsTemplateRequest {
1996 /**
1997 * Creates a message template that you can use in messages that are sent through the SMS channel.
1998 */
1999 SMSTemplateRequest: SMSTemplateRequest;
2000 /**
2001 * 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.
2002 */
2003 TemplateName: __string;
2004 }
2005 export interface CreateSmsTemplateResponse {
2006 CreateTemplateMessageBody: CreateTemplateMessageBody;
2007 }
2008 export interface CreateTemplateMessageBody {
2009 /**
2010 * The Amazon Resource Name (ARN) of the message template.
2011 */
2012 Arn?: __string;
2013 /**
2014 * The message that's returned from the API.
2015 */
2016 Message?: __string;
2017 /**
2018 * The unique identifier for the request or response.
2019 */
2020 RequestID?: __string;
2021 }
2022 export interface DefaultMessage {
2023 /**
2024 * The default message body of the push notification, email, or SMS message.
2025 */
2026 Body?: __string;
2027 /**
2028 * The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.
2029 */
2030 Substitutions?: MapOfListOf__string;
2031 }
2032 export interface DefaultPushNotificationMessage {
2033 /**
2034 * 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.
2035 */
2036 Action?: Action;
2037 /**
2038 * The default body of the notification message.
2039 */
2040 Body?: __string;
2041 /**
2042 * 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.
2043 */
2044 Data?: MapOf__string;
2045 /**
2046 * 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.
2047 */
2048 SilentPush?: __boolean;
2049 /**
2050 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
2051 */
2052 Substitutions?: MapOfListOf__string;
2053 /**
2054 * The default title to display above the notification message on a recipient's device.
2055 */
2056 Title?: __string;
2057 /**
2058 * 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.
2059 */
2060 Url?: __string;
2061 }
2062 export interface DefaultPushNotificationTemplate {
2063 /**
2064 * 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.
2065 */
2066 Action?: Action;
2067 /**
2068 * The message body to use in push notifications that are based on the message template.
2069 */
2070 Body?: __string;
2071 /**
2072 * 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.
2073 */
2074 Sound?: __string;
2075 /**
2076 * 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.
2077 */
2078 Title?: __string;
2079 /**
2080 * 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.
2081 */
2082 Url?: __string;
2083 }
2084 export interface DeleteAdmChannelRequest {
2085 /**
2086 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2087 */
2088 ApplicationId: __string;
2089 }
2090 export interface DeleteAdmChannelResponse {
2091 ADMChannelResponse: ADMChannelResponse;
2092 }
2093 export interface DeleteApnsChannelRequest {
2094 /**
2095 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2096 */
2097 ApplicationId: __string;
2098 }
2099 export interface DeleteApnsChannelResponse {
2100 APNSChannelResponse: APNSChannelResponse;
2101 }
2102 export interface DeleteApnsSandboxChannelRequest {
2103 /**
2104 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2105 */
2106 ApplicationId: __string;
2107 }
2108 export interface DeleteApnsSandboxChannelResponse {
2109 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
2110 }
2111 export interface DeleteApnsVoipChannelRequest {
2112 /**
2113 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2114 */
2115 ApplicationId: __string;
2116 }
2117 export interface DeleteApnsVoipChannelResponse {
2118 APNSVoipChannelResponse: APNSVoipChannelResponse;
2119 }
2120 export interface DeleteApnsVoipSandboxChannelRequest {
2121 /**
2122 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2123 */
2124 ApplicationId: __string;
2125 }
2126 export interface DeleteApnsVoipSandboxChannelResponse {
2127 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
2128 }
2129 export interface DeleteAppRequest {
2130 /**
2131 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2132 */
2133 ApplicationId: __string;
2134 }
2135 export interface DeleteAppResponse {
2136 ApplicationResponse: ApplicationResponse;
2137 }
2138 export interface DeleteBaiduChannelRequest {
2139 /**
2140 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2141 */
2142 ApplicationId: __string;
2143 }
2144 export interface DeleteBaiduChannelResponse {
2145 BaiduChannelResponse: BaiduChannelResponse;
2146 }
2147 export interface DeleteCampaignRequest {
2148 /**
2149 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2150 */
2151 ApplicationId: __string;
2152 /**
2153 * The unique identifier for the campaign.
2154 */
2155 CampaignId: __string;
2156 }
2157 export interface DeleteCampaignResponse {
2158 CampaignResponse: CampaignResponse;
2159 }
2160 export interface DeleteEmailChannelRequest {
2161 /**
2162 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2163 */
2164 ApplicationId: __string;
2165 }
2166 export interface DeleteEmailChannelResponse {
2167 EmailChannelResponse: EmailChannelResponse;
2168 }
2169 export interface DeleteEmailTemplateRequest {
2170 /**
2171 * 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.
2172 */
2173 TemplateName: __string;
2174 }
2175 export interface DeleteEmailTemplateResponse {
2176 MessageBody: MessageBody;
2177 }
2178 export interface DeleteEndpointRequest {
2179 /**
2180 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2181 */
2182 ApplicationId: __string;
2183 /**
2184 * The unique identifier for the endpoint.
2185 */
2186 EndpointId: __string;
2187 }
2188 export interface DeleteEndpointResponse {
2189 EndpointResponse: EndpointResponse;
2190 }
2191 export interface DeleteEventStreamRequest {
2192 /**
2193 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2194 */
2195 ApplicationId: __string;
2196 }
2197 export interface DeleteEventStreamResponse {
2198 EventStream: EventStream;
2199 }
2200 export interface DeleteGcmChannelRequest {
2201 /**
2202 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2203 */
2204 ApplicationId: __string;
2205 }
2206 export interface DeleteGcmChannelResponse {
2207 GCMChannelResponse: GCMChannelResponse;
2208 }
2209 export interface DeletePushTemplateRequest {
2210 /**
2211 * 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.
2212 */
2213 TemplateName: __string;
2214 }
2215 export interface DeletePushTemplateResponse {
2216 MessageBody: MessageBody;
2217 }
2218 export interface DeleteSegmentRequest {
2219 /**
2220 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2221 */
2222 ApplicationId: __string;
2223 /**
2224 * The unique identifier for the segment.
2225 */
2226 SegmentId: __string;
2227 }
2228 export interface DeleteSegmentResponse {
2229 SegmentResponse: SegmentResponse;
2230 }
2231 export interface DeleteSmsChannelRequest {
2232 /**
2233 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2234 */
2235 ApplicationId: __string;
2236 }
2237 export interface DeleteSmsChannelResponse {
2238 SMSChannelResponse: SMSChannelResponse;
2239 }
2240 export interface DeleteSmsTemplateRequest {
2241 /**
2242 * 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.
2243 */
2244 TemplateName: __string;
2245 }
2246 export interface DeleteSmsTemplateResponse {
2247 MessageBody: MessageBody;
2248 }
2249 export interface DeleteUserEndpointsRequest {
2250 /**
2251 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2252 */
2253 ApplicationId: __string;
2254 /**
2255 * The unique identifier for the user.
2256 */
2257 UserId: __string;
2258 }
2259 export interface DeleteUserEndpointsResponse {
2260 EndpointsResponse: EndpointsResponse;
2261 }
2262 export interface DeleteVoiceChannelRequest {
2263 /**
2264 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
2265 */
2266 ApplicationId: __string;
2267 }
2268 export interface DeleteVoiceChannelResponse {
2269 VoiceChannelResponse: VoiceChannelResponse;
2270 }
2271 export type DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE"|string;
2272 export type DimensionType = "INCLUSIVE"|"EXCLUSIVE"|string;
2273 export interface DirectMessageConfiguration {
2274 /**
2275 * The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2276 */
2277 ADMMessage?: ADMMessage;
2278 /**
2279 * The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2280 */
2281 APNSMessage?: APNSMessage;
2282 /**
2283 * The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
2284 */
2285 BaiduMessage?: BaiduMessage;
2286 /**
2287 * The default message body for all channels.
2288 */
2289 DefaultMessage?: DefaultMessage;
2290 /**
2291 * The default push notification message for all push notification channels.
2292 */
2293 DefaultPushNotificationMessage?: DefaultPushNotificationMessage;
2294 /**
2295 * The default message for the email channel. This message overrides the default message (DefaultMessage).
2296 */
2297 EmailMessage?: EmailMessage;
2298 /**
2299 * 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).
2300 */
2301 GCMMessage?: GCMMessage;
2302 /**
2303 * The default message for the SMS channel. This message overrides the default message (DefaultMessage).
2304 */
2305 SMSMessage?: SMSMessage;
2306 /**
2307 * The default message for the voice channel. This message overrides the default message (DefaultMessage).
2308 */
2309 VoiceMessage?: VoiceMessage;
2310 }
2311 export type Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30"|string;
2312 export interface EmailChannelRequest {
2313 /**
2314 * The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.
2315 */
2316 ConfigurationSet?: __string;
2317 /**
2318 * Specifies whether to enable the email channel for the application.
2319 */
2320 Enabled?: __boolean;
2321 /**
2322 * The verified email address that you want to send email from when you send email through the channel.
2323 */
2324 FromAddress: __string;
2325 /**
2326 * 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.
2327 */
2328 Identity: __string;
2329 /**
2330 * 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.
2331 */
2332 RoleArn?: __string;
2333 }
2334 export interface EmailChannelResponse {
2335 /**
2336 * The unique identifier for the application that the email channel applies to.
2337 */
2338 ApplicationId?: __string;
2339 /**
2340 * The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.
2341 */
2342 ConfigurationSet?: __string;
2343 /**
2344 * The date and time, in ISO 8601 format, when the email channel was enabled.
2345 */
2346 CreationDate?: __string;
2347 /**
2348 * Specifies whether the email channel is enabled for the application.
2349 */
2350 Enabled?: __boolean;
2351 /**
2352 * The verified email address that you send email from when you send email through the channel.
2353 */
2354 FromAddress?: __string;
2355 /**
2356 * (Not used) This property is retained only for backward compatibility.
2357 */
2358 HasCredential?: __boolean;
2359 /**
2360 * (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
2361 */
2362 Id?: __string;
2363 /**
2364 * 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.
2365 */
2366 Identity?: __string;
2367 /**
2368 * Specifies whether the email channel is archived.
2369 */
2370 IsArchived?: __boolean;
2371 /**
2372 * The user who last modified the email channel.
2373 */
2374 LastModifiedBy?: __string;
2375 /**
2376 * The date and time, in ISO 8601 format, when the email channel was last modified.
2377 */
2378 LastModifiedDate?: __string;
2379 /**
2380 * The maximum number of emails that you can send through the channel each second.
2381 */
2382 MessagesPerSecond?: __integer;
2383 /**
2384 * The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
2385 */
2386 Platform: __string;
2387 /**
2388 * The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
2389 */
2390 RoleArn?: __string;
2391 /**
2392 * The current version of the email channel.
2393 */
2394 Version?: __integer;
2395 }
2396 export interface EmailMessage {
2397 /**
2398 * The body of the email message.
2399 */
2400 Body?: __string;
2401 /**
2402 * The email address to forward bounces and complaints to, if feedback forwarding is enabled.
2403 */
2404 FeedbackForwardingAddress?: __string;
2405 /**
2406 * The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
2407 */
2408 FromAddress?: __string;
2409 /**
2410 * The email message, represented as a raw MIME message.
2411 */
2412 RawEmail?: RawEmail;
2413 /**
2414 * The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
2415 */
2416 ReplyToAddresses?: ListOf__string;
2417 /**
2418 * The email message, composed of a subject, a text part, and an HTML part.
2419 */
2420 SimpleEmail?: SimpleEmail;
2421 /**
2422 * The default message variables to use in the email message. You can override the default variables with individual address variables.
2423 */
2424 Substitutions?: MapOfListOf__string;
2425 }
2426 export interface EmailTemplateRequest {
2427 /**
2428 * 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 support HTML. You can include links, formatted text, and more in an HTML message.
2429 */
2430 HtmlPart?: __string;
2431 /**
2432 * The subject line, or title, to use in email messages that are based on the message template.
2433 */
2434 Subject?: __string;
2435 /**
2436 * 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.
2437 */
2438 tags?: MapOf__string;
2439 /**
2440 * The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
2441 */
2442 TextPart?: __string;
2443 }
2444 export interface EmailTemplateResponse {
2445 /**
2446 * The Amazon Resource Name (ARN) of the message template.
2447 */
2448 Arn?: __string;
2449 /**
2450 * The date when the message template was created.
2451 */
2452 CreationDate: __string;
2453 /**
2454 * The message body, in HTML format, that's used in email messages that are based on the message template.
2455 */
2456 HtmlPart?: __string;
2457 /**
2458 * The date when the message template was last modified.
2459 */
2460 LastModifiedDate: __string;
2461 /**
2462 * The subject line, or title, that's used in email messages that are based on the message template.
2463 */
2464 Subject?: __string;
2465 /**
2466 * 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.
2467 */
2468 tags?: MapOf__string;
2469 /**
2470 * The name of the message template.
2471 */
2472 TemplateName: __string;
2473 /**
2474 * The type of channel that the message template is designed for. For an email template, this value is EMAIL.
2475 */
2476 TemplateType: TemplateType;
2477 /**
2478 * The message body, in text format, that's used in email messages that are based on the message template.
2479 */
2480 TextPart?: __string;
2481 }
2482 export interface EndpointBatchItem {
2483 /**
2484 * 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.
2485 */
2486 Address?: __string;
2487 /**
2488 * 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. 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 limitation doesn't apply to attribute values.
2489 */
2490 Attributes?: MapOfListOf__string;
2491 /**
2492 * The channel to use when sending messages or push notifications to the endpoint.
2493 */
2494 ChannelType?: ChannelType;
2495 /**
2496 * The demographic information for the endpoint, such as the time zone and platform.
2497 */
2498 Demographic?: EndpointDemographic;
2499 /**
2500 * The date and time, in ISO 8601 format, when the endpoint was created or updated.
2501 */
2502 EffectiveDate?: __string;
2503 /**
2504 * 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.
2505 */
2506 EndpointStatus?: __string;
2507 /**
2508 * The unique identifier for the endpoint in the context of the batch.
2509 */
2510 Id?: __string;
2511 /**
2512 * The geographic information for the endpoint.
2513 */
2514 Location?: EndpointLocation;
2515 /**
2516 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
2517 */
2518 Metrics?: MapOf__double;
2519 /**
2520 * 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.
2521 */
2522 OptOut?: __string;
2523 /**
2524 * The unique identifier for the request to create or update the endpoint.
2525 */
2526 RequestId?: __string;
2527 /**
2528 * One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
2529 */
2530 User?: EndpointUser;
2531 }
2532 export interface EndpointBatchRequest {
2533 /**
2534 * 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.
2535 */
2536 Item: ListOfEndpointBatchItem;
2537 }
2538 export interface EndpointDemographic {
2539 /**
2540 * The version of the app that's associated with the endpoint.
2541 */
2542 AppVersion?: __string;
2543 /**
2544 * 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.
2545 */
2546 Locale?: __string;
2547 /**
2548 * The manufacturer of the endpoint device, such as Apple or Samsung.
2549 */
2550 Make?: __string;
2551 /**
2552 * The model name or number of the endpoint device, such as iPhone.
2553 */
2554 Model?: __string;
2555 /**
2556 * The model version of the endpoint device.
2557 */
2558 ModelVersion?: __string;
2559 /**
2560 * The platform of the endpoint device, such as iOS or Android.
2561 */
2562 Platform?: __string;
2563 /**
2564 * The platform version of the endpoint device.
2565 */
2566 PlatformVersion?: __string;
2567 /**
2568 * The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
2569 */
2570 Timezone?: __string;
2571 }
2572 export interface EndpointItemResponse {
2573 /**
2574 * The custom message that's returned in the response as a result of processing the endpoint data.
2575 */
2576 Message?: __string;
2577 /**
2578 * The status code that's returned in the response as a result of processing the endpoint data.
2579 */
2580 StatusCode?: __integer;
2581 }
2582 export interface EndpointLocation {
2583 /**
2584 * The name of the city where the endpoint is located.
2585 */
2586 City?: __string;
2587 /**
2588 * 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.
2589 */
2590 Country?: __string;
2591 /**
2592 * The latitude coordinate of the endpoint location, rounded to one decimal place.
2593 */
2594 Latitude?: __double;
2595 /**
2596 * The longitude coordinate of the endpoint location, rounded to one decimal place.
2597 */
2598 Longitude?: __double;
2599 /**
2600 * The postal or ZIP code for the area where the endpoint is located.
2601 */
2602 PostalCode?: __string;
2603 /**
2604 * The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
2605 */
2606 Region?: __string;
2607 }
2608 export interface EndpointMessageResult {
2609 /**
2610 * The endpoint address that the message was delivered to.
2611 */
2612 Address?: __string;
2613 /**
2614 * 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 will attempt to deliver the message again later. 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.
2615 */
2616 DeliveryStatus: DeliveryStatus;
2617 /**
2618 * The unique identifier for the message that was sent.
2619 */
2620 MessageId?: __string;
2621 /**
2622 * The downstream service status code for delivering the message.
2623 */
2624 StatusCode: __integer;
2625 /**
2626 * The status message for delivering the message.
2627 */
2628 StatusMessage?: __string;
2629 /**
2630 * 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.
2631 */
2632 UpdatedToken?: __string;
2633 }
2634 export interface EndpointRequest {
2635 /**
2636 * 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.
2637 */
2638 Address?: __string;
2639 /**
2640 * 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. 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 limitation doesn't apply to attribute values.
2641 */
2642 Attributes?: MapOfListOf__string;
2643 /**
2644 * The channel to use when sending messages or push notifications to the endpoint.
2645 */
2646 ChannelType?: ChannelType;
2647 /**
2648 * The demographic information for the endpoint, such as the time zone and platform.
2649 */
2650 Demographic?: EndpointDemographic;
2651 /**
2652 * The date and time, in ISO 8601 format, when the endpoint is updated.
2653 */
2654 EffectiveDate?: __string;
2655 /**
2656 * 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.
2657 */
2658 EndpointStatus?: __string;
2659 /**
2660 * The geographic information for the endpoint.
2661 */
2662 Location?: EndpointLocation;
2663 /**
2664 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
2665 */
2666 Metrics?: MapOf__double;
2667 /**
2668 * 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.
2669 */
2670 OptOut?: __string;
2671 /**
2672 * The unique identifier for the most recent request to update the endpoint.
2673 */
2674 RequestId?: __string;
2675 /**
2676 * One or more custom user attributes that describe the user who's associated with the endpoint.
2677 */
2678 User?: EndpointUser;
2679 }
2680 export interface EndpointResponse {
2681 /**
2682 * 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.
2683 */
2684 Address?: __string;
2685 /**
2686 * The unique identifier for the application that's associated with the endpoint.
2687 */
2688 ApplicationId?: __string;
2689 /**
2690 * 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.
2691 */
2692 Attributes?: MapOfListOf__string;
2693 /**
2694 * The channel that's used when sending messages or push notifications to the endpoint.
2695 */
2696 ChannelType?: ChannelType;
2697 /**
2698 * 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.
2699 */
2700 CohortId?: __string;
2701 /**
2702 * The date and time, in ISO 8601 format, when the endpoint was created.
2703 */
2704 CreationDate?: __string;
2705 /**
2706 * The demographic information for the endpoint, such as the time zone and platform.
2707 */
2708 Demographic?: EndpointDemographic;
2709 /**
2710 * The date and time, in ISO 8601 format, when the endpoint was last updated.
2711 */
2712 EffectiveDate?: __string;
2713 /**
2714 * 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.
2715 */
2716 EndpointStatus?: __string;
2717 /**
2718 * 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.
2719 */
2720 Id?: __string;
2721 /**
2722 * The geographic information for the endpoint.
2723 */
2724 Location?: EndpointLocation;
2725 /**
2726 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
2727 */
2728 Metrics?: MapOf__double;
2729 /**
2730 * 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.
2731 */
2732 OptOut?: __string;
2733 /**
2734 * The unique identifier for the most recent request to update the endpoint.
2735 */
2736 RequestId?: __string;
2737 /**
2738 * One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
2739 */
2740 User?: EndpointUser;
2741 }
2742 export interface EndpointSendConfiguration {
2743 /**
2744 * The body of the message. If specified, this value overrides the default message body.
2745 */
2746 BodyOverride?: __string;
2747 /**
2748 * A map of custom attributes to attach to the message for the address. 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.
2749 */
2750 Context?: MapOf__string;
2751 /**
2752 * The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
2753 */
2754 RawContent?: __string;
2755 /**
2756 * 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.
2757 */
2758 Substitutions?: MapOfListOf__string;
2759 /**
2760 * The title or subject line of the message. If specified, this value overrides the default message title or subject line.
2761 */
2762 TitleOverride?: __string;
2763 }
2764 export interface EndpointUser {
2765 /**
2766 * 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. 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 limitation doesn't apply to attribute values.
2767 */
2768 UserAttributes?: MapOfListOf__string;
2769 /**
2770 * The unique identifier for the user.
2771 */
2772 UserId?: __string;
2773 }
2774 export interface EndpointsResponse {
2775 /**
2776 * An array of responses, one for each endpoint that's associated with the user ID.
2777 */
2778 Item: ListOfEndpointResponse;
2779 }
2780 export interface Event {
2781 /**
2782 * The package name of the app that's recording the event.
2783 */
2784 AppPackageName?: __string;
2785 /**
2786 * The title of the app that's recording the event.
2787 */
2788 AppTitle?: __string;
2789 /**
2790 * The version number of the app that's recording the event.
2791 */
2792 AppVersionCode?: __string;
2793 /**
2794 * One or more custom attributes that are associated with the event.
2795 */
2796 Attributes?: MapOf__string;
2797 /**
2798 * The version of the SDK that's running on the client device.
2799 */
2800 ClientSdkVersion?: __string;
2801 /**
2802 * The name of the event.
2803 */
2804 EventType: __string;
2805 /**
2806 * One or more custom metrics that are associated with the event.
2807 */
2808 Metrics?: MapOf__double;
2809 /**
2810 * The name of the SDK that's being used to record the event.
2811 */
2812 SdkName?: __string;
2813 /**
2814 * Information about the session in which the event occurred.
2815 */
2816 Session?: Session;
2817 /**
2818 * The date and time, in ISO 8601 format, when the event occurred.
2819 */
2820 Timestamp: __string;
2821 }
2822 export interface EventDimensions {
2823 /**
2824 * One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
2825 */
2826 Attributes?: MapOfAttributeDimension;
2827 /**
2828 * The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
2829 */
2830 EventType?: SetDimension;
2831 /**
2832 * One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
2833 */
2834 Metrics?: MapOfMetricDimension;
2835 }
2836 export interface EventItemResponse {
2837 /**
2838 * A custom message that's returned in the response as a result of processing the event.
2839 */
2840 Message?: __string;
2841 /**
2842 * 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.
2843 */
2844 StatusCode?: __integer;
2845 }
2846 export interface EventStream {
2847 /**
2848 * The unique identifier for the application to publish event data for.
2849 */
2850 ApplicationId: __string;
2851 /**
2852 * 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
2853 For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
2854
2855 */
2856 DestinationStreamArn: __string;
2857 /**
2858 * (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.
2859 */
2860 ExternalId?: __string;
2861 /**
2862 * The date, in ISO 8601 format, when the event stream was last modified.
2863 */
2864 LastModifiedDate?: __string;
2865 /**
2866 * The IAM user who last modified the event stream.
2867 */
2868 LastUpdatedBy?: __string;
2869 /**
2870 * The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
2871 */
2872 RoleArn: __string;
2873 }
2874 export interface EventsBatch {
2875 /**
2876 * A set of properties and attributes that are associated with the endpoint.
2877 */
2878 Endpoint: PublicEndpoint;
2879 /**
2880 * A set of properties that are associated with the event.
2881 */
2882 Events: MapOfEvent;
2883 }
2884 export interface EventsRequest {
2885 /**
2886 * 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.
2887 */
2888 BatchItem: MapOfEventsBatch;
2889 }
2890 export interface EventsResponse {
2891 /**
2892 * 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.
2893 */
2894 Results?: MapOfItemResponse;
2895 }
2896 export interface ExportJobRequest {
2897 /**
2898 * 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.
2899 */
2900 RoleArn: __string;
2901 /**
2902 * 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/.
2903 */
2904 S3UrlPrefix: __string;
2905 /**
2906 * 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.
2907 */
2908 SegmentId?: __string;
2909 /**
2910 * The version of the segment to export endpoint definitions from, if specified.
2911 */
2912 SegmentVersion?: __integer;
2913 }
2914 export interface ExportJobResource {
2915 /**
2916 * 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.
2917 */
2918 RoleArn: __string;
2919 /**
2920 * 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/.
2921 */
2922 S3UrlPrefix: __string;
2923 /**
2924 * 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.
2925 */
2926 SegmentId?: __string;
2927 /**
2928 * The version of the segment that the endpoint definitions were exported from.
2929 */
2930 SegmentVersion?: __integer;
2931 }
2932 export interface ExportJobResponse {
2933 /**
2934 * The unique identifier for the application that's associated with the export job.
2935 */
2936 ApplicationId: __string;
2937 /**
2938 * The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
2939 */
2940 CompletedPieces?: __integer;
2941 /**
2942 * The date, in ISO 8601 format, when the export job was completed.
2943 */
2944 CompletionDate?: __string;
2945 /**
2946 * The date, in ISO 8601 format, when the export job was created.
2947 */
2948 CreationDate: __string;
2949 /**
2950 * The resource settings that apply to the export job.
2951 */
2952 Definition: ExportJobResource;
2953 /**
2954 * The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
2955 */
2956 FailedPieces?: __integer;
2957 /**
2958 * An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
2959 */
2960 Failures?: ListOf__string;
2961 /**
2962 * The unique identifier for the export job.
2963 */
2964 Id: __string;
2965 /**
2966 * 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.
2967 */
2968 JobStatus: JobStatus;
2969 /**
2970 * 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.
2971 */
2972 TotalFailures?: __integer;
2973 /**
2974 * 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.
2975 */
2976 TotalPieces?: __integer;
2977 /**
2978 * The total number of endpoint definitions that were processed by the export job.
2979 */
2980 TotalProcessed?: __integer;
2981 /**
2982 * The job type. This value is EXPORT for export jobs.
2983 */
2984 Type: __string;
2985 }
2986 export interface ExportJobsResponse {
2987 /**
2988 * An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
2989 */
2990 Item: ListOfExportJobResponse;
2991 /**
2992 * 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.
2993 */
2994 NextToken?: __string;
2995 }
2996 export type FilterType = "SYSTEM"|"ENDPOINT"|string;
2997 export type Format = "CSV"|"JSON"|string;
2998 export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string;
2999 export interface GCMChannelRequest {
3000 /**
3001 * The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
3002 */
3003 ApiKey: __string;
3004 /**
3005 * Specifies whether to enable the GCM channel for the application.
3006 */
3007 Enabled?: __boolean;
3008 }
3009 export interface GCMChannelResponse {
3010 /**
3011 * The unique identifier for the application that the GCM channel applies to.
3012 */
3013 ApplicationId?: __string;
3014 /**
3015 * The date and time when the GCM channel was enabled.
3016 */
3017 CreationDate?: __string;
3018 /**
3019 * The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
3020 */
3021 Credential: __string;
3022 /**
3023 * Specifies whether the GCM channel is enabled for the application.
3024 */
3025 Enabled?: __boolean;
3026 /**
3027 * (Not used) This property is retained only for backward compatibility.
3028 */
3029 HasCredential?: __boolean;
3030 /**
3031 * (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
3032 */
3033 Id?: __string;
3034 /**
3035 * Specifies whether the GCM channel is archived.
3036 */
3037 IsArchived?: __boolean;
3038 /**
3039 * The user who last modified the GCM channel.
3040 */
3041 LastModifiedBy?: __string;
3042 /**
3043 * The date and time when the GCM channel was last modified.
3044 */
3045 LastModifiedDate?: __string;
3046 /**
3047 * The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
3048 */
3049 Platform: __string;
3050 /**
3051 * The current version of the GCM channel.
3052 */
3053 Version?: __integer;
3054 }
3055 export interface GCMMessage {
3056 /**
3057 * 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.
3058 */
3059 Action?: Action;
3060 /**
3061 * The body of the notification message.
3062 */
3063 Body?: __string;
3064 /**
3065 * 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.
3066 */
3067 CollapseKey?: __string;
3068 /**
3069 * 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.
3070 */
3071 Data?: MapOf__string;
3072 /**
3073 * The icon image name of the asset saved in your app.
3074 */
3075 IconReference?: __string;
3076 /**
3077 * The URL of the large icon image to display in the content view of the push notification.
3078 */
3079 ImageIconUrl?: __string;
3080 /**
3081 * The URL of an image to display in the push notification.
3082 */
3083 ImageUrl?: __string;
3084 /**
3085 * 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.
3086 */
3087 Priority?: __string;
3088 /**
3089 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
3090 */
3091 RawContent?: __string;
3092 /**
3093 * The package name of the application where registration tokens must match in order for the recipient to receive the message.
3094 */
3095 RestrictedPackageName?: __string;
3096 /**
3097 * 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.
3098 */
3099 SilentPush?: __boolean;
3100 /**
3101 * The URL of the small icon image to display in the status bar and the content view of the push notification.
3102 */
3103 SmallImageIconUrl?: __string;
3104 /**
3105 * 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/.
3106 */
3107 Sound?: __string;
3108 /**
3109 * The default message variables to use in the notification message. You can override the default variables with individual address variables.
3110 */
3111 Substitutions?: MapOfListOf__string;
3112 /**
3113 * 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.
3114 */
3115 TimeToLive?: __integer;
3116 /**
3117 * The title to display above the notification message on the recipient's device.
3118 */
3119 Title?: __string;
3120 /**
3121 * 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.
3122 */
3123 Url?: __string;
3124 }
3125 export interface GPSCoordinates {
3126 /**
3127 * The latitude coordinate of the location.
3128 */
3129 Latitude: __double;
3130 /**
3131 * The longitude coordinate of the location.
3132 */
3133 Longitude: __double;
3134 }
3135 export interface GPSPointDimension {
3136 /**
3137 * The GPS coordinates to measure distance from.
3138 */
3139 Coordinates: GPSCoordinates;
3140 /**
3141 * The range, in kilometers, from the GPS coordinates.
3142 */
3143 RangeInKilometers?: __double;
3144 }
3145 export interface GetAdmChannelRequest {
3146 /**
3147 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3148 */
3149 ApplicationId: __string;
3150 }
3151 export interface GetAdmChannelResponse {
3152 ADMChannelResponse: ADMChannelResponse;
3153 }
3154 export interface GetApnsChannelRequest {
3155 /**
3156 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3157 */
3158 ApplicationId: __string;
3159 }
3160 export interface GetApnsChannelResponse {
3161 APNSChannelResponse: APNSChannelResponse;
3162 }
3163 export interface GetApnsSandboxChannelRequest {
3164 /**
3165 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3166 */
3167 ApplicationId: __string;
3168 }
3169 export interface GetApnsSandboxChannelResponse {
3170 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
3171 }
3172 export interface GetApnsVoipChannelRequest {
3173 /**
3174 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3175 */
3176 ApplicationId: __string;
3177 }
3178 export interface GetApnsVoipChannelResponse {
3179 APNSVoipChannelResponse: APNSVoipChannelResponse;
3180 }
3181 export interface GetApnsVoipSandboxChannelRequest {
3182 /**
3183 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3184 */
3185 ApplicationId: __string;
3186 }
3187 export interface GetApnsVoipSandboxChannelResponse {
3188 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
3189 }
3190 export interface GetAppRequest {
3191 /**
3192 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3193 */
3194 ApplicationId: __string;
3195 }
3196 export interface GetAppResponse {
3197 ApplicationResponse: ApplicationResponse;
3198 }
3199 export interface GetApplicationDateRangeKpiRequest {
3200 /**
3201 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3202 */
3203 ApplicationId: __string;
3204 /**
3205 * 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, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.
3206 */
3207 EndTime?: __timestampIso8601;
3208 /**
3209 * 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.
3210 */
3211 KpiName: __string;
3212 /**
3213 * The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3214 */
3215 NextToken?: __string;
3216 /**
3217 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3218 */
3219 PageSize?: __string;
3220 /**
3221 * 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, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.
3222 */
3223 StartTime?: __timestampIso8601;
3224 }
3225 export interface GetApplicationDateRangeKpiResponse {
3226 ApplicationDateRangeKpiResponse: ApplicationDateRangeKpiResponse;
3227 }
3228 export interface GetApplicationSettingsRequest {
3229 /**
3230 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3231 */
3232 ApplicationId: __string;
3233 }
3234 export interface GetApplicationSettingsResponse {
3235 ApplicationSettingsResource: ApplicationSettingsResource;
3236 }
3237 export interface GetAppsRequest {
3238 /**
3239 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3240 */
3241 PageSize?: __string;
3242 /**
3243 * The NextToken string that specifies which page of results to return in a paginated response.
3244 */
3245 Token?: __string;
3246 }
3247 export interface GetAppsResponse {
3248 ApplicationsResponse: ApplicationsResponse;
3249 }
3250 export interface GetBaiduChannelRequest {
3251 /**
3252 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3253 */
3254 ApplicationId: __string;
3255 }
3256 export interface GetBaiduChannelResponse {
3257 BaiduChannelResponse: BaiduChannelResponse;
3258 }
3259 export interface GetCampaignActivitiesRequest {
3260 /**
3261 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3262 */
3263 ApplicationId: __string;
3264 /**
3265 * The unique identifier for the campaign.
3266 */
3267 CampaignId: __string;
3268 /**
3269 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3270 */
3271 PageSize?: __string;
3272 /**
3273 * The NextToken string that specifies which page of results to return in a paginated response.
3274 */
3275 Token?: __string;
3276 }
3277 export interface GetCampaignActivitiesResponse {
3278 ActivitiesResponse: ActivitiesResponse;
3279 }
3280 export interface GetCampaignDateRangeKpiRequest {
3281 /**
3282 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3283 */
3284 ApplicationId: __string;
3285 /**
3286 * The unique identifier for the campaign.
3287 */
3288 CampaignId: __string;
3289 /**
3290 * 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, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.
3291 */
3292 EndTime?: __timestampIso8601;
3293 /**
3294 * 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.
3295 */
3296 KpiName: __string;
3297 /**
3298 * The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3299 */
3300 NextToken?: __string;
3301 /**
3302 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3303 */
3304 PageSize?: __string;
3305 /**
3306 * 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, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.
3307 */
3308 StartTime?: __timestampIso8601;
3309 }
3310 export interface GetCampaignDateRangeKpiResponse {
3311 CampaignDateRangeKpiResponse: CampaignDateRangeKpiResponse;
3312 }
3313 export interface GetCampaignRequest {
3314 /**
3315 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3316 */
3317 ApplicationId: __string;
3318 /**
3319 * The unique identifier for the campaign.
3320 */
3321 CampaignId: __string;
3322 }
3323 export interface GetCampaignResponse {
3324 CampaignResponse: CampaignResponse;
3325 }
3326 export interface GetCampaignVersionRequest {
3327 /**
3328 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3329 */
3330 ApplicationId: __string;
3331 /**
3332 * The unique identifier for the campaign.
3333 */
3334 CampaignId: __string;
3335 /**
3336 * The unique version number (Version property) for the campaign version.
3337 */
3338 Version: __string;
3339 }
3340 export interface GetCampaignVersionResponse {
3341 CampaignResponse: CampaignResponse;
3342 }
3343 export interface GetCampaignVersionsRequest {
3344 /**
3345 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3346 */
3347 ApplicationId: __string;
3348 /**
3349 * The unique identifier for the campaign.
3350 */
3351 CampaignId: __string;
3352 /**
3353 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3354 */
3355 PageSize?: __string;
3356 /**
3357 * The NextToken string that specifies which page of results to return in a paginated response.
3358 */
3359 Token?: __string;
3360 }
3361 export interface GetCampaignVersionsResponse {
3362 CampaignsResponse: CampaignsResponse;
3363 }
3364 export interface GetCampaignsRequest {
3365 /**
3366 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3367 */
3368 ApplicationId: __string;
3369 /**
3370 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3371 */
3372 PageSize?: __string;
3373 /**
3374 * The NextToken string that specifies which page of results to return in a paginated response.
3375 */
3376 Token?: __string;
3377 }
3378 export interface GetCampaignsResponse {
3379 CampaignsResponse: CampaignsResponse;
3380 }
3381 export interface GetChannelsRequest {
3382 /**
3383 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3384 */
3385 ApplicationId: __string;
3386 }
3387 export interface GetChannelsResponse {
3388 ChannelsResponse: ChannelsResponse;
3389 }
3390 export interface GetEmailChannelRequest {
3391 /**
3392 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3393 */
3394 ApplicationId: __string;
3395 }
3396 export interface GetEmailChannelResponse {
3397 EmailChannelResponse: EmailChannelResponse;
3398 }
3399 export interface GetEmailTemplateRequest {
3400 /**
3401 * 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.
3402 */
3403 TemplateName: __string;
3404 }
3405 export interface GetEmailTemplateResponse {
3406 EmailTemplateResponse: EmailTemplateResponse;
3407 }
3408 export interface GetEndpointRequest {
3409 /**
3410 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3411 */
3412 ApplicationId: __string;
3413 /**
3414 * The unique identifier for the endpoint.
3415 */
3416 EndpointId: __string;
3417 }
3418 export interface GetEndpointResponse {
3419 EndpointResponse: EndpointResponse;
3420 }
3421 export interface GetEventStreamRequest {
3422 /**
3423 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3424 */
3425 ApplicationId: __string;
3426 }
3427 export interface GetEventStreamResponse {
3428 EventStream: EventStream;
3429 }
3430 export interface GetExportJobRequest {
3431 /**
3432 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3433 */
3434 ApplicationId: __string;
3435 /**
3436 * The unique identifier for the job.
3437 */
3438 JobId: __string;
3439 }
3440 export interface GetExportJobResponse {
3441 ExportJobResponse: ExportJobResponse;
3442 }
3443 export interface GetExportJobsRequest {
3444 /**
3445 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3446 */
3447 ApplicationId: __string;
3448 /**
3449 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3450 */
3451 PageSize?: __string;
3452 /**
3453 * The NextToken string that specifies which page of results to return in a paginated response.
3454 */
3455 Token?: __string;
3456 }
3457 export interface GetExportJobsResponse {
3458 ExportJobsResponse: ExportJobsResponse;
3459 }
3460 export interface GetGcmChannelRequest {
3461 /**
3462 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3463 */
3464 ApplicationId: __string;
3465 }
3466 export interface GetGcmChannelResponse {
3467 GCMChannelResponse: GCMChannelResponse;
3468 }
3469 export interface GetImportJobRequest {
3470 /**
3471 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3472 */
3473 ApplicationId: __string;
3474 /**
3475 * The unique identifier for the job.
3476 */
3477 JobId: __string;
3478 }
3479 export interface GetImportJobResponse {
3480 ImportJobResponse: ImportJobResponse;
3481 }
3482 export interface GetImportJobsRequest {
3483 /**
3484 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3485 */
3486 ApplicationId: __string;
3487 /**
3488 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3489 */
3490 PageSize?: __string;
3491 /**
3492 * The NextToken string that specifies which page of results to return in a paginated response.
3493 */
3494 Token?: __string;
3495 }
3496 export interface GetImportJobsResponse {
3497 ImportJobsResponse: ImportJobsResponse;
3498 }
3499 export interface GetPushTemplateRequest {
3500 /**
3501 * 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.
3502 */
3503 TemplateName: __string;
3504 }
3505 export interface GetPushTemplateResponse {
3506 PushNotificationTemplateResponse: PushNotificationTemplateResponse;
3507 }
3508 export interface GetSegmentExportJobsRequest {
3509 /**
3510 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3511 */
3512 ApplicationId: __string;
3513 /**
3514 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3515 */
3516 PageSize?: __string;
3517 /**
3518 * The unique identifier for the segment.
3519 */
3520 SegmentId: __string;
3521 /**
3522 * The NextToken string that specifies which page of results to return in a paginated response.
3523 */
3524 Token?: __string;
3525 }
3526 export interface GetSegmentExportJobsResponse {
3527 ExportJobsResponse: ExportJobsResponse;
3528 }
3529 export interface GetSegmentImportJobsRequest {
3530 /**
3531 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3532 */
3533 ApplicationId: __string;
3534 /**
3535 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3536 */
3537 PageSize?: __string;
3538 /**
3539 * The unique identifier for the segment.
3540 */
3541 SegmentId: __string;
3542 /**
3543 * The NextToken string that specifies which page of results to return in a paginated response.
3544 */
3545 Token?: __string;
3546 }
3547 export interface GetSegmentImportJobsResponse {
3548 ImportJobsResponse: ImportJobsResponse;
3549 }
3550 export interface GetSegmentRequest {
3551 /**
3552 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3553 */
3554 ApplicationId: __string;
3555 /**
3556 * The unique identifier for the segment.
3557 */
3558 SegmentId: __string;
3559 }
3560 export interface GetSegmentResponse {
3561 SegmentResponse: SegmentResponse;
3562 }
3563 export interface GetSegmentVersionRequest {
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 * The unique identifier for the segment.
3570 */
3571 SegmentId: __string;
3572 /**
3573 * The unique version number (Version property) for the campaign version.
3574 */
3575 Version: __string;
3576 }
3577 export interface GetSegmentVersionResponse {
3578 SegmentResponse: SegmentResponse;
3579 }
3580 export interface GetSegmentVersionsRequest {
3581 /**
3582 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3583 */
3584 ApplicationId: __string;
3585 /**
3586 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3587 */
3588 PageSize?: __string;
3589 /**
3590 * The unique identifier for the segment.
3591 */
3592 SegmentId: __string;
3593 /**
3594 * The NextToken string that specifies which page of results to return in a paginated response.
3595 */
3596 Token?: __string;
3597 }
3598 export interface GetSegmentVersionsResponse {
3599 SegmentsResponse: SegmentsResponse;
3600 }
3601 export interface GetSegmentsRequest {
3602 /**
3603 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3604 */
3605 ApplicationId: __string;
3606 /**
3607 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3608 */
3609 PageSize?: __string;
3610 /**
3611 * The NextToken string that specifies which page of results to return in a paginated response.
3612 */
3613 Token?: __string;
3614 }
3615 export interface GetSegmentsResponse {
3616 SegmentsResponse: SegmentsResponse;
3617 }
3618 export interface GetSmsChannelRequest {
3619 /**
3620 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3621 */
3622 ApplicationId: __string;
3623 }
3624 export interface GetSmsChannelResponse {
3625 SMSChannelResponse: SMSChannelResponse;
3626 }
3627 export interface GetSmsTemplateRequest {
3628 /**
3629 * 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.
3630 */
3631 TemplateName: __string;
3632 }
3633 export interface GetSmsTemplateResponse {
3634 SMSTemplateResponse: SMSTemplateResponse;
3635 }
3636 export interface GetUserEndpointsRequest {
3637 /**
3638 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3639 */
3640 ApplicationId: __string;
3641 /**
3642 * The unique identifier for the user.
3643 */
3644 UserId: __string;
3645 }
3646 export interface GetUserEndpointsResponse {
3647 EndpointsResponse: EndpointsResponse;
3648 }
3649 export interface GetVoiceChannelRequest {
3650 /**
3651 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
3652 */
3653 ApplicationId: __string;
3654 }
3655 export interface GetVoiceChannelResponse {
3656 VoiceChannelResponse: VoiceChannelResponse;
3657 }
3658 export interface ImportJobRequest {
3659 /**
3660 * Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
3661 */
3662 DefineSegment?: __boolean;
3663 /**
3664 * (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.
3665 */
3666 ExternalId?: __string;
3667 /**
3668 * 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.
3669 */
3670 Format: Format;
3671 /**
3672 * Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
3673 */
3674 RegisterEndpoints?: __boolean;
3675 /**
3676 * 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.
3677 */
3678 RoleArn: __string;
3679 /**
3680 * 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.
3681 */
3682 S3Url: __string;
3683 /**
3684 * 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.
3685 */
3686 SegmentId?: __string;
3687 /**
3688 * The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
3689 */
3690 SegmentName?: __string;
3691 }
3692 export interface ImportJobResource {
3693 /**
3694 * Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
3695 */
3696 DefineSegment?: __boolean;
3697 /**
3698 * (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.
3699 */
3700 ExternalId?: __string;
3701 /**
3702 * 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.
3703 */
3704 Format: Format;
3705 /**
3706 * Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
3707 */
3708 RegisterEndpoints?: __boolean;
3709 /**
3710 * 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.
3711 */
3712 RoleArn: __string;
3713 /**
3714 * 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.
3715 */
3716 S3Url: __string;
3717 /**
3718 * The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
3719 */
3720 SegmentId?: __string;
3721 /**
3722 * The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
3723 */
3724 SegmentName?: __string;
3725 }
3726 export interface ImportJobResponse {
3727 /**
3728 * The unique identifier for the application that's associated with the import job.
3729 */
3730 ApplicationId: __string;
3731 /**
3732 * The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
3733 */
3734 CompletedPieces?: __integer;
3735 /**
3736 * The date, in ISO 8601 format, when the import job was completed.
3737 */
3738 CompletionDate?: __string;
3739 /**
3740 * The date, in ISO 8601 format, when the import job was created.
3741 */
3742 CreationDate: __string;
3743 /**
3744 * The resource settings that apply to the import job.
3745 */
3746 Definition: ImportJobResource;
3747 /**
3748 * The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
3749 */
3750 FailedPieces?: __integer;
3751 /**
3752 * An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
3753 */
3754 Failures?: ListOf__string;
3755 /**
3756 * The unique identifier for the import job.
3757 */
3758 Id: __string;
3759 /**
3760 * 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.
3761 */
3762 JobStatus: JobStatus;
3763 /**
3764 * 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.
3765 */
3766 TotalFailures?: __integer;
3767 /**
3768 * 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.
3769 */
3770 TotalPieces?: __integer;
3771 /**
3772 * The total number of endpoint definitions that were processed by the import job.
3773 */
3774 TotalProcessed?: __integer;
3775 /**
3776 * The job type. This value is IMPORT for import jobs.
3777 */
3778 Type: __string;
3779 }
3780 export interface ImportJobsResponse {
3781 /**
3782 * An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
3783 */
3784 Item: ListOfImportJobResponse;
3785 /**
3786 * 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.
3787 */
3788 NextToken?: __string;
3789 }
3790 export type Include = "ALL"|"ANY"|"NONE"|string;
3791 export interface ItemResponse {
3792 /**
3793 * The response that was received after the endpoint data was accepted.
3794 */
3795 EndpointItemResponse?: EndpointItemResponse;
3796 /**
3797 * 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.
3798 */
3799 EventsItemResponse?: MapOfEventItemResponse;
3800 }
3801 export type JobStatus = "CREATED"|"INITIALIZING"|"PROCESSING"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED"|string;
3802 export interface ListTagsForResourceRequest {
3803 /**
3804 * The Amazon Resource Name (ARN) of the application, campaign, message template, or segment.
3805 */
3806 ResourceArn: __string;
3807 }
3808 export interface ListTagsForResourceResponse {
3809 TagsModel: TagsModel;
3810 }
3811 export interface ListTemplatesRequest {
3812 /**
3813 * The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3814 */
3815 NextToken?: __string;
3816 /**
3817 * The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
3818 */
3819 PageSize?: __string;
3820 /**
3821 * 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.
3822 */
3823 Prefix?: __string;
3824 /**
3825 * The type of message template to include in the results. Valid values are: EMAIL, SMS, and PUSH. To include all types of templates in the results, don't include this parameter in your request.
3826 */
3827 TemplateType?: __string;
3828 }
3829 export interface ListTemplatesResponse {
3830 TemplatesResponse: TemplatesResponse;
3831 }
3832 export interface Message {
3833 /**
3834 * 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.
3835 */
3836 Action?: Action;
3837 /**
3838 * The body of the notification message. The maximum number of characters is 200.
3839 */
3840 Body?: __string;
3841 /**
3842 * The URL of the image to display as the push-notification icon, such as the icon for the app.
3843 */
3844 ImageIconUrl?: __string;
3845 /**
3846 * The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
3847 */
3848 ImageSmallIconUrl?: __string;
3849 /**
3850 * The URL of an image to display in the push notification.
3851 */
3852 ImageUrl?: __string;
3853 /**
3854 * The JSON payload to use for a silent push notification.
3855 */
3856 JsonBody?: __string;
3857 /**
3858 * The URL of the image or video to display in the push notification.
3859 */
3860 MediaUrl?: __string;
3861 /**
3862 * The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
3863 */
3864 RawContent?: __string;
3865 /**
3866 * 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.
3867 */
3868 SilentPush?: __boolean;
3869 /**
3870 * 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.
3871 */
3872 TimeToLive?: __integer;
3873 /**
3874 * The title to display above the notification message on a recipient's device.
3875 */
3876 Title?: __string;
3877 /**
3878 * 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.
3879 */
3880 Url?: __string;
3881 }
3882 export interface MessageBody {
3883 /**
3884 * The message that's returned from the API.
3885 */
3886 Message?: __string;
3887 /**
3888 * The unique identifier for the request or response.
3889 */
3890 RequestID?: __string;
3891 }
3892 export interface MessageConfiguration {
3893 /**
3894 * The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
3895 */
3896 ADMMessage?: Message;
3897 /**
3898 * The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
3899 */
3900 APNSMessage?: Message;
3901 /**
3902 * The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
3903 */
3904 BaiduMessage?: Message;
3905 /**
3906 * The default message that the campaign sends through all the channels that are configured for the campaign.
3907 */
3908 DefaultMessage?: Message;
3909 /**
3910 * The message that the campaign sends through the email channel.
3911 */
3912 EmailMessage?: CampaignEmailMessage;
3913 /**
3914 * 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.
3915 */
3916 GCMMessage?: Message;
3917 /**
3918 * The message that the campaign sends through the SMS channel.
3919 */
3920 SMSMessage?: CampaignSmsMessage;
3921 }
3922 export interface MessageRequest {
3923 /**
3924 * 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.
3925 */
3926 Addresses?: MapOfAddressConfiguration;
3927 /**
3928 * 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.
3929 */
3930 Context?: MapOf__string;
3931 /**
3932 * 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.
3933 */
3934 Endpoints?: MapOfEndpointSendConfiguration;
3935 /**
3936 * The set of properties that defines the configuration settings for the message.
3937 */
3938 MessageConfiguration: DirectMessageConfiguration;
3939 /**
3940 * The message template to use for the message.
3941 */
3942 TemplateConfiguration?: TemplateConfiguration;
3943 /**
3944 * The unique identifier for tracing the message. This identifier is visible to message recipients.
3945 */
3946 TraceId?: __string;
3947 }
3948 export interface MessageResponse {
3949 /**
3950 * The unique identifier for the application that was used to send the message.
3951 */
3952 ApplicationId: __string;
3953 /**
3954 * 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.
3955 */
3956 EndpointResult?: MapOfEndpointMessageResult;
3957 /**
3958 * The identifier for the original request that the message was delivered for.
3959 */
3960 RequestId?: __string;
3961 /**
3962 * 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.
3963 */
3964 Result?: MapOfMessageResult;
3965 }
3966 export interface MessageResult {
3967 /**
3968 * 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 will attempt to deliver the message again later. 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.
3969 */
3970 DeliveryStatus: DeliveryStatus;
3971 /**
3972 * The unique identifier for the message that was sent.
3973 */
3974 MessageId?: __string;
3975 /**
3976 * The downstream service status code for delivering the message.
3977 */
3978 StatusCode: __integer;
3979 /**
3980 * The status message for delivering the message.
3981 */
3982 StatusMessage?: __string;
3983 /**
3984 * 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.
3985 */
3986 UpdatedToken?: __string;
3987 }
3988 export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string;
3989 export interface MetricDimension {
3990 /**
3991 * 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.
3992 */
3993 ComparisonOperator: __string;
3994 /**
3995 * The value to compare.
3996 */
3997 Value: __double;
3998 }
3999 export type Mode = "DELIVERY"|"FILTER"|string;
4000 export interface NumberValidateRequest {
4001 /**
4002 * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
4003 */
4004 IsoCountryCode?: __string;
4005 /**
4006 * 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.
4007 */
4008 PhoneNumber?: __string;
4009 }
4010 export interface NumberValidateResponse {
4011 /**
4012 * 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.
4013 */
4014 Carrier?: __string;
4015 /**
4016 * The name of the city where the phone number was originally registered.
4017 */
4018 City?: __string;
4019 /**
4020 * The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
4021 */
4022 CleansedPhoneNumberE164?: __string;
4023 /**
4024 * The cleansed phone number, in the format for the location where the phone number was originally registered.
4025 */
4026 CleansedPhoneNumberNational?: __string;
4027 /**
4028 * The name of the country or region where the phone number was originally registered.
4029 */
4030 Country?: __string;
4031 /**
4032 * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
4033 */
4034 CountryCodeIso2?: __string;
4035 /**
4036 * The numeric code for the country or region where the phone number was originally registered.
4037 */
4038 CountryCodeNumeric?: __string;
4039 /**
4040 * The name of the county where the phone number was originally registered.
4041 */
4042 County?: __string;
4043 /**
4044 * The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
4045 */
4046 OriginalCountryCodeIso2?: __string;
4047 /**
4048 * The phone number that was sent in the request body.
4049 */
4050 OriginalPhoneNumber?: __string;
4051 /**
4052 * The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
4053 INVALID, PREPAID, and OTHER.
4054 */
4055 PhoneType?: __string;
4056 /**
4057 * The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
4058 */
4059 PhoneTypeCode?: __integer;
4060 /**
4061 * The time zone for the location where the phone number was originally registered.
4062 */
4063 Timezone?: __string;
4064 /**
4065 * The postal or ZIP code for the location where the phone number was originally registered.
4066 */
4067 ZipCode?: __string;
4068 }
4069 export interface PhoneNumberValidateRequest {
4070 NumberValidateRequest: NumberValidateRequest;
4071 }
4072 export interface PhoneNumberValidateResponse {
4073 NumberValidateResponse: NumberValidateResponse;
4074 }
4075 export interface PublicEndpoint {
4076 /**
4077 * The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
4078 */
4079 Address?: __string;
4080 /**
4081 * 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.
4082 */
4083 Attributes?: MapOfListOf__string;
4084 /**
4085 * The channel that's used when sending messages or push notifications to the endpoint.
4086 */
4087 ChannelType?: ChannelType;
4088 /**
4089 * The demographic information for the endpoint, such as the time zone and platform.
4090 */
4091 Demographic?: EndpointDemographic;
4092 /**
4093 * The date and time, in ISO 8601 format, when the endpoint was last updated.
4094 */
4095 EffectiveDate?: __string;
4096 /**
4097 * 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.
4098 */
4099 EndpointStatus?: __string;
4100 /**
4101 * The geographic information for the endpoint.
4102 */
4103 Location?: EndpointLocation;
4104 /**
4105 * One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
4106 */
4107 Metrics?: MapOf__double;
4108 /**
4109 * 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.
4110 */
4111 OptOut?: __string;
4112 /**
4113 * A unique identifier that's generated each time the endpoint is updated.
4114 */
4115 RequestId?: __string;
4116 /**
4117 * One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
4118 */
4119 User?: EndpointUser;
4120 }
4121 export interface PushNotificationTemplateRequest {
4122 /**
4123 * The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4124 */
4125 ADM?: AndroidPushNotificationTemplate;
4126 /**
4127 * 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).
4128 */
4129 APNS?: APNSPushNotificationTemplate;
4130 /**
4131 * The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
4132 */
4133 Baidu?: AndroidPushNotificationTemplate;
4134 /**
4135 * The default message template to use for push notification channels.
4136 */
4137 Default?: DefaultPushNotificationTemplate;
4138 /**
4139 * 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).
4140 */
4141 GCM?: AndroidPushNotificationTemplate;
4142 /**
4143 * 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.
4144 */
4145 tags?: MapOf__string;
4146 }
4147 export interface PushNotificationTemplateResponse {
4148 /**
4149 * 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).
4150 */
4151 ADM?: AndroidPushNotificationTemplate;
4152 /**
4153 * 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).
4154 */
4155 APNS?: APNSPushNotificationTemplate;
4156 /**
4157 * The Amazon Resource Name (ARN) of the message template.
4158 */
4159 Arn?: __string;
4160 /**
4161 * 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).
4162 */
4163 Baidu?: AndroidPushNotificationTemplate;
4164 /**
4165 * The date when the message template was created.
4166 */
4167 CreationDate: __string;
4168 /**
4169 * The default message template that's used for push notification channels.
4170 */
4171 Default?: DefaultPushNotificationTemplate;
4172 /**
4173 * 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).
4174 */
4175 GCM?: AndroidPushNotificationTemplate;
4176 /**
4177 * The date when the message template was last modified.
4178 */
4179 LastModifiedDate: __string;
4180 /**
4181 * 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.
4182 */
4183 tags?: MapOf__string;
4184 /**
4185 * The name of the message template.
4186 */
4187 TemplateName: __string;
4188 /**
4189 * The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
4190 */
4191 TemplateType: TemplateType;
4192 }
4193 export interface PutEventStreamRequest {
4194 /**
4195 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4196 */
4197 ApplicationId: __string;
4198 WriteEventStream: WriteEventStream;
4199 }
4200 export interface PutEventStreamResponse {
4201 EventStream: EventStream;
4202 }
4203 export interface PutEventsRequest {
4204 /**
4205 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4206 */
4207 ApplicationId: __string;
4208 EventsRequest: EventsRequest;
4209 }
4210 export interface PutEventsResponse {
4211 EventsResponse: EventsResponse;
4212 }
4213 export interface QuietTime {
4214 /**
4215 * 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.
4216 */
4217 End?: __string;
4218 /**
4219 * 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.
4220 */
4221 Start?: __string;
4222 }
4223 export interface RawEmail {
4224 /**
4225 * The email message, represented as a raw MIME message. The entire message must be base64 encoded.
4226 */
4227 Data?: __blob;
4228 }
4229 export type __blob = Buffer|Uint8Array|Blob|string;
4230 export interface RecencyDimension {
4231 /**
4232 * The duration to use when determining whether an endpoint is active or inactive.
4233 */
4234 Duration: Duration;
4235 /**
4236 * 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.
4237 */
4238 RecencyType: RecencyType;
4239 }
4240 export type RecencyType = "ACTIVE"|"INACTIVE"|string;
4241 export interface RemoveAttributesRequest {
4242 /**
4243 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4244 */
4245 ApplicationId: __string;
4246 /**
4247 * 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-custom-metrics - 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.
4248 */
4249 AttributeType: __string;
4250 UpdateAttributesRequest: UpdateAttributesRequest;
4251 }
4252 export interface RemoveAttributesResponse {
4253 AttributesResource: AttributesResource;
4254 }
4255 export interface ResultRow {
4256 /**
4257 * 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.
4258 */
4259 GroupedBys: ListOfResultRowValue;
4260 /**
4261 * An array of objects that provides pre-aggregated values for a standard metric that applies to an application or campaign.
4262 */
4263 Values: ListOfResultRowValue;
4264 }
4265 export interface ResultRowValue {
4266 /**
4267 * The name of the field that Amazon Pinpoint uses to store the value specified by the Value property.
4268 */
4269 Key: __string;
4270 /**
4271 * The data type of the value specified by the Value property.
4272 */
4273 Type: __string;
4274 /**
4275 * 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).
4276 */
4277 Value: __string;
4278 }
4279 export interface SMSChannelRequest {
4280 /**
4281 * Specifies whether to enable the SMS channel for the application.
4282 */
4283 Enabled?: __boolean;
4284 /**
4285 * The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
4286 */
4287 SenderId?: __string;
4288 /**
4289 * The registered short code that you want to use when you send messages through the SMS channel.
4290 */
4291 ShortCode?: __string;
4292 }
4293 export interface SMSChannelResponse {
4294 /**
4295 * The unique identifier for the application that the SMS channel applies to.
4296 */
4297 ApplicationId?: __string;
4298 /**
4299 * The date and time, in ISO 8601 format, when the SMS channel was enabled.
4300 */
4301 CreationDate?: __string;
4302 /**
4303 * Specifies whether the SMS channel is enabled for the application.
4304 */
4305 Enabled?: __boolean;
4306 /**
4307 * (Not used) This property is retained only for backward compatibility.
4308 */
4309 HasCredential?: __boolean;
4310 /**
4311 * (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
4312 */
4313 Id?: __string;
4314 /**
4315 * Specifies whether the SMS channel is archived.
4316 */
4317 IsArchived?: __boolean;
4318 /**
4319 * The user who last modified the SMS channel.
4320 */
4321 LastModifiedBy?: __string;
4322 /**
4323 * The date and time, in ISO 8601 format, when the SMS channel was last modified.
4324 */
4325 LastModifiedDate?: __string;
4326 /**
4327 * The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
4328 */
4329 Platform: __string;
4330 /**
4331 * The maximum number of promotional messages that you can send through the SMS channel each second.
4332 */
4333 PromotionalMessagesPerSecond?: __integer;
4334 /**
4335 * The identity that displays on recipients' devices when they receive messages from the SMS channel.
4336 */
4337 SenderId?: __string;
4338 /**
4339 * The registered short code to use when you send messages through the SMS channel.
4340 */
4341 ShortCode?: __string;
4342 /**
4343 * The maximum number of transactional messages that you can send through the SMS channel each second.
4344 */
4345 TransactionalMessagesPerSecond?: __integer;
4346 /**
4347 * The current version of the SMS channel.
4348 */
4349 Version?: __integer;
4350 }
4351 export interface SMSMessage {
4352 /**
4353 * The body of the SMS message.
4354 */
4355 Body?: __string;
4356 /**
4357 * The SMS program name that you provided to AWS Support when you requested your dedicated number.
4358 */
4359 Keyword?: __string;
4360 /**
4361 * 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.
4362 */
4363 MessageType?: MessageType;
4364 /**
4365 * 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.
4366 */
4367 OriginationNumber?: __string;
4368 /**
4369 * 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.
4370 */
4371 SenderId?: __string;
4372 /**
4373 * The message variables to use in the SMS message. You can override the default variables with individual address variables.
4374 */
4375 Substitutions?: MapOfListOf__string;
4376 }
4377 export interface SMSTemplateRequest {
4378 /**
4379 * The message body to use in text messages that are based on the message template.
4380 */
4381 Body?: __string;
4382 /**
4383 * 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.
4384 */
4385 tags?: MapOf__string;
4386 }
4387 export interface SMSTemplateResponse {
4388 /**
4389 * The Amazon Resource Name (ARN) of the message template.
4390 */
4391 Arn?: __string;
4392 /**
4393 * The message body that's used in text messages that are based on the message template.
4394 */
4395 Body?: __string;
4396 /**
4397 * The date when the message template was created.
4398 */
4399 CreationDate: __string;
4400 /**
4401 * The date when the message template was last modified.
4402 */
4403 LastModifiedDate: __string;
4404 /**
4405 * 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.
4406 */
4407 tags?: MapOf__string;
4408 /**
4409 * The name of the message template.
4410 */
4411 TemplateName: __string;
4412 /**
4413 * The type of channel that the message template is designed for. For an SMS template, this value is SMS.
4414 */
4415 TemplateType: TemplateType;
4416 }
4417 export interface Schedule {
4418 /**
4419 * The scheduled time, in ISO 8601 format, for the campaign to end.
4420 */
4421 EndTime?: __string;
4422 /**
4423 * The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
4424 */
4425 EventFilter?: CampaignEventFilter;
4426 /**
4427 * Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
4428 */
4429 Frequency?: Frequency;
4430 /**
4431 * 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.
4432 */
4433 IsLocalTime?: __boolean;
4434 /**
4435 * 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.
4436 */
4437 QuietTime?: QuietTime;
4438 /**
4439 * The scheduled time, in ISO 8601 format, for the campaign to begin.
4440 */
4441 StartTime: __string;
4442 /**
4443 * 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,
4444 UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,
4445 UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,
4446 UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
4447 */
4448 Timezone?: __string;
4449 }
4450 export interface SegmentBehaviors {
4451 /**
4452 * The dimension settings that are based on how recently an endpoint was active.
4453 */
4454 Recency?: RecencyDimension;
4455 }
4456 export interface SegmentDemographics {
4457 /**
4458 * The app version criteria for the segment.
4459 */
4460 AppVersion?: SetDimension;
4461 /**
4462 * The channel criteria for the segment.
4463 */
4464 Channel?: SetDimension;
4465 /**
4466 * The device type criteria for the segment.
4467 */
4468 DeviceType?: SetDimension;
4469 /**
4470 * The device make criteria for the segment.
4471 */
4472 Make?: SetDimension;
4473 /**
4474 * The device model criteria for the segment.
4475 */
4476 Model?: SetDimension;
4477 /**
4478 * The device platform criteria for the segment.
4479 */
4480 Platform?: SetDimension;
4481 }
4482 export interface SegmentDimensions {
4483 /**
4484 * One or more custom attributes to use as criteria for the segment.
4485 */
4486 Attributes?: MapOfAttributeDimension;
4487 /**
4488 * The behavior-based criteria, such as how recently users have used your app, for the segment.
4489 */
4490 Behavior?: SegmentBehaviors;
4491 /**
4492 * The demographic-based criteria, such as device platform, for the segment.
4493 */
4494 Demographic?: SegmentDemographics;
4495 /**
4496 * The location-based criteria, such as region or GPS coordinates, for the segment.
4497 */
4498 Location?: SegmentLocation;
4499 /**
4500 * One or more custom metrics to use as criteria for the segment.
4501 */
4502 Metrics?: MapOfMetricDimension;
4503 /**
4504 * One or more custom user attributes to use as criteria for the segment.
4505 */
4506 UserAttributes?: MapOfAttributeDimension;
4507 }
4508 export interface SegmentGroup {
4509 /**
4510 * An array that defines the dimensions for the segment.
4511 */
4512 Dimensions?: ListOfSegmentDimensions;
4513 /**
4514 * 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.
4515 */
4516 SourceSegments?: ListOfSegmentReference;
4517 /**
4518 * 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.
4519 */
4520 SourceType?: SourceType;
4521 /**
4522 * 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.
4523 */
4524 Type?: Type;
4525 }
4526 export interface SegmentGroupList {
4527 /**
4528 * An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
4529 */
4530 Groups?: ListOfSegmentGroup;
4531 /**
4532 * 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.
4533 */
4534 Include?: Include;
4535 }
4536 export interface SegmentImportResource {
4537 /**
4538 * The number of channel types in the endpoint definitions that were imported to create the segment.
4539 */
4540 ChannelCounts?: MapOf__integer;
4541 /**
4542 * (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.
4543 */
4544 ExternalId: __string;
4545 /**
4546 * 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.
4547 */
4548 Format: Format;
4549 /**
4550 * 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.
4551 */
4552 RoleArn: __string;
4553 /**
4554 * The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
4555 */
4556 S3Url: __string;
4557 /**
4558 * The number of endpoint definitions that were imported successfully to create the segment.
4559 */
4560 Size: __integer;
4561 }
4562 export interface SegmentLocation {
4563 /**
4564 * The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
4565 */
4566 Country?: SetDimension;
4567 /**
4568 * The GPS location and range for the segment.
4569 */
4570 GPSPoint?: GPSPointDimension;
4571 }
4572 export interface SegmentReference {
4573 /**
4574 * The unique identifier for the segment.
4575 */
4576 Id: __string;
4577 /**
4578 * The version number of the segment.
4579 */
4580 Version?: __integer;
4581 }
4582 export interface SegmentResponse {
4583 /**
4584 * The unique identifier for the application that the segment is associated with.
4585 */
4586 ApplicationId: __string;
4587 /**
4588 * The Amazon Resource Name (ARN) of the segment.
4589 */
4590 Arn: __string;
4591 /**
4592 * The date and time when the segment was created.
4593 */
4594 CreationDate: __string;
4595 /**
4596 * The dimension settings for the segment.
4597 */
4598 Dimensions?: SegmentDimensions;
4599 /**
4600 * The unique identifier for the segment.
4601 */
4602 Id: __string;
4603 /**
4604 * The settings for the import job that's associated with the segment.
4605 */
4606 ImportDefinition?: SegmentImportResource;
4607 /**
4608 * The date and time when the segment was last modified.
4609 */
4610 LastModifiedDate?: __string;
4611 /**
4612 * The name of the segment.
4613 */
4614 Name?: __string;
4615 /**
4616 * 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.
4617 */
4618 SegmentGroups?: SegmentGroupList;
4619 /**
4620 * 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.
4621 */
4622 SegmentType: SegmentType;
4623 /**
4624 * 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.
4625 */
4626 tags?: MapOf__string;
4627 /**
4628 * The version number of the segment.
4629 */
4630 Version?: __integer;
4631 }
4632 export type SegmentType = "DIMENSIONAL"|"IMPORT"|string;
4633 export interface SegmentsResponse {
4634 /**
4635 * 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).
4636 */
4637 Item: ListOfSegmentResponse;
4638 /**
4639 * 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.
4640 */
4641 NextToken?: __string;
4642 }
4643 export interface SendMessagesRequest {
4644 /**
4645 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4646 */
4647 ApplicationId: __string;
4648 MessageRequest: MessageRequest;
4649 }
4650 export interface SendMessagesResponse {
4651 MessageResponse: MessageResponse;
4652 }
4653 export interface SendUsersMessageRequest {
4654 /**
4655 * 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.
4656 */
4657 Context?: MapOf__string;
4658 /**
4659 * The message definitions for the default message and any default messages that you defined for specific channels.
4660 */
4661 MessageConfiguration: DirectMessageConfiguration;
4662 /**
4663 * The message template to use for the message.
4664 */
4665 TemplateConfiguration?: TemplateConfiguration;
4666 /**
4667 * The unique identifier for tracing the message. This identifier is visible to message recipients.
4668 */
4669 TraceId?: __string;
4670 /**
4671 * 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.
4672 */
4673 Users: MapOfEndpointSendConfiguration;
4674 }
4675 export interface SendUsersMessageResponse {
4676 /**
4677 * The unique identifier for the application that was used to send the message.
4678 */
4679 ApplicationId: __string;
4680 /**
4681 * The unique identifier that was assigned to the message request.
4682 */
4683 RequestId?: __string;
4684 /**
4685 * 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.
4686 */
4687 Result?: MapOfMapOfEndpointMessageResult;
4688 }
4689 export interface SendUsersMessagesRequest {
4690 /**
4691 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4692 */
4693 ApplicationId: __string;
4694 SendUsersMessageRequest: SendUsersMessageRequest;
4695 }
4696 export interface SendUsersMessagesResponse {
4697 SendUsersMessageResponse: SendUsersMessageResponse;
4698 }
4699 export interface Session {
4700 /**
4701 * The duration of the session, in milliseconds.
4702 */
4703 Duration?: __integer;
4704 /**
4705 * The unique identifier for the session.
4706 */
4707 Id: __string;
4708 /**
4709 * The date and time when the session began.
4710 */
4711 StartTimestamp: __string;
4712 /**
4713 * The date and time when the session ended.
4714 */
4715 StopTimestamp?: __string;
4716 }
4717 export interface SetDimension {
4718 /**
4719 * 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.
4720 */
4721 DimensionType?: DimensionType;
4722 /**
4723 * 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.
4724 */
4725 Values: ListOf__string;
4726 }
4727 export interface SimpleEmail {
4728 /**
4729 * The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
4730 */
4731 HtmlPart?: SimpleEmailPart;
4732 /**
4733 * The subject line, or title, of the email.
4734 */
4735 Subject?: SimpleEmailPart;
4736 /**
4737 * The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
4738 */
4739 TextPart?: SimpleEmailPart;
4740 }
4741 export interface SimpleEmailPart {
4742 /**
4743 * The applicable character set for the message content.
4744 */
4745 Charset?: __string;
4746 /**
4747 * The textual data of the message content.
4748 */
4749 Data?: __string;
4750 }
4751 export type SourceType = "ALL"|"ANY"|"NONE"|string;
4752 export interface TagResourceRequest {
4753 /**
4754 * The Amazon Resource Name (ARN) of the application, campaign, message template, or segment.
4755 */
4756 ResourceArn: __string;
4757 TagsModel: TagsModel;
4758 }
4759 export interface TagsModel {
4760 /**
4761 * A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each project, campaign, message template, or segment 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.
4762 */
4763 tags: MapOf__string;
4764 }
4765 export interface Template {
4766 /**
4767 * The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
4768 */
4769 Name?: __string;
4770 }
4771 export interface TemplateConfiguration {
4772 /**
4773 * The email template to use for the message.
4774 */
4775 EmailTemplate?: Template;
4776 /**
4777 * The push notification template to use for the message.
4778 */
4779 PushTemplate?: Template;
4780 /**
4781 * The SMS template to use for the message.
4782 */
4783 SMSTemplate?: Template;
4784 }
4785 export interface TemplateResponse {
4786 /**
4787 * The Amazon Resource Name (ARN) of the message template.
4788 */
4789 Arn?: __string;
4790 /**
4791 * The date when the message template was created.
4792 */
4793 CreationDate: __string;
4794 /**
4795 * The date when the message template was last modified.
4796 */
4797 LastModifiedDate: __string;
4798 /**
4799 * 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.
4800 */
4801 tags?: MapOf__string;
4802 /**
4803 * The name of the message template.
4804 */
4805 TemplateName: __string;
4806 /**
4807 * The type of channel that the message template is designed for.
4808 */
4809 TemplateType: TemplateType;
4810 }
4811 export type TemplateType = "EMAIL"|"SMS"|"PUSH"|string;
4812 export interface TemplatesResponse {
4813 /**
4814 * 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.
4815 */
4816 Item: ListOfTemplateResponse;
4817 /**
4818 * 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.
4819 */
4820 NextToken?: __string;
4821 }
4822 export interface TreatmentResource {
4823 /**
4824 * The unique identifier for the treatment.
4825 */
4826 Id: __string;
4827 /**
4828 * The message configuration settings for the treatment.
4829 */
4830 MessageConfiguration?: MessageConfiguration;
4831 /**
4832 * The schedule settings for the treatment.
4833 */
4834 Schedule?: Schedule;
4835 /**
4836 * The allocated percentage of users (segment members) that the treatment is sent to.
4837 */
4838 SizePercent: __integer;
4839 /**
4840 * The status of the treatment.
4841 */
4842 State?: CampaignState;
4843 TemplateConfiguration?: TemplateConfiguration;
4844 /**
4845 * The custom description of the treatment.
4846 */
4847 TreatmentDescription?: __string;
4848 /**
4849 * The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
4850 */
4851 TreatmentName?: __string;
4852 }
4853 export type Type = "ALL"|"ANY"|"NONE"|string;
4854 export interface UntagResourceRequest {
4855 /**
4856 * The Amazon Resource Name (ARN) of the application, campaign, message template, or segment.
4857 */
4858 ResourceArn: __string;
4859 /**
4860 * The key of the tag to remove from the application, campaign, message template, or segment. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&amp;).
4861 */
4862 TagKeys: ListOf__string;
4863 }
4864 export interface UpdateAdmChannelRequest {
4865 ADMChannelRequest: ADMChannelRequest;
4866 /**
4867 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4868 */
4869 ApplicationId: __string;
4870 }
4871 export interface UpdateAdmChannelResponse {
4872 ADMChannelResponse: ADMChannelResponse;
4873 }
4874 export interface UpdateApnsChannelRequest {
4875 APNSChannelRequest: APNSChannelRequest;
4876 /**
4877 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4878 */
4879 ApplicationId: __string;
4880 }
4881 export interface UpdateApnsChannelResponse {
4882 APNSChannelResponse: APNSChannelResponse;
4883 }
4884 export interface UpdateApnsSandboxChannelRequest {
4885 APNSSandboxChannelRequest: APNSSandboxChannelRequest;
4886 /**
4887 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4888 */
4889 ApplicationId: __string;
4890 }
4891 export interface UpdateApnsSandboxChannelResponse {
4892 APNSSandboxChannelResponse: APNSSandboxChannelResponse;
4893 }
4894 export interface UpdateApnsVoipChannelRequest {
4895 APNSVoipChannelRequest: APNSVoipChannelRequest;
4896 /**
4897 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4898 */
4899 ApplicationId: __string;
4900 }
4901 export interface UpdateApnsVoipChannelResponse {
4902 APNSVoipChannelResponse: APNSVoipChannelResponse;
4903 }
4904 export interface UpdateApnsVoipSandboxChannelRequest {
4905 APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest;
4906 /**
4907 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4908 */
4909 ApplicationId: __string;
4910 }
4911 export interface UpdateApnsVoipSandboxChannelResponse {
4912 APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
4913 }
4914 export interface UpdateApplicationSettingsRequest {
4915 /**
4916 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4917 */
4918 ApplicationId: __string;
4919 WriteApplicationSettingsRequest: WriteApplicationSettingsRequest;
4920 }
4921 export interface UpdateApplicationSettingsResponse {
4922 ApplicationSettingsResource: ApplicationSettingsResource;
4923 }
4924 export interface UpdateAttributesRequest {
4925 /**
4926 * 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.
4927 */
4928 Blacklist?: ListOf__string;
4929 }
4930 export interface UpdateBaiduChannelRequest {
4931 /**
4932 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4933 */
4934 ApplicationId: __string;
4935 BaiduChannelRequest: BaiduChannelRequest;
4936 }
4937 export interface UpdateBaiduChannelResponse {
4938 BaiduChannelResponse: BaiduChannelResponse;
4939 }
4940 export interface UpdateCampaignRequest {
4941 /**
4942 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4943 */
4944 ApplicationId: __string;
4945 /**
4946 * The unique identifier for the campaign.
4947 */
4948 CampaignId: __string;
4949 WriteCampaignRequest: WriteCampaignRequest;
4950 }
4951 export interface UpdateCampaignResponse {
4952 CampaignResponse: CampaignResponse;
4953 }
4954 export interface UpdateEmailChannelRequest {
4955 /**
4956 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4957 */
4958 ApplicationId: __string;
4959 EmailChannelRequest: EmailChannelRequest;
4960 }
4961 export interface UpdateEmailChannelResponse {
4962 EmailChannelResponse: EmailChannelResponse;
4963 }
4964 export interface UpdateEmailTemplateRequest {
4965 EmailTemplateRequest: EmailTemplateRequest;
4966 /**
4967 * 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.
4968 */
4969 TemplateName: __string;
4970 }
4971 export interface UpdateEmailTemplateResponse {
4972 MessageBody: MessageBody;
4973 }
4974 export interface UpdateEndpointRequest {
4975 /**
4976 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4977 */
4978 ApplicationId: __string;
4979 /**
4980 * The unique identifier for the endpoint.
4981 */
4982 EndpointId: __string;
4983 EndpointRequest: EndpointRequest;
4984 }
4985 export interface UpdateEndpointResponse {
4986 MessageBody: MessageBody;
4987 }
4988 export interface UpdateEndpointsBatchRequest {
4989 /**
4990 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
4991 */
4992 ApplicationId: __string;
4993 EndpointBatchRequest: EndpointBatchRequest;
4994 }
4995 export interface UpdateEndpointsBatchResponse {
4996 MessageBody: MessageBody;
4997 }
4998 export interface UpdateGcmChannelRequest {
4999 /**
5000 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5001 */
5002 ApplicationId: __string;
5003 GCMChannelRequest: GCMChannelRequest;
5004 }
5005 export interface UpdateGcmChannelResponse {
5006 GCMChannelResponse: GCMChannelResponse;
5007 }
5008 export interface UpdatePushTemplateRequest {
5009 /**
5010 * Updates an existing message template that you can use in messages that are sent through a push notification channel.
5011 */
5012 PushNotificationTemplateRequest: PushNotificationTemplateRequest;
5013 /**
5014 * 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.
5015 */
5016 TemplateName: __string;
5017 }
5018 export interface UpdatePushTemplateResponse {
5019 MessageBody: MessageBody;
5020 }
5021 export interface UpdateSegmentRequest {
5022 /**
5023 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5024 */
5025 ApplicationId: __string;
5026 /**
5027 * The unique identifier for the segment.
5028 */
5029 SegmentId: __string;
5030 WriteSegmentRequest: WriteSegmentRequest;
5031 }
5032 export interface UpdateSegmentResponse {
5033 SegmentResponse: SegmentResponse;
5034 }
5035 export interface UpdateSmsChannelRequest {
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 SMSChannelRequest: SMSChannelRequest;
5041 }
5042 export interface UpdateSmsChannelResponse {
5043 SMSChannelResponse: SMSChannelResponse;
5044 }
5045 export interface UpdateSmsTemplateRequest {
5046 SMSTemplateRequest: SMSTemplateRequest;
5047 /**
5048 * 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.
5049 */
5050 TemplateName: __string;
5051 }
5052 export interface UpdateSmsTemplateResponse {
5053 MessageBody: MessageBody;
5054 }
5055 export interface UpdateVoiceChannelRequest {
5056 /**
5057 * The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
5058 */
5059 ApplicationId: __string;
5060 VoiceChannelRequest: VoiceChannelRequest;
5061 }
5062 export interface UpdateVoiceChannelResponse {
5063 VoiceChannelResponse: VoiceChannelResponse;
5064 }
5065 export interface VoiceChannelRequest {
5066 /**
5067 * Specifies whether to enable the voice channel for the application.
5068 */
5069 Enabled?: __boolean;
5070 }
5071 export interface VoiceChannelResponse {
5072 /**
5073 * The unique identifier for the application that the voice channel applies to.
5074 */
5075 ApplicationId?: __string;
5076 /**
5077 * The date and time, in ISO 8601 format, when the voice channel was enabled.
5078 */
5079 CreationDate?: __string;
5080 /**
5081 * Specifies whether the voice channel is enabled for the application.
5082 */
5083 Enabled?: __boolean;
5084 /**
5085 * (Not used) This property is retained only for backward compatibility.
5086 */
5087 HasCredential?: __boolean;
5088 /**
5089 * (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
5090 */
5091 Id?: __string;
5092 /**
5093 * Specifies whether the voice channel is archived.
5094 */
5095 IsArchived?: __boolean;
5096 /**
5097 * The user who last modified the voice channel.
5098 */
5099 LastModifiedBy?: __string;
5100 /**
5101 * The date and time, in ISO 8601 format, when the voice channel was last modified.
5102 */
5103 LastModifiedDate?: __string;
5104 /**
5105 * The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
5106 */
5107 Platform: __string;
5108 /**
5109 * The current version of the voice channel.
5110 */
5111 Version?: __integer;
5112 }
5113 export interface VoiceMessage {
5114 /**
5115 * The text script for the voice message.
5116 */
5117 Body?: __string;
5118 /**
5119 * The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
5120 */
5121 LanguageCode?: __string;
5122 /**
5123 * 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.
5124 */
5125 OriginationNumber?: __string;
5126 /**
5127 * The default message variables to use in the voice message. You can override the default variables with individual address variables.
5128 */
5129 Substitutions?: MapOfListOf__string;
5130 /**
5131 * The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
5132 */
5133 VoiceId?: __string;
5134 }
5135 export interface WriteApplicationSettingsRequest {
5136 /**
5137 * 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.
5138 */
5139 CampaignHook?: CampaignHook;
5140 /**
5141 * Specifies whether to enable application-related alarms in Amazon CloudWatch.
5142 */
5143 CloudWatchMetricsEnabled?: __boolean;
5144 /**
5145 * 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.
5146 */
5147 Limits?: CampaignLimits;
5148 /**
5149 * The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don'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 application (or a campaign 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 that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled. To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
5150 */
5151 QuietTime?: QuietTime;
5152 }
5153 export interface WriteCampaignRequest {
5154 /**
5155 * An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
5156 */
5157 AdditionalTreatments?: ListOfWriteTreatmentResource;
5158 /**
5159 * The custom description of the campaign.
5160 */
5161 Description?: __string;
5162 /**
5163 * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
5164 */
5165 HoldoutPercent?: __integer;
5166 /**
5167 * The settings for the AWS Lambda function to use as a code hook for the campaign.
5168 */
5169 Hook?: CampaignHook;
5170 /**
5171 * Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
5172 */
5173 IsPaused?: __boolean;
5174 /**
5175 * The messaging limits for the campaign.
5176 */
5177 Limits?: CampaignLimits;
5178 /**
5179 * The message configuration settings for the campaign.
5180 */
5181 MessageConfiguration?: MessageConfiguration;
5182 /**
5183 * The custom name of the campaign.
5184 */
5185 Name?: __string;
5186 /**
5187 * The schedule settings for the campaign.
5188 */
5189 Schedule?: Schedule;
5190 /**
5191 * The unique identifier for the segment to associate with the campaign.
5192 */
5193 SegmentId?: __string;
5194 /**
5195 * The version of the segment to associate with the campaign.
5196 */
5197 SegmentVersion?: __integer;
5198 /**
5199 * 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.
5200 */
5201 tags?: MapOf__string;
5202 TemplateConfiguration?: TemplateConfiguration;
5203 /**
5204 * The custom description of a variation of the campaign to use for A/B testing.
5205 */
5206 TreatmentDescription?: __string;
5207 /**
5208 * The custom name of a variation of the campaign to use for A/B testing.
5209 */
5210 TreatmentName?: __string;
5211 }
5212 export interface WriteEventStream {
5213 /**
5214 * 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
5215 For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
5216
5217 */
5218 DestinationStreamArn: __string;
5219 /**
5220 * The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
5221 */
5222 RoleArn: __string;
5223 }
5224 export interface WriteSegmentRequest {
5225 /**
5226 * The criteria that define the dimensions for the segment.
5227 */
5228 Dimensions?: SegmentDimensions;
5229 /**
5230 * The name of the segment.
5231 */
5232 Name?: __string;
5233 /**
5234 * 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.
5235 */
5236 SegmentGroups?: SegmentGroupList;
5237 /**
5238 * 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.
5239 */
5240 tags?: MapOf__string;
5241 }
5242 export interface WriteTreatmentResource {
5243 /**
5244 * The message configuration settings for the treatment.
5245 */
5246 MessageConfiguration?: MessageConfiguration;
5247 /**
5248 * The schedule settings for the treatment.
5249 */
5250 Schedule?: Schedule;
5251 /**
5252 * The allocated percentage of users (segment members) to send the treatment to.
5253 */
5254 SizePercent: __integer;
5255 TemplateConfiguration?: TemplateConfiguration;
5256 /**
5257 * The custom description of the treatment.
5258 */
5259 TreatmentDescription?: __string;
5260 /**
5261 * The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
5262 */
5263 TreatmentName?: __string;
5264 }
5265 export type __boolean = boolean;
5266 export type __double = number;
5267 export type __integer = number;
5268 export type ListOfActivityResponse = ActivityResponse[];
5269 export type ListOfApplicationResponse = ApplicationResponse[];
5270 export type ListOfCampaignResponse = CampaignResponse[];
5271 export type ListOfEndpointBatchItem = EndpointBatchItem[];
5272 export type ListOfEndpointResponse = EndpointResponse[];
5273 export type ListOfExportJobResponse = ExportJobResponse[];
5274 export type ListOfImportJobResponse = ImportJobResponse[];
5275 export type ListOfResultRow = ResultRow[];
5276 export type ListOfResultRowValue = ResultRowValue[];
5277 export type ListOfSegmentDimensions = SegmentDimensions[];
5278 export type ListOfSegmentGroup = SegmentGroup[];
5279 export type ListOfSegmentReference = SegmentReference[];
5280 export type ListOfSegmentResponse = SegmentResponse[];
5281 export type ListOfTemplateResponse = TemplateResponse[];
5282 export type ListOfTreatmentResource = TreatmentResource[];
5283 export type ListOfWriteTreatmentResource = WriteTreatmentResource[];
5284 export type ListOf__string = __string[];
5285 export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration};
5286 export type MapOfAttributeDimension = {[key: string]: AttributeDimension};
5287 export type MapOfChannelResponse = {[key: string]: ChannelResponse};
5288 export type MapOfEndpointMessageResult = {[key: string]: EndpointMessageResult};
5289 export type MapOfEndpointSendConfiguration = {[key: string]: EndpointSendConfiguration};
5290 export type MapOfEvent = {[key: string]: Event};
5291 export type MapOfEventItemResponse = {[key: string]: EventItemResponse};
5292 export type MapOfEventsBatch = {[key: string]: EventsBatch};
5293 export type MapOfItemResponse = {[key: string]: ItemResponse};
5294 export type MapOfMessageResult = {[key: string]: MessageResult};
5295 export type MapOfMetricDimension = {[key: string]: MetricDimension};
5296 export type MapOf__double = {[key: string]: __double};
5297 export type MapOf__integer = {[key: string]: __integer};
5298 export type MapOfListOf__string = {[key: string]: ListOf__string};
5299 export type MapOfMapOfEndpointMessageResult = {[key: string]: MapOfEndpointMessageResult};
5300 export type MapOf__string = {[key: string]: __string};
5301 export type __string = string;
5302 export type __timestampIso8601 = Date;
5303 /**
5304 * 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.
5305 */
5306 export type apiVersion = "2016-12-01"|"latest"|string;
5307 export interface ClientApiVersions {
5308 /**
5309 * 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.
5310 */
5311 apiVersion?: apiVersion;
5312 }
5313 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
5314 /**
5315 * Contains interfaces for use with the Pinpoint client.
5316 */
5317 export import Types = Pinpoint;
5318}
5319export = Pinpoint;