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