UNPKG

aws-sdk/clients/pinpoint.d.ts

Version:
171 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Pinpoint extends Service {
/**
 * Constructs a service object. This object has one method for each API operation.
 */
constructor(options?: Pinpoint.Types.ClientConfiguration)
config: Config & Pinpoint.Types.ClientConfiguration;
/**
 * Creates or updates an app.
 */
createApp(params: Pinpoint.Types.CreateAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
/**
 * Creates or updates an app.
 */
createApp(callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
/**
 * Creates or updates a campaign.
 */
createCampaign(params: Pinpoint.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
/**
 * Creates or updates a campaign.
 */
createCampaign(callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
/**
 * Creates an export job.
 */
createExportJob(params: Pinpoint.Types.CreateExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
/**
 * Creates an export job.
 */
createExportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
/**
 * Creates or updates an import job.
 */
createImportJob(params: Pinpoint.Types.CreateImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
/**
 * Creates or updates an import job.
 */
createImportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
/**
 * Used to create or update a segment.
 */
createSegment(params: Pinpoint.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
/**
 * Used to create or update a segment.
 */
createSegment(callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
/**
 * Delete an ADM channel.
 */
deleteAdmChannel(params: Pinpoint.Types.DeleteAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
/**
 * Delete an ADM channel.
 */
deleteAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
/**
 * Deletes the APNs channel for an app.
 */
deleteApnsChannel(params: Pinpoint.Types.DeleteApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
/**
 * Deletes the APNs channel for an app.
 */
deleteApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
/**
 * Delete an APNS sandbox channel.
 */
deleteApnsSandboxChannel(params: Pinpoint.Types.DeleteApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
/**
 * Delete an APNS sandbox channel.
 */
deleteApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
/**
 * Delete an APNS VoIP channel
 */
deleteApnsVoipChannel(params: Pinpoint.Types.DeleteApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
/**
 * Delete an APNS VoIP channel
 */
deleteApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
/**
 * Delete an APNS VoIP sandbox channel
 */
deleteApnsVoipSandboxChannel(params: Pinpoint.Types.DeleteApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Delete an APNS VoIP sandbox channel
 */
deleteApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Deletes an app.
 */
deleteApp(params: Pinpoint.Types.DeleteAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
/**
 * Deletes an app.
 */
deleteApp(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
/**
 * Delete a BAIDU GCM channel
 */
deleteBaiduChannel(params: Pinpoint.Types.DeleteBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
/**
 * Delete a BAIDU GCM channel
 */
deleteBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
/**
 * Deletes a campaign.
 */
deleteCampaign(params: Pinpoint.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
/**
 * Deletes a campaign.
 */
deleteCampaign(callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
/**
 * Delete an email channel.
 */
deleteEmailChannel(params: Pinpoint.Types.DeleteEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
/**
 * Delete an email channel.
 */
deleteEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
/**
 * Deletes an endpoint.
 */
deleteEndpoint(params: Pinpoint.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
/**
 * Deletes an endpoint.
 */
deleteEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
/**
 * Deletes the event stream for an app.
 */
deleteEventStream(params: Pinpoint.Types.DeleteEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
/**
 * Deletes the event stream for an app.
 */
deleteEventStream(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
/**
 * Deletes the GCM channel for an app.
 */
deleteGcmChannel(params: Pinpoint.Types.DeleteGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
/**
 * Deletes the GCM channel for an app.
 */
deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
/**
 * Deletes a segment.
 */
deleteSegment(params: Pinpoint.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
/**
 * Deletes a segment.
 */
deleteSegment(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
/**
 * Delete an SMS channel.
 */
deleteSmsChannel(params: Pinpoint.Types.DeleteSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
/**
 * Delete an SMS channel.
 */
deleteSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
/**
 * Deletes endpoints that are associated with a User ID.
 */
deleteUserEndpoints(params: Pinpoint.Types.DeleteUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
/**
 * Deletes endpoints that are associated with a User ID.
 */
deleteUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
/**
 * Delete an Voice channel
 */
deleteVoiceChannel(params: Pinpoint.Types.DeleteVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
/**
 * Delete an Voice channel
 */
deleteVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
/**
 * Get an ADM channel.
 */
getAdmChannel(params: Pinpoint.Types.GetAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
/**
 * Get an ADM channel.
 */
getAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
/**
 * Returns information about the APNs channel for an app.
 */
getApnsChannel(params: Pinpoint.Types.GetApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
/**
 * Returns information about the APNs channel for an app.
 */
getApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
/**
 * Get an APNS sandbox channel.
 */
getApnsSandboxChannel(params: Pinpoint.Types.GetApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
/**
 * Get an APNS sandbox channel.
 */
getApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
/**
 * Get an APNS VoIP channel
 */
getApnsVoipChannel(params: Pinpoint.Types.GetApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
/**
 * Get an APNS VoIP channel
 */
getApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
/**
 * Get an APNS VoIPSandbox channel
 */
getApnsVoipSandboxChannel(params: Pinpoint.Types.GetApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Get an APNS VoIPSandbox channel
 */
getApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Returns information about an app.
 */
getApp(params: Pinpoint.Types.GetAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
/**
 * Returns information about an app.
 */
getApp(callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
/**
 * Used to request the settings for an app.
 */
getApplicationSettings(params: Pinpoint.Types.GetApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
/**
 * Used to request the settings for an app.
 */
getApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
/**
 * Returns information about your apps.
 */
getApps(params: Pinpoint.Types.GetAppsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
/**
 * Returns information about your apps.
 */
getApps(callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
/**
 * Get a BAIDU GCM channel
 */
getBaiduChannel(params: Pinpoint.Types.GetBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
/**
 * Get a BAIDU GCM channel
 */
getBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
/**
 * Returns information about a campaign.
 */
getCampaign(params: Pinpoint.Types.GetCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
/**
 * Returns information about a campaign.
 */
getCampaign(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
/**
 * Returns information about the activity performed by a campaign.
 */
getCampaignActivities(params: Pinpoint.Types.GetCampaignActivitiesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
/**
 * Returns information about the activity performed by a campaign.
 */
getCampaignActivities(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
/**
 * Returns information about a specific version of a campaign.
 */
getCampaignVersion(params: Pinpoint.Types.GetCampaignVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
/**
 * Returns information about a specific version of a campaign.
 */
getCampaignVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
/**
 * Returns information about your campaign versions.
 */
getCampaignVersions(params: Pinpoint.Types.GetCampaignVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
/**
 * Returns information about your campaign versions.
 */
getCampaignVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
/**
 * Returns information about your campaigns.
 */
getCampaigns(params: Pinpoint.Types.GetCampaignsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
/**
 * Returns information about your campaigns.
 */
getCampaigns(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
/**
 * Get all channels.
 */
getChannels(params: Pinpoint.Types.GetChannelsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
/**
 * Get all channels.
 */
getChannels(callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
/**
 * Get an email channel.
 */
getEmailChannel(params: Pinpoint.Types.GetEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
/**
 * Get an email channel.
 */
getEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
/**
 * Returns information about an endpoint.
 */
getEndpoint(params: Pinpoint.Types.GetEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
/**
 * Returns information about an endpoint.
 */
getEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
/**
 * Returns the event stream for an app.
 */
getEventStream(params: Pinpoint.Types.GetEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
/**
 * Returns the event stream for an app.
 */
getEventStream(callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
/**
 * Returns information about an export job.
 */
getExportJob(params: Pinpoint.Types.GetExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
/**
 * Returns information about an export job.
 */
getExportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
/**
 * Returns information about your export jobs.
 */
getExportJobs(params: Pinpoint.Types.GetExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
/**
 * Returns information about your export jobs.
 */
getExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
/**
 * Returns information about the GCM channel for an app.
 */
getGcmChannel(params: Pinpoint.Types.GetGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
/**
 * Returns information about the GCM channel for an app.
 */
getGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
/**
 * Returns information about an import job.
 */
getImportJob(params: Pinpoint.Types.GetImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
/**
 * Returns information about an import job.
 */
getImportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
/**
 * Returns information about your import jobs.
 */
getImportJobs(params: Pinpoint.Types.GetImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
/**
 * Returns information about your import jobs.
 */
getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
/**
 * Returns information about a segment.
 */
getSegment(params: Pinpoint.Types.GetSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
/**
 * Returns information about a segment.
 */
getSegment(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
/**
 * Returns a list of export jobs for a specific segment.
 */
getSegmentExportJobs(params: Pinpoint.Types.GetSegmentExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
/**
 * Returns a list of export jobs for a specific segment.
 */
getSegmentExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
/**
 * Returns a list of import jobs for a specific segment.
 */
getSegmentImportJobs(params: Pinpoint.Types.GetSegmentImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
/**
 * Returns a list of import jobs for a specific segment.
 */
getSegmentImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
/**
 * Returns information about a segment version.
 */
getSegmentVersion(params: Pinpoint.Types.GetSegmentVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
/**
 * Returns information about a segment version.
 */
getSegmentVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
/**
 * Returns information about your segment versions.
 */
getSegmentVersions(params: Pinpoint.Types.GetSegmentVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
/**
 * Returns information about your segment versions.
 */
getSegmentVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
/**
 * Used to get information about your segments.
 */
getSegments(params: Pinpoint.Types.GetSegmentsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
/**
 * Used to get information about your segments.
 */
getSegments(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
/**
 * Get an SMS channel.
 */
getSmsChannel(params: Pinpoint.Types.GetSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
/**
 * Get an SMS channel.
 */
getSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
/**
 * Returns information about the endpoints that are associated with a User ID.
 */
getUserEndpoints(params: Pinpoint.Types.GetUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
/**
 * Returns information about the endpoints that are associated with a User ID.
 */
getUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
/**
 * Get a Voice Channel
 */
getVoiceChannel(params: Pinpoint.Types.GetVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
/**
 * Get a Voice Channel
 */
getVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
/**
 * 
 */
listTagsForResource(params: Pinpoint.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
/**
 * 
 */
listTagsForResource(callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
/**
 * Returns information about the specified phone number.
 */
phoneNumberValidate(params: Pinpoint.Types.PhoneNumberValidateRequest, callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
/**
 * Returns information about the specified phone number.
 */
phoneNumberValidate(callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
/**
 * Use to create or update the event stream for an app.
 */
putEventStream(params: Pinpoint.Types.PutEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
/**
 * Use to create or update the event stream for an app.
 */
putEventStream(callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
/**
 * Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.
 */
putEvents(params: Pinpoint.Types.PutEventsRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
/**
 * Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.
 */
putEvents(callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
/**
 * Used to remove the attributes for an app
 */
removeAttributes(params: Pinpoint.Types.RemoveAttributesRequest, callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
/**
 * Used to remove the attributes for an app
 */
removeAttributes(callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
/**
 * Used to send a direct message.
 */
sendMessages(params: Pinpoint.Types.SendMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
/**
 * Used to send a direct message.
 */
sendMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
/**
 * Used to send a message to a list of users.
 */
sendUsersMessages(params: Pinpoint.Types.SendUsersMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
/**
 * Used to send a message to a list of users.
 */
sendUsersMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
/**
 * 
 */
tagResource(params: Pinpoint.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
 * 
 */
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
 * 
 */
untagResource(params: Pinpoint.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
 * 
 */
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
 * Update an ADM channel.
 */
updateAdmChannel(params: Pinpoint.Types.UpdateAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
/**
 * Update an ADM channel.
 */
updateAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
/**
 * Use to update the APNs channel for an app.
 */
updateApnsChannel(params: Pinpoint.Types.UpdateApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
/**
 * Use to update the APNs channel for an app.
 */
updateApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
/**
 * Update an APNS sandbox channel.
 */
updateApnsSandboxChannel(params: Pinpoint.Types.UpdateApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
/**
 * Update an APNS sandbox channel.
 */
updateApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
/**
 * Update an APNS VoIP channel
 */
updateApnsVoipChannel(params: Pinpoint.Types.UpdateApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
/**
 * Update an APNS VoIP channel
 */
updateApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
/**
 * Update an APNS VoIP sandbox channel
 */
updateApnsVoipSandboxChannel(params: Pinpoint.Types.UpdateApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Update an APNS VoIP sandbox channel
 */
updateApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
/**
 * Used to update the settings for an app.
 */
updateApplicationSettings(params: Pinpoint.Types.UpdateApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
/**
 * Used to update the settings for an app.
 */
updateApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
/**
 * Update a BAIDU GCM channel
 */
updateBaiduChannel(params: Pinpoint.Types.UpdateBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
/**
 * Update a BAIDU GCM channel
 */
updateBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
/**
 * Use to update a campaign.
 */
updateCampaign(params: Pinpoint.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
/**
 * Use to update a campaign.
 */
updateCampaign(callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
/**
 * Update an email channel.
 */
updateEmailChannel(params: Pinpoint.Types.UpdateEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
/**
 * Update an email channel.
 */
updateEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
/**
 * Creates or updates an endpoint.
 */
updateEndpoint(params: Pinpoint.Types.UpdateEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
/**
 * Creates or updates an endpoint.
 */
updateEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
/**
 * Use to update a batch of endpoints.
 */
updateEndpointsBatch(params: Pinpoint.Types.UpdateEndpointsBatchRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
/**
 * Use to update a batch of endpoints.
 */
updateEndpointsBatch(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
/**
 * Use to update the GCM channel for an app.
 */
updateGcmChannel(params: Pinpoint.Types.UpdateGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
/**
 * Use to update the GCM channel for an app.
 */
updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
/**
 * Used to update a segment.
 */
updateSegment(params: Pinpoint.Types.UpdateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
/**
 * Used to update a segment.
 */
updateSegment(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
/**
 * Update an SMS channel.
 */
updateSmsChannel(params: Pinpoint.Types.UpdateSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
/**
 * Update an SMS channel.
 */
updateSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
/**
 * Update an Voice channel
 */
updateVoiceChannel(params: Pinpoint.Types.UpdateVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
/**
 * Update an Voice channel
 */
updateVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
630}
631declare namespace Pinpoint {
export interface ADMChannelRequest {
  /**
   * The Client ID that you obtained from the Amazon App Distribution Portal.
   */
  ClientId?: __string;
  /**
   * The Client Secret that you obtained from the Amazon App Distribution Portal.
   */
  ClientSecret?: __string;
  /**
   * Indicates whether or not the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
}
export interface ADMChannelResponse {
  /**
   * The ID of the application to which the channel applies.
   */
  ApplicationId?: __string;
  /**
   * The date and time when this channel was created.
   */
  CreationDate?: __string;
  /**
   * Indicates whether or not the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * (Deprecated) An identifier for the channel. Retained for backwards compatibility.
   */
  Id?: __string;
  /**
   * Indicates whether or not the channel is archived.
   */
  IsArchived?: __boolean;
  /**
   * The user who last updated this channel.
   */
  LastModifiedBy?: __string;
  /**
   * The date and time when this channel was last modified.
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. For this channel, the value is always "ADM."
   */
  Platform?: __string;
  /**
   * The channel version.
   */
  Version?: __integer;
}
export interface ADMMessage {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
   */
  Action?: Action;
  /**
   * The message body of the notification.
   */
  Body?: __string;
  /**
   * Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
   */
  ConsolidationKey?: __string;
  /**
   * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
   */
  Data?: MapOf__string;
  /**
   * Optional. Number of seconds ADM should retain the message if the device is offline
   */
  ExpiresAfter?: __string;
  /**
   * The icon image name of the asset saved in your application.
   */
  IconReference?: __string;
  /**
   * The URL that points to an image used as the large icon to the notification content view.
   */
  ImageIconUrl?: __string;
  /**
   * The URL that points to an image used in the push notification.
   */
  ImageUrl?: __string;
  /**
   * Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
   */
  MD5?: __string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
   */
  SilentPush?: __boolean;
  /**
   * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
   */
  SmallImageIconUrl?: __string;
  /**
   * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
   */
  Sound?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface APNSChannelRequest {
  /**
   * The bundle id used for APNs Tokens.
   */
  BundleId?: __string;
  /**
   * The distribution certificate from Apple.
   */
  Certificate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The certificate private key.
   */
  PrivateKey?: __string;
  /**
   * The team id used for APNs Tokens.
   */
  TeamId?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKey?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKeyId?: __string;
}
export interface APNSChannelResponse {
  /**
   * The ID of the application that the channel applies to.
   */
  ApplicationId?: __string;
  /**
   * The date and time when this channel was created.
   */
  CreationDate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
   */
  HasTokenKey?: __boolean;
  /**
   * (Deprecated) An identifier for the channel. Retained for backwards compatibility.
   */
  Id?: __string;
  /**
   * Indicates whether or not the channel is archived.
   */
  IsArchived?: __boolean;
  /**
   * The user who last updated this channel.
   */
  LastModifiedBy?: __string;
  /**
   * The date and time when this channel was last modified.
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. For this channel, the value is always "ADM."
   */
  Platform?: __string;
  /**
   * The channel version.
   */
  Version?: __integer;
}
export interface APNSMessage {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
   */
  Action?: Action;
  /**
   * Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
   */
  Badge?: __integer;
  /**
   * The message body of the notification.
   */
  Body?: __string;
  /**
   * Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
   */
  Category?: __string;
  /**
   * An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
   */
  CollapseId?: __string;
  /**
   * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
   */
  Data?: MapOf__string;
  /**
   * A URL that refers to the location of an image or video that you want to display in the push notification.
   */
  MediaUrl?: __string;
  /**
   * The preferred authentication method, either "CERTIFICATE" or "TOKEN"
   */
  PreferredAuthenticationMethod?: __string;
  /**
   * The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values:
873
874"5" - Low priority. Messages might be delayed, delivered in groups, and throttled.
875
876"10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device.
877
878The default value is "10".
879
880The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them.
881
882For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
   */
  Priority?: __string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
   */
  SilentPush?: __boolean;
  /**
   * Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
   */
  Sound?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
   */
  ThreadId?: __string;
  /**
   * The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
   */
  TimeToLive?: __integer;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface APNSSandboxChannelRequest {
  /**
   * The bundle id used for APNs Tokens.
   */
  BundleId?: __string;
  /**
   * The distribution certificate from Apple.
   */
  Certificate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The certificate private key.
   */
  PrivateKey?: __string;
  /**
   * The team id used for APNs Tokens.
   */
  TeamId?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKey?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKeyId?: __string;
}
export interface APNSSandboxChannelResponse {
  /**
   * The ID of the application to which the channel applies.
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
   */
  HasTokenKey?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who last updated this entry
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. Will be APNS_SANDBOX.
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface APNSVoipChannelRequest {
  /**
   * The bundle id used for APNs Tokens.
   */
  BundleId?: __string;
  /**
   * The distribution certificate from Apple.
   */
  Certificate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The certificate private key.
   */
  PrivateKey?: __string;
  /**
   * The team id used for APNs Tokens.
   */
  TeamId?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKey?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKeyId?: __string;
}
export interface APNSVoipChannelResponse {
  /**
   * Application id
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * If the channel is registered with a token key for authentication.
   */
  HasTokenKey?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who made the last change
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. Will be APNS.
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface APNSVoipSandboxChannelRequest {
  /**
   * The bundle id used for APNs Tokens.
   */
  BundleId?: __string;
  /**
   * The distribution certificate from Apple.
   */
  Certificate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The certificate private key.
   */
  PrivateKey?: __string;
  /**
   * The team id used for APNs Tokens.
   */
  TeamId?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKey?: __string;
  /**
   * The token key used for APNs Tokens.
   */
  TokenKeyId?: __string;
}
export interface APNSVoipSandboxChannelResponse {
  /**
   * Application id
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * The default authentication method used for APNs.
   */
  DefaultAuthenticationMethod?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * If the channel is registered with a token key for authentication.
   */
  HasTokenKey?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who made the last change
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. Will be APNS.
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export type Action = "OPEN_APP"|"DEEP_LINK"|"URL"|string;
export interface ActivitiesResponse {
  /**
   * List of campaign activities
   */
  Item?: ListOfActivityResponse;
  /**
   * The string that you use in a subsequent request to get the next page of results in a paginated response.
   */
  NextToken?: __string;
}
export interface ActivityResponse {
  /**
   * The ID of the application to which the campaign applies.
   */
  ApplicationId?: __string;
  /**
   * The ID of the campaign to which the activity applies.
   */
  CampaignId?: __string;
  /**
   * The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
   */
  End?: __string;
  /**
   * The unique activity ID.
   */
  Id?: __string;
  /**
   * Indicates whether the activity succeeded.
1200
1201Valid values: SUCCESS, FAIL
   */
  Result?: __string;
  /**
   * The scheduled start time for the activity in ISO 8601 format.
   */
  ScheduledStart?: __string;
  /**
   * The actual start time of the activity in ISO 8601 format.
   */
  Start?: __string;
  /**
   * The state of the activity.
1214
1215Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
   */
  State?: __string;
  /**
   * The total number of endpoints to which the campaign successfully delivered messages.
   */
  SuccessfulEndpointCount?: __integer;
  /**
   * The total number of timezones completed.
   */
  TimezonesCompletedCount?: __integer;
  /**
   * The total number of unique timezones present in the segment.
   */
  TimezonesTotalCount?: __integer;
  /**
   * The total number of endpoints to which the campaign attempts to deliver messages.
   */
  TotalEndpointCount?: __integer;
  /**
   * The ID of a variation of the campaign used for A/B testing.
   */
  TreatmentId?: __string;
}
export interface AddressConfiguration {
  /**
   * Body override. If specified will override default body.
   */
  BodyOverride?: __string;
  /**
   * The channel type.
1246
1247Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
   */
  ChannelType?: ChannelType;
  /**
   * A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
   */
  Context?: MapOf__string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * Title override. If specified will override default title if applicable.
   */
  TitleOverride?: __string;
}
export interface ApplicationResponse {
  /**
   * The arn for the application.
   */
  Arn?: __string;
  /**
   * The unique application ID.
   */
  Id?: __string;
  /**
   * The display name of the application.
   */
  Name?: __string;
  /**
   * The Tags for the application.
   */
  tags?: MapOf__string;
}
export interface ApplicationSettingsResource {
  /**
   * The unique ID for the application.
   */
  ApplicationId?: __string;
  /**
   * Default campaign hook.
   */
  CampaignHook?: CampaignHook;
  /**
   * The date that the settings were last updated in ISO 8601 format.
   */
  LastModifiedDate?: __string;
  /**
   * The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
   */
  Limits?: CampaignLimits;
  /**
   * The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time.
1304
1305Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled.
1306
1307When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true:
1308- The endpoint includes a valid Demographic.Timezone attribute.
1309- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable).
1310- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable).
1311
1312Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
   */
  QuietTime?: QuietTime;
}
export interface ApplicationsResponse {
  /**
   * List of applications returned in this page.
   */
  Item?: ListOfApplicationResponse;
  /**
   * The string that you use in a subsequent request to get the next page of results in a paginated response.
   */
  NextToken?: __string;
}
export interface AttributeDimension {
  /**
   * The type of dimension:
1329
1330INCLUSIVE - Endpoints that match the criteria are included in the segment.
1331
1332EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
   */
  AttributeType?: AttributeType;
  /**
   * The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
   */
  Values?: ListOf__string;
}
export type AttributeType = "INCLUSIVE"|"EXCLUSIVE"|string;
export interface AttributesResource {
  /**
   * The unique ID for the application.
   */
  ApplicationId?: __string;
  /**
   * The attribute type for the application.
   */
  AttributeType?: __string;
  /**
   * The attributes for the application.
   */
  Attributes?: ListOf__string;
}
export interface BaiduChannelRequest {
  /**
   * Platform credential API key from Baidu.
   */
  ApiKey?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Platform credential Secret key from Baidu.
   */
  SecretKey?: __string;
}
export interface BaiduChannelResponse {
  /**
   * Application id
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * The Baidu API key from Baidu.
   */
  Credential?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who made the last change
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. Will be BAIDU
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface BaiduMessage {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
   */
  Action?: Action;
  /**
   * The message body of the notification.
   */
  Body?: __string;
  /**
   * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
   */
  Data?: MapOf__string;
  /**
   * The icon image name of the asset saved in your application.
   */
  IconReference?: __string;
  /**
   * The URL that points to an image used as the large icon to the notification content view.
   */
  ImageIconUrl?: __string;
  /**
   * The URL that points to an image used in the push notification.
   */
  ImageUrl?: __string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
   */
  SilentPush?: __boolean;
  /**
   * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
   */
  SmallImageIconUrl?: __string;
  /**
   * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
   */
  Sound?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
   */
  TimeToLive?: __integer;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface CampaignEmailMessage {
  /**
   * The email text body.
   */
  Body?: __string;
  /**
   * The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
   */
  FromAddress?: __string;
  /**
   * The email html body.
   */
  HtmlBody?: __string;
  /**
   * The email title (Or subject).
   */
  Title?: __string;
}
export interface CampaignEventFilter {
  /**
   * An object that defines the dimensions for the event filter.
   */
  Dimensions?: EventDimensions;
  /**
   * The type of event that causes the campaign to be sent. Possible values:
1498
1499SYSTEM - Send the campaign when a system event occurs. See the System resource for more information.
1500
1501ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
   */
  FilterType?: FilterType;
}
export interface CampaignHook {
  /**
   * Lambda function name or arn to be called for delivery
   */
  LambdaFunctionName?: __string;
  /**
   * What mode Lambda should be invoked in.
   */
  Mode?: Mode;
  /**
   * Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
   */
  WebUrl?: __string;
}
export interface CampaignLimits {
  /**
   * The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period.
   */
  Daily?: __integer;
  /**
   * The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
   */
  MaximumDuration?: __integer;
  /**
   * The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
   */
  MessagesPerSecond?: __integer;
  /**
   * The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
   */
  Total?: __integer;
}
export interface CampaignResponse {
  /**
   * Treatments that are defined in addition to the default treatment.
   */
  AdditionalTreatments?: ListOfTreatmentResource;
  /**
   * The ID of the application to which the campaign applies.
   */
  ApplicationId?: __string;
  /**
   * The arn for the campaign.
   */
  Arn?: __string;
  /**
   * The date the campaign was created in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * The status of the campaign's default treatment. Only present for A/B test campaigns.
   */
  DefaultState?: CampaignState;
  /**
   * A description of the campaign.
   */
  Description?: __string;
  /**
   * The allocated percentage of end users who will not receive messages from this campaign.
   */
  HoldoutPercent?: __integer;
  /**
   * Campaign hook information.
   */
  Hook?: CampaignHook;
  /**
   * The unique campaign ID.
   */
  Id?: __string;
  /**
   * Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
   */
  IsPaused?: __boolean;
  /**
   * The date the campaign was last updated in ISO 8601 format.	
   */
  LastModifiedDate?: __string;
  /**
   * The campaign limits settings.
   */
  Limits?: CampaignLimits;
  /**
   * The message configuration settings.
   */
  MessageConfiguration?: MessageConfiguration;
  /**
   * The custom name of the campaign.
   */
  Name?: __string;
  /**
   * The campaign schedule.
   */
  Schedule?: Schedule;
  /**
   * The ID of the segment to which the campaign sends messages.
   */
  SegmentId?: __string;
  /**
   * The version of the segment to which the campaign sends messages.
   */
  SegmentVersion?: __integer;
  /**
   * The campaign status.
1608
1609An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
   */
  State?: CampaignState;
  /**
   * The Tags for the campaign.
   */
  tags?: MapOf__string;
  /**
   * A custom description for the treatment.
   */
  TreatmentDescription?: __string;
  /**
   * The custom name of a variation of the campaign used for A/B testing.
   */
  TreatmentName?: __string;
  /**
   * The campaign version number.
   */
  Version?: __integer;
}
export interface CampaignSmsMessage {
  /**
   * The SMS text body.
   */
  Body?: __string;
  /**
   * Is this is a transactional SMS message, otherwise a promotional message.
   */
  MessageType?: MessageType;
  /**
   * Sender ID of sent message.
   */
  SenderId?: __string;
}
export interface CampaignState {
  /**
   * The status of the campaign, or the status of a treatment that belongs to an A/B test campaign.
1646
1647Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
   */
  CampaignStatus?: CampaignStatus;
}
export type CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|string;
export interface CampaignsResponse {
  /**
   * A list of campaigns.
   */
  Item?: ListOfCampaignResponse;
  /**
   * The string that you use in a subsequent request to get the next page of results in a paginated response.
   */
  NextToken?: __string;
}
export interface ChannelResponse {
  /**
   * Application id
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who made the last change
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export type ChannelType = "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
export interface ChannelsResponse {
  /**
   * A map of channels, with the ChannelType as the key and the Channel as the value.
   */
  Channels?: MapOfChannelResponse;
}
export interface CreateAppRequest {
  CreateApplicationRequest: CreateApplicationRequest;
}
export interface CreateAppResponse {
  ApplicationResponse: ApplicationResponse;
}
export interface CreateApplicationRequest {
  /**
   * The display name of the application. Used in the Amazon Pinpoint console.
   */
  Name?: __string;
  /**
   * The Tags for the app.
   */
  tags?: MapOf__string;
}
export interface CreateCampaignRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  WriteCampaignRequest: WriteCampaignRequest;
}
export interface CreateCampaignResponse {
  CampaignResponse: CampaignResponse;
}
export interface CreateExportJobRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  ExportJobRequest: ExportJobRequest;
}
export interface CreateExportJobResponse {
  ExportJobResponse: ExportJobResponse;
}
export interface CreateImportJobRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  ImportJobRequest: ImportJobRequest;
}
export interface CreateImportJobResponse {
  ImportJobResponse: ImportJobResponse;
}
export interface CreateSegmentRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  WriteSegmentRequest: WriteSegmentRequest;
}
export interface CreateSegmentResponse {
  SegmentResponse: SegmentResponse;
}
export interface DefaultMessage {
  /**
   * The message body of the notification, the email body or the text message.
   */
  Body?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
}
export interface DefaultPushNotificationMessage {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
   */
  Action?: Action;
  /**
   * The message body of the notification.
   */
  Body?: __string;
  /**
   * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
   */
  Data?: MapOf__string;
  /**
   * Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.
   */
  SilentPush?: __boolean;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface DeleteAdmChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteAdmChannelResponse {
  ADMChannelResponse: ADMChannelResponse;
}
export interface DeleteApnsChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteApnsChannelResponse {
  APNSChannelResponse: APNSChannelResponse;
}
export interface DeleteApnsSandboxChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteApnsSandboxChannelResponse {
  APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface DeleteApnsVoipChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteApnsVoipChannelResponse {
  APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface DeleteApnsVoipSandboxChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteApnsVoipSandboxChannelResponse {
  APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface DeleteAppRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteAppResponse {
  ApplicationResponse: ApplicationResponse;
}
export interface DeleteBaiduChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteBaiduChannelResponse {
  BaiduChannelResponse: BaiduChannelResponse;
}
export interface DeleteCampaignRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
}
export interface DeleteCampaignResponse {
  CampaignResponse: CampaignResponse;
}
export interface DeleteEmailChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteEmailChannelResponse {
  EmailChannelResponse: EmailChannelResponse;
}
export interface DeleteEndpointRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the endpoint.
   */
  EndpointId: __string;
}
export interface DeleteEndpointResponse {
  EndpointResponse: EndpointResponse;
}
export interface DeleteEventStreamRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteEventStreamResponse {
  EventStream: EventStream;
}
export interface DeleteGcmChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteGcmChannelResponse {
  GCMChannelResponse: GCMChannelResponse;
}
export interface DeleteSegmentRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
}
export interface DeleteSegmentResponse {
  SegmentResponse: SegmentResponse;
}
export interface DeleteSmsChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteSmsChannelResponse {
  SMSChannelResponse: SMSChannelResponse;
}
export interface DeleteUserEndpointsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the user.
   */
  UserId: __string;
}
export interface DeleteUserEndpointsResponse {
  EndpointsResponse: EndpointsResponse;
}
export interface DeleteVoiceChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface DeleteVoiceChannelResponse {
  VoiceChannelResponse: VoiceChannelResponse;
}
export type DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE"|string;
export type DimensionType = "INCLUSIVE"|"EXCLUSIVE"|string;
export interface DirectMessageConfiguration {
  /**
   * The message to ADM channels. Overrides the default push notification message.
   */
  ADMMessage?: ADMMessage;
  /**
   * The message to APNS channels. Overrides the default push notification message.
   */
  APNSMessage?: APNSMessage;
  /**
   * The message to Baidu GCM channels. Overrides the default push notification message.
   */
  BaiduMessage?: BaiduMessage;
  /**
   * The default message for all channels.
   */
  DefaultMessage?: DefaultMessage;
  /**
   * The default push notification message for all push channels.
   */
  DefaultPushNotificationMessage?: DefaultPushNotificationMessage;
  /**
   * The message to Email channels. Overrides the default message.
   */
  EmailMessage?: EmailMessage;
  /**
   * The message to GCM channels. Overrides the default push notification message.
   */
  GCMMessage?: GCMMessage;
  /**
   * The message to SMS channels. Overrides the default message.
   */
  SMSMessage?: SMSMessage;
  /**
   * The message to Voice channels. Overrides the default message.
   */
  VoiceMessage?: VoiceMessage;
}
export type Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30"|string;
export interface EmailChannelRequest {
  /**
   * The configuration set that you want to use when you send email using the Pinpoint Email API.
   */
  ConfigurationSet?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The email address used to send emails from.
   */
  FromAddress?: __string;
  /**
   * The ARN of an identity verified with SES.
   */
  Identity?: __string;
  /**
   * The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
   */
  RoleArn?: __string;
}
export interface EmailChannelResponse {
  /**
   * The unique ID of the application to which the email channel belongs.
   */
  ApplicationId?: __string;
  /**
   * The configuration set that you want to use when you send email using the Pinpoint Email API.
   */
  ConfigurationSet?: __string;
  /**
   * The date that the settings were last updated in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * The email address used to send emails from.
   */
  FromAddress?: __string;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * The ARN of an identity verified with SES.
   */
  Identity?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who last updated this entry
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * Messages per second that can be sent
   */
  MessagesPerSecond?: __integer;
  /**
   * Platform type. Will be "EMAIL"
   */
  Platform?: __string;
  /**
   * The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
   */
  RoleArn?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface EmailMessage {
  /**
   * The body of the email message.
   */
  Body?: __string;
  /**
   * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
   */
  FeedbackForwardingAddress?: __string;
  /**
   * The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
   */
  FromAddress?: __string;
  /**
   * An email represented as a raw MIME message.
   */
  RawEmail?: RawEmail;
  /**
   * The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.
   */
  ReplyToAddresses?: ListOf__string;
  /**
   * An email composed of a subject, a text part and a html part.
   */
  SimpleEmail?: SimpleEmail;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
}
export interface EndpointBatchItem {
  /**
   * The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
   */
  Address?: __string;
  /**
   * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign.
2125
2126The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
   */
  Attributes?: MapOfListOf__string;
  /**
   * The channel type.
2131
2132Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
   */
  ChannelType?: ChannelType;
  /**
   * The endpoint demographic attributes.
   */
  Demographic?: EndpointDemographic;
  /**
   * The last time the endpoint was updated. Provided in ISO 8601 format.
   */
  EffectiveDate?: __string;
  /**
   * Unused.
   */
  EndpointStatus?: __string;
  /**
   * The unique Id for the Endpoint in the batch.
   */
  Id?: __string;
  /**
   * The endpoint location attributes.
   */
  Location?: EndpointLocation;
  /**
   * Custom metrics that your app reports to Amazon Pinpoint.
   */
  Metrics?: MapOf__double;
  /**
   * Indicates whether a user has opted out of receiving messages with one of the following values:
2161
2162ALL - User has opted out of all messages.
2163
2164NONE - Users has not opted out and receives all messages.
   */
  OptOut?: __string;
  /**
   * The unique ID for the most recent request to update the endpoint.
   */
  RequestId?: __string;
  /**
   * Custom user-specific attributes that your app reports to Amazon Pinpoint.
   */
  User?: EndpointUser;
}
export interface EndpointBatchRequest {
  /**
   * List of items to update. Maximum 100 items
   */
  Item?: ListOfEndpointBatchItem;
}
export interface EndpointDemographic {
  /**
   * The version of the application associated with the endpoint.
   */
  AppVersion?: __string;
  /**
   * The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
2189
   */
  Locale?: __string;
  /**
   * The manufacturer of the endpoint device, such as Apple or Samsung.
   */
  Make?: __string;
  /**
   * The model name or number of the endpoint device, such as iPhone.
   */
  Model?: __string;
  /**
   * The model version of the endpoint device.
   */
  ModelVersion?: __string;
  /**
   * The platform of the endpoint device, such as iOS or Android.
   */
  Platform?: __string;
  /**
   * The platform version of the endpoint device.
   */
  PlatformVersion?: __string;
  /**
   * The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
   */
  Timezone?: __string;
}
export interface EndpointItemResponse {
  /**
   * A custom message associated with the registration of an endpoint when issuing a response.
   */
  Message?: __string;
  /**
   * The status code associated with the merging of an endpoint when issuing a response.
   */
  StatusCode?: __integer;
}
export interface EndpointLocation {
  /**
   * The city where the endpoint is located.
   */
  City?: __string;
  /**
   * The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
   */
  Country?: __string;
  /**
   * The latitude of the endpoint location, rounded to one decimal place.
   */
  Latitude?: __double;
  /**
   * The longitude of the endpoint location, rounded to one decimal place.
   */
  Longitude?: __double;
  /**
   * The postal code or zip code of the endpoint.
   */
  PostalCode?: __string;
  /**
   * The region of the endpoint location. For example, in the United States, this corresponds to a state.
   */
  Region?: __string;
}
export interface EndpointMessageResult {
  /**
   * Address that endpoint message was delivered to.
   */
  Address?: __string;
  /**
   * The delivery status of the message. Possible values:
2260
2261SUCCESS - The message was successfully delivered to the endpoint.
2262
2263TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
2264
2265FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
2266
2267TIMEOUT - The message couldn't be sent within the timeout period.
2268
2269QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app.
2270
2271DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period.
2272
2273HOLDOUT - The endpoint was in a hold out treatment for the campaign.
2274
2275THROTTLED - Amazon Pinpoint throttled sending to this endpoint.
2276
2277EXPIRED - The endpoint address is expired.
2278
2279CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign.
2280
2281SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message.
2282
2283UNKNOWN - An unknown error occurred.
   */
  DeliveryStatus?: DeliveryStatus;
  /**
   * Unique message identifier associated with the message that was sent.
   */
  MessageId?: __string;
  /**
   * Downstream service status code.
   */
  StatusCode?: __integer;
  /**
   * Status message for message delivery.
   */
  StatusMessage?: __string;
  /**
   * If token was updated as part of delivery. (This is GCM Specific)
   */
  UpdatedToken?: __string;
}
export interface EndpointRequest {
  /**
   * The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
   */
  Address?: __string;
  /**
   * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign.
2310
2311The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
   */
  Attributes?: MapOfListOf__string;
  /**
   * The channel type.
2316
2317Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
   */
  ChannelType?: ChannelType;
  /**
   * Demographic attributes for the endpoint.
   */
  Demographic?: EndpointDemographic;
  /**
   * The date and time when the endpoint was updated, shown in ISO 8601 format.
   */
  EffectiveDate?: __string;
  /**
   * Unused.
   */
  EndpointStatus?: __string;
  /**
   * The endpoint location attributes.
   */
  Location?: EndpointLocation;
  /**
   * Custom metrics that your app reports to Amazon Pinpoint.
   */
  Metrics?: MapOf__double;
  /**
   * Indicates whether a user has opted out of receiving messages with one of the following values:
2342
2343ALL - User has opted out of all messages.
2344
2345NONE - Users has not opted out and receives all messages.
   */
  OptOut?: __string;
  /**
   * The unique ID for the most recent request to update the endpoint.
   */
  RequestId?: __string;
  /**
   * Custom user-specific attributes that your app reports to Amazon Pinpoint.
   */
  User?: EndpointUser;
}
export interface EndpointResponse {
  /**
   * The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
   */
  Address?: __string;
  /**
   * The ID of the application that is associated with the endpoint.
   */
  ApplicationId?: __string;
  /**
   * Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments.
2368
2369The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
   */
  Attributes?: MapOfListOf__string;
  /**
   * The channel type.
2374
2375Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
   */
  ChannelType?: ChannelType;
  /**
   * A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
   */
  CohortId?: __string;
  /**
   * The date and time when the endpoint was created, shown in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * The endpoint demographic attributes.
   */
  Demographic?: EndpointDemographic;
  /**
   * The date and time when the endpoint was last updated, shown in ISO 8601 format.
   */
  EffectiveDate?: __string;
  /**
   * Unused.
   */
  EndpointStatus?: __string;
  /**
   * The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
   */
  Id?: __string;
  /**
   * The endpoint location attributes.
   */
  Location?: EndpointLocation;
  /**
   * Custom metrics that your app reports to Amazon Pinpoint.
   */
  Metrics?: MapOf__double;
  /**
   * Indicates whether a user has opted out of receiving messages with one of the following values:
2412
2413ALL - User has opted out of all messages.
2414
2415NONE - Users has not opted out and receives all messages.
   */
  OptOut?: __string;
  /**
   * The unique ID for the most recent request to update the endpoint.
   */
  RequestId?: __string;
  /**
   * Custom user-specific attributes that your app reports to Amazon Pinpoint.
   */
  User?: EndpointUser;
}
export interface EndpointSendConfiguration {
  /**
   * Body override. If specified will override default body.
   */
  BodyOverride?: __string;
  /**
   * A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
   */
  Context?: MapOf__string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * Title override. If specified will override default title if applicable.
   */
  TitleOverride?: __string;
}
export interface EndpointUser {
  /**
   * Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments.
2452
2453The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
   */
  UserAttributes?: MapOfListOf__string;
  /**
   * The unique ID of the user.
   */
  UserId?: __string;
}
export interface EndpointsResponse {
  /**
   * The list of endpoints.
   */
  Item?: ListOfEndpointResponse;
}
export interface Event {
  /**
   * The package name associated with the app that's recording the event.
   */
  AppPackageName?: __string;
  /**
   * The title of the app that's recording the event.
   */
  AppTitle?: __string;
  /**
   * The version number of the app that's recording the event.
   */
  AppVersionCode?: __string;
  /**
   * Custom attributes that are associated with the event you're adding or updating.
   */
  Attributes?: MapOf__string;
  /**
   * The version of the SDK that's running on the client device.
   */
  ClientSdkVersion?: __string;
  /**
   * The name of the custom event that you're recording.
   */
  EventType?: __string;
  /**
   * Custom metrics related to the event.
   */
  Metrics?: MapOf__double;
  /**
   * The name of the SDK that's being used to record the event.
   */
  SdkName?: __string;
  /**
   * Information about the session in which the event occurred.
   */
  Session?: Session;
  /**
   * The date and time when the event occurred, in ISO 8601 format.
   */
  Timestamp?: __string;
}
export interface EventDimensions {
  /**
   * Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
   */
  Attributes?: MapOfAttributeDimension;
  /**
   * The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
   */
  EventType?: SetDimension;
  /**
   * Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
   */
  Metrics?: MapOfMetricDimension;
}
export interface EventItemResponse {
  /**
   * A custom message that is associated with the processing of an event.
   */
  Message?: __string;
  /**
   * The status returned in the response as a result of processing the event.
2530
2531Possible values: 400 (for invalid events) and 202 (for events that were accepted).
   */
  StatusCode?: __integer;
}
export interface EventStream {
  /**
   * The ID of the application from which events should be published.
   */
  ApplicationId?: __string;
  /**
   * The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.
Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME
Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
   */
  DestinationStreamArn?: __string;
  /**
   * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
   */
  ExternalId?: __string;
  /**
   * The date the event stream was last updated in ISO 8601 format.
   */
  LastModifiedDate?: __string;
  /**
   * The IAM user who last modified the event stream.
   */
  LastUpdatedBy?: __string;
  /**
   * The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
   */
  RoleArn?: __string;
}
export interface EventsBatch {
  /**
   * The PublicEndpoint attached to the EndpointId from the request.
   */
  Endpoint?: PublicEndpoint;
  /**
   * An object that contains a set of events associated with the endpoint.
   */
  Events?: MapOfEvent;
}
export interface EventsRequest {
  /**
   * A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value.
   */
  BatchItem?: MapOfEventsBatch;
}
export interface EventsResponse {
  /**
   * A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value.
2582
2583If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing).
   */
  Results?: MapOfItemResponse;
}
export interface ExportJobRequest {
  /**
   * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
   */
  RoleArn?: __string;
  /**
   * A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.
2594
2595The URL should follow this format: s3://bucket-name/folder-name/
2596
2597Amazon Pinpoint will export endpoints to this location.
   */
  S3UrlPrefix?: __string;
  /**
   * The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
   */
  SegmentId?: __string;
  /**
   * The version of the segment to export if specified.
   */
  SegmentVersion?: __integer;
}
export interface ExportJobResource {
  /**
   * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
   */
  RoleArn?: __string;
  /**
   * A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.
2616
2617The URL should follow this format: s3://bucket-name/folder-name/
2618
2619Amazon Pinpoint will export endpoints to this location.
   */
  S3UrlPrefix?: __string;
  /**
   * The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
   */
  SegmentId?: __string;
  /**
   * The version of the segment to export if specified.
   */
  SegmentVersion?: __integer;
}
export interface ExportJobResponse {
  /**
   * The unique ID of the application associated with the export job.
   */
  ApplicationId?: __string;
  /**
   * The number of pieces that have successfully completed as of the time of the request.
   */
  CompletedPieces?: __integer;
  /**
   * The date the job completed in ISO 8601 format.
   */
  CompletionDate?: __string;
  /**
   * The date the job was created in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * The export job settings.
   */
  Definition?: ExportJobResource;
  /**
   * The number of pieces that failed to be processed as of the time of the request.
   */
  FailedPieces?: __integer;
  /**
   * Provides up to 100 of the first failed entries for the job, if any exist.
   */
  Failures?: ListOf__string;
  /**
   * The unique ID of the job.
   */
  Id?: __string;
  /**
   * The status of the job.
2666Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED
2667
2668The job status is FAILED if one or more pieces failed.
   */
  JobStatus?: JobStatus;
  /**
   * The number of endpoints that were not processed; for example, because of syntax errors.
   */
  TotalFailures?: __integer;
  /**
   * The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
   */
  TotalPieces?: __integer;
  /**
   * The number of endpoints that were processed by the job.
   */
  TotalProcessed?: __integer;
  /**
   * The job type. Will be 'EXPORT'.
   */
  Type?: __string;
}
export interface ExportJobsResponse {
  /**
   * A list of export jobs for the application.
   */
  Item?: ListOfExportJobResponse;
  /**
   * The string that you use in a subsequent request to get the next page of results in a paginated response.
   */
  NextToken?: __string;
}
export type FilterType = "SYSTEM"|"ENDPOINT"|string;
export type Format = "CSV"|"JSON"|string;
export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string;
export interface GCMChannelRequest {
  /**
   * Platform credential API key from Google.
   */
  ApiKey?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
}
export interface GCMChannelResponse {
  /**
   * The ID of the application to which the channel applies.
   */
  ApplicationId?: __string;
  /**
   * When was this segment created
   */
  CreationDate?: __string;
  /**
   * The GCM API key from Google.
   */
  Credential?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used. Present only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who last updated this entry
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * The platform type. Will be GCM
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface GCMMessage {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
   */
  Action?: Action;
  /**
   * The message body of the notification.
   */
  Body?: __string;
  /**
   * This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
   */
  CollapseKey?: __string;
  /**
   * The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
   */
  Data?: MapOf__string;
  /**
   * The icon image name of the asset saved in your application.
   */
  IconReference?: __string;
  /**
   * The URL that points to an image used as the large icon to the notification content view.
   */
  ImageIconUrl?: __string;
  /**
   * The URL that points to an image used in the push notification.
   */
  ImageUrl?: __string;
  /**
   * The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values:
2788
2789"Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required.
2790
2791"High" - Messages are sent immediately and might wake a sleeping device.
2792
2793The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them.
2794
2795For more information, see About FCM Messages in the Firebase documentation.
   */
  Priority?: __string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
   */
  RestrictedPackageName?: __string;
  /**
   * Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
   */
  SilentPush?: __boolean;
  /**
   * The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
   */
  SmallImageIconUrl?: __string;
  /**
   * Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
   */
  Sound?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
   */
  TimeToLive?: __integer;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface GPSCoordinates {
  /**
   * Latitude
   */
  Latitude?: __double;
  /**
   * Longitude
   */
  Longitude?: __double;
}
export interface GPSPointDimension {
  /**
   * Coordinate to measure distance from.
   */
  Coordinates?: GPSCoordinates;
  /**
   * Range in kilometers from the coordinate.
   */
  RangeInKilometers?: __double;
}
export interface GetAdmChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetAdmChannelResponse {
  ADMChannelResponse: ADMChannelResponse;
}
export interface GetApnsChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetApnsChannelResponse {
  APNSChannelResponse: APNSChannelResponse;
}
export interface GetApnsSandboxChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetApnsSandboxChannelResponse {
  APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface GetApnsVoipChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetApnsVoipChannelResponse {
  APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface GetApnsVoipSandboxChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetApnsVoipSandboxChannelResponse {
  APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface GetAppRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetAppResponse {
  ApplicationResponse: ApplicationResponse;
}
export interface GetApplicationSettingsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetApplicationSettingsResponse {
  ApplicationSettingsResource: ApplicationSettingsResource;
}
export interface GetAppsRequest {
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetAppsResponse {
  ApplicationsResponse: ApplicationsResponse;
}
export interface GetBaiduChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetBaiduChannelResponse {
  BaiduChannelResponse: BaiduChannelResponse;
}
export interface GetCampaignActivitiesRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetCampaignActivitiesResponse {
  ActivitiesResponse: ActivitiesResponse;
}
export interface GetCampaignRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
}
export interface GetCampaignResponse {
  CampaignResponse: CampaignResponse;
}
export interface GetCampaignVersionRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
  /**
   * The version of the campaign.
   */
  Version: __string;
}
export interface GetCampaignVersionResponse {
  CampaignResponse: CampaignResponse;
}
export interface GetCampaignVersionsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetCampaignVersionsResponse {
  CampaignsResponse: CampaignsResponse;
}
export interface GetCampaignsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetCampaignsResponse {
  CampaignsResponse: CampaignsResponse;
}
export interface GetChannelsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetChannelsResponse {
  ChannelsResponse: ChannelsResponse;
}
export interface GetEmailChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetEmailChannelResponse {
  EmailChannelResponse: EmailChannelResponse;
}
export interface GetEndpointRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the endpoint.
   */
  EndpointId: __string;
}
export interface GetEndpointResponse {
  EndpointResponse: EndpointResponse;
}
export interface GetEventStreamRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetEventStreamResponse {
  EventStream: EventStream;
}
export interface GetExportJobRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the job.
   */
  JobId: __string;
}
export interface GetExportJobResponse {
  ExportJobResponse: ExportJobResponse;
}
export interface GetExportJobsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetExportJobsResponse {
  ExportJobsResponse: ExportJobsResponse;
}
export interface GetGcmChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetGcmChannelResponse {
  GCMChannelResponse: GCMChannelResponse;
}
export interface GetImportJobRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the job.
   */
  JobId: __string;
}
export interface GetImportJobResponse {
  ImportJobResponse: ImportJobResponse;
}
export interface GetImportJobsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetImportJobsResponse {
  ImportJobsResponse: ImportJobsResponse;
}
export interface GetSegmentExportJobsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetSegmentExportJobsResponse {
  ExportJobsResponse: ExportJobsResponse;
}
export interface GetSegmentImportJobsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetSegmentImportJobsResponse {
  ImportJobsResponse: ImportJobsResponse;
}
export interface GetSegmentRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
}
export interface GetSegmentResponse {
  SegmentResponse: SegmentResponse;
}
export interface GetSegmentVersionRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
  /**
   * The segment version.
   */
  Version: __string;
}
export interface GetSegmentVersionResponse {
  SegmentResponse: SegmentResponse;
}
export interface GetSegmentVersionsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetSegmentVersionsResponse {
  SegmentsResponse: SegmentsResponse;
}
export interface GetSegmentsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The number of entries you want on each page in the response.
   */
  PageSize?: __string;
  /**
   * The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
   */
  Token?: __string;
}
export interface GetSegmentsResponse {
  SegmentsResponse: SegmentsResponse;
}
export interface GetSmsChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetSmsChannelResponse {
  SMSChannelResponse: SMSChannelResponse;
}
export interface GetUserEndpointsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the user.
   */
  UserId: __string;
}
export interface GetUserEndpointsResponse {
  EndpointsResponse: EndpointsResponse;
}
export interface GetVoiceChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface GetVoiceChannelResponse {
  VoiceChannelResponse: VoiceChannelResponse;
}
export interface ImportJobRequest {
  /**
   * Sets whether the endpoints create a segment when they are imported.
   */
  DefineSegment?: __boolean;
  /**
   * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
   */
  ExternalId?: __string;
  /**
   * The format of the files that contain the endpoint definitions.
3290Valid values: CSV, JSON
   */
  Format?: Format;
  /**
   * Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
   */
  RegisterEndpoints?: __boolean;
  /**
   * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
   */
  RoleArn?: __string;
  /**
   * The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name
3303
3304Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
   */
  S3Url?: __string;
  /**
   * The ID of the segment to update if the import job is meant to update an existing segment.
   */
  SegmentId?: __string;
  /**
   * A custom name for the segment created by the import job. Use if DefineSegment is true.
   */
  SegmentName?: __string;
}
export interface ImportJobResource {
  /**
   * Sets whether the endpoints create a segment when they are imported.
   */
  DefineSegment?: __boolean;
  /**
   * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
   */
  ExternalId?: __string;
  /**
   * The format of the files that contain the endpoint definitions.
3327Valid values: CSV, JSON
   */
  Format?: Format;
  /**
   * Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
   */
  RegisterEndpoints?: __boolean;
  /**
   * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
   */
  RoleArn?: __string;
  /**
   * The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name
3340
3341Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
   */
  S3Url?: __string;
  /**
   * The ID of the segment to update if the import job is meant to update an existing segment.
   */
  SegmentId?: __string;
  /**
   * A custom name for the segment created by the import job. Use if DefineSegment is true.
   */
  SegmentName?: __string;
}
export interface ImportJobResponse {
  /**
   * The unique ID of the application to which the import job applies.
   */
  ApplicationId?: __string;
  /**
   * The number of pieces that have successfully imported as of the time of the request.
   */
  CompletedPieces?: __integer;
  /**
   * The date the import job completed in ISO 8601 format.
   */
  CompletionDate?: __string;
  /**
   * The date the import job was created in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * The import job settings.
   */
  Definition?: ImportJobResource;
  /**
   * The number of pieces that have failed to import as of the time of the request.
   */
  FailedPieces?: __integer;
  /**
   * Provides up to 100 of the first failed entries for the job, if any exist.
   */
  Failures?: ListOf__string;
  /**
   * The unique ID of the import job.
   */
  Id?: __string;
  /**
   * The status of the import job.
3388Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED
3389
3390The job status is FAILED if one or more pieces failed to import.
   */
  JobStatus?: JobStatus;
  /**
   * The number of endpoints that failed to import; for example, because of syntax errors.
   */
  TotalFailures?: __integer;
  /**
   * The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
   */
  TotalPieces?: __integer;
  /**
   * The number of endpoints that were processed by the import job.
   */
  TotalProcessed?: __integer;
  /**
   * The job type. Will be Import.
   */
  Type?: __string;
}
export interface ImportJobsResponse {
  /**
   * A list of import jobs for the application.
   */
  Item?: ListOfImportJobResponse;
  /**
   * The string that you use in a subsequent request to get the next page of results in a paginated response.
   */
  NextToken?: __string;
}
export type Include = "ALL"|"ANY"|"NONE"|string;
export interface ItemResponse {
  /**
   * The response received after the endpoint was accepted.
   */
  EndpointItemResponse?: EndpointItemResponse;
  /**
   * A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value.
   */
  EventsItemResponse?: MapOfEventItemResponse;
}
export type JobStatus = "CREATED"|"INITIALIZING"|"PROCESSING"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED"|string;
export interface ListTagsForResourceRequest {
  ResourceArn: __string;
}
export interface ListTagsForResourceResponse {
  TagsModel: TagsModel;
}
export interface Message {
  /**
   * The action that occurs if the user taps a push notification delivered by the campaign:
3441OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.
3442
3443DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.
3444
3445URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
   */
  Action?: Action;
  /**
   * The message body. Can include up to 140 characters.
   */
  Body?: __string;
  /**
   * The URL that points to the icon image for the push notification icon, for example, the app icon.
   */
  ImageIconUrl?: __string;
  /**
   * The URL that points to the small icon image for the push notification icon, for example, the app icon.
   */
  ImageSmallIconUrl?: __string;
  /**
   * The URL that points to an image used in the push notification.
   */
  ImageUrl?: __string;
  /**
   * The JSON payload used for a silent push.
   */
  JsonBody?: __string;
  /**
   * A URL that refers to the location of an image or video that you want to display in the push notification.
   */
  MediaUrl?: __string;
  /**
   * The Raw JSON formatted string to be used as the payload. This value overrides the message.
   */
  RawContent?: __string;
  /**
   * Indicates if the message should display on the users device.
3478
3479Silent pushes can be used for Remote Configuration and Phone Home use cases. 
   */
  SilentPush?: __boolean;
  /**
   * This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
   */
  TimeToLive?: __integer;
  /**
   * The message title that displays above the message on the user's device.
   */
  Title?: __string;
  /**
   * The URL to open in the user's mobile browser. Used if the value for Action is URL.
   */
  Url?: __string;
}
export interface MessageBody {
  /**
   * The error message that's returned from the API.
   */
  Message?: __string;
  /**
   * The unique message body ID.
   */
  RequestID?: __string;
}
export interface MessageConfiguration {
  /**
   * The message that the campaign delivers to ADM channels. Overrides the default message.
   */
  ADMMessage?: Message;
  /**
   * The message that the campaign delivers to APNS channels. Overrides the default message.
   */
  APNSMessage?: Message;
  /**
   * The message that the campaign delivers to Baidu channels. Overrides the default message.
   */
  BaiduMessage?: Message;
  /**
   * The default message for all channels.
   */
  DefaultMessage?: Message;
  /**
   * The email message configuration.
   */
  EmailMessage?: CampaignEmailMessage;
  /**
   * The message that the campaign delivers to GCM channels. Overrides the default message.
   */
  GCMMessage?: Message;
  /**
   * The SMS message configuration.
   */
  SMSMessage?: CampaignSmsMessage;
}
export interface MessageRequest {
  /**
   * 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.
   */
  Addresses?: MapOfAddressConfiguration;
  /**
   * A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
   */
  Context?: MapOf__string;
  /**
   * A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
   */
  Endpoints?: MapOfEndpointSendConfiguration;
  /**
   * Message configuration.
   */
  MessageConfiguration?: DirectMessageConfiguration;
  /**
   * A unique ID that you can use to trace a message. This ID is visible to recipients.
   */
  TraceId?: __string;
}
export interface MessageResponse {
  /**
   * Application id of the message.
   */
  ApplicationId?: __string;
  /**
   * A map containing a multi part response for each address, with the endpointId as the key and the result as the value.
   */
  EndpointResult?: MapOfEndpointMessageResult;
  /**
   * Original request Id for which this message was delivered.
   */
  RequestId?: __string;
  /**
   * A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
   */
  Result?: MapOfMessageResult;
}
export interface MessageResult {
  /**
   * The delivery status of the message. Possible values:
3578
3579SUCCESS - The message was successfully delivered to the endpoint.
3580
3581TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
3582
3583FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
3584
3585TIMEOUT - The message couldn't be sent within the timeout period.
3586
3587QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app.
3588
3589DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period.
3590
3591HOLDOUT - The endpoint was in a hold out treatment for the campaign.
3592
3593THROTTLED - Amazon Pinpoint throttled sending to this endpoint.
3594
3595EXPIRED - The endpoint address is expired.
3596
3597CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign.
3598
3599SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message.
3600
3601UNKNOWN - An unknown error occurred.
   */
  DeliveryStatus?: DeliveryStatus;
  /**
   * Unique message identifier associated with the message that was sent.
   */
  MessageId?: __string;
  /**
   * Downstream service status code.
   */
  StatusCode?: __integer;
  /**
   * Status message for message delivery.
   */
  StatusMessage?: __string;
  /**
   * If token was updated as part of delivery. (This is GCM Specific)
   */
  UpdatedToken?: __string;
}
export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string;
export interface MetricDimension {
  /**
   * The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
   */
  ComparisonOperator?: __string;
  /**
   * The value to be compared.
   */
  Value?: __double;
}
export type Mode = "DELIVERY"|"FILTER"|string;
export interface NumberValidateRequest {
  /**
   * (Optional) The two-character ISO country code for the country or region where the phone number was originally registered.
   */
  IsoCountryCode?: __string;
  /**
   * The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error.
   */
  PhoneNumber?: __string;
}
export interface NumberValidateResponse {
  /**
   * The carrier or servive provider that the phone number is currently registered with.
   */
  Carrier?: __string;
  /**
   * The city where the phone number was originally registered.
   */
  City?: __string;
  /**
   * The cleansed phone number, shown in E.164 format.
   */
  CleansedPhoneNumberE164?: __string;
  /**
   * The cleansed phone number, shown in the local phone number format.
   */
  CleansedPhoneNumberNational?: __string;
  /**
   * The country or region where the phone number was originally registered.
   */
  Country?: __string;
  /**
   * The two-character ISO code for the country or region where the phone number was originally registered.
   */
  CountryCodeIso2?: __string;
  /**
   * The numeric code for the country or region where the phone number was originally registered.
   */
  CountryCodeNumeric?: __string;
  /**
   * The county where the phone number was originally registered.
   */
  County?: __string;
  /**
   * The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.
   */
  OriginalCountryCodeIso2?: __string;
  /**
   * The phone number that you included in the request body.
   */
  OriginalPhoneNumber?: __string;
  /**
   * A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
   */
  PhoneType?: __string;
  /**
   * The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).
   */
  PhoneTypeCode?: __integer;
  /**
   * The time zone for the location where the phone number was originally registered.
   */
  Timezone?: __string;
  /**
   * The postal code for the location where the phone number was originally registered.
   */
  ZipCode?: __string;
}
export interface PhoneNumberValidateRequest {
  NumberValidateRequest: NumberValidateRequest;
}
export interface PhoneNumberValidateResponse {
  NumberValidateResponse: NumberValidateResponse;
}
export interface PublicEndpoint {
  /**
   * The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
   */
  Address?: __string;
  /**
   * Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
   */
  Attributes?: MapOfListOf__string;
  /**
   * The channel type.
3718
3719Valid values: APNS, GCM
   */
  ChannelType?: ChannelType;
  /**
   * The endpoint demographic attributes.
   */
  Demographic?: EndpointDemographic;
  /**
   * The date and time when the endpoint was last updated, in  ISO 8601 format.
   */
  EffectiveDate?: __string;
  /**
   * The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
   */
  EndpointStatus?: __string;
  /**
   * The endpoint location attributes.
   */
  Location?: EndpointLocation;
  /**
   * Custom metrics that your app reports to Amazon Pinpoint.
   */
  Metrics?: MapOf__double;
  /**
   * Indicates whether a user has opted out of receiving messages with one of the following values:
3744
3745ALL - User has opted out of all messages.
3746
3747NONE - Users has not opted out and receives all messages.
   */
  OptOut?: __string;
  /**
   * A unique identifier that is generated each time the endpoint is updated.
   */
  RequestId?: __string;
  /**
   * Custom user-specific attributes that your app reports to Amazon Pinpoint.
   */
  User?: EndpointUser;
}
export interface PutEventStreamRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  WriteEventStream: WriteEventStream;
}
export interface PutEventStreamResponse {
  EventStream: EventStream;
}
export interface PutEventsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  EventsRequest: EventsRequest;
}
export interface PutEventsResponse {
  EventsResponse: EventsResponse;
}
export interface QuietTime {
  /**
   * The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (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.
   */
  End?: __string;
  /**
   * The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (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.
   */
  Start?: __string;
}
export interface RawEmail {
  /**
   * The raw email message itself. Then entire message must be base64-encoded.
   */
  Data?: __blob;
}
export type __blob = Buffer|Uint8Array|Blob|string;
export interface RecencyDimension {
  /**
   * The length of time during which users have been active or inactive with your app.
3799
3800Valid values: HR_24, DAY_7, DAY_14, DAY_30
   */
  Duration?: Duration;
  /**
   * The recency dimension type:
3805
3806ACTIVE - Users who have used your app within the specified duration are included in the segment.
3807
3808INACTIVE - Users who have not used your app within the specified duration are included in the segment.
   */
  RecencyType?: RecencyType;
}
export type RecencyType = "ACTIVE"|"INACTIVE"|string;
export interface RemoveAttributesRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes.
   */
  AttributeType: __string;
  UpdateAttributesRequest: UpdateAttributesRequest;
}
export interface RemoveAttributesResponse {
  AttributesResource: AttributesResource;
}
export interface SMSChannelRequest {
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Sender identifier of your messages.
   */
  SenderId?: __string;
  /**
   * ShortCode registered with phone provider.
   */
  ShortCode?: __string;
}
export interface SMSChannelResponse {
  /**
   * The unique ID of the application to which the SMS channel belongs.
   */
  ApplicationId?: __string;
  /**
   * The date that the settings were last updated in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  /**
   * Not used. Retained for backwards compatibility.
   */
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who last updated this entry
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * Platform type. Will be "SMS"
   */
  Platform?: __string;
  /**
   * Promotional messages per second that can be sent
   */
  PromotionalMessagesPerSecond?: __integer;
  /**
   * Sender identifier of your messages.
   */
  SenderId?: __string;
  /**
   * The short code registered with the phone provider.
   */
  ShortCode?: __string;
  /**
   * Transactional messages per second that can be sent
   */
  TransactionalMessagesPerSecond?: __integer;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface SMSMessage {
  /**
   * The body of the SMS message.
   */
  Body?: __string;
  /**
   * The SMS program name that you provided to AWS Support when you requested your dedicated number.
   */
  Keyword?: __string;
  /**
   * Is this a transaction priority message or lower priority.
   */
  MessageType?: MessageType;
  /**
   * The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
   */
  OriginationNumber?: __string;
  /**
   * The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
   */
  SenderId?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
}
export interface Schedule {
  /**
   * The scheduled time that the campaign ends in ISO 8601 format.
   */
  EndTime?: __string;
  /**
   * Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
   */
  EventFilter?: CampaignEventFilter;
  /**
   * How often the campaign delivers messages.
3936
3937Valid values:
3938
3939ONCE
3940
3941HOURLY
3942
3943DAILY
3944
3945WEEKLY
3946
3947MONTHLY
3948
3949EVENT
   */
  Frequency?: Frequency;
  /**
   * Indicates whether the campaign schedule takes effect according to each user's local time.
   */
  IsLocalTime?: __boolean;
  /**
   * The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time.
3958
3959Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled.
3960
3961When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true:
3962- The endpoint includes a valid Demographic.Timezone attribute.
3963- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign.
3964- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
   */
  QuietTime?: QuietTime;
  /**
   * The scheduled time that the campaign begins in ISO 8601 format.
   */
  StartTime?: __string;
  /**
   * The starting UTC offset for the schedule if the value for isLocalTime is true
3973
3974Valid values: 
3975UTC
3976UTC+01
3977UTC+02
3978UTC+03
3979UTC+03:30
3980UTC+04
3981UTC+04:30
3982UTC+05
3983UTC+05:30
3984UTC+05:45
3985UTC+06
3986UTC+06:30
3987UTC+07
3988UTC+08
3989UTC+09
3990UTC+09:30
3991UTC+10
3992UTC+10:30
3993UTC+11
3994UTC+12
3995UTC+13
3996UTC-02
3997UTC-03
3998UTC-04
3999UTC-05
4000UTC-06
4001UTC-07
4002UTC-08
4003UTC-09
4004UTC-10
4005UTC-11
   */
  Timezone?: __string;
}
export interface SegmentBehaviors {
  /**
   * The recency of use.
   */
  Recency?: RecencyDimension;
}
export interface SegmentDemographics {
  /**
   * The app version criteria for the segment.
   */
  AppVersion?: SetDimension;
  /**
   * The channel criteria for the segment.
   */
  Channel?: SetDimension;
  /**
   * The device type criteria for the segment.
   */
  DeviceType?: SetDimension;
  /**
   * The device make criteria for the segment.
   */
  Make?: SetDimension;
  /**
   * The device model criteria for the segment.
   */
  Model?: SetDimension;
  /**
   * The device platform criteria for the segment.
   */
  Platform?: SetDimension;
}
export interface SegmentDimensions {
  /**
   * Custom segment attributes.
   */
  Attributes?: MapOfAttributeDimension;
  /**
   * The segment behaviors attributes.
   */
  Behavior?: SegmentBehaviors;
  /**
   * The segment demographics attributes.
   */
  Demographic?: SegmentDemographics;
  /**
   * The segment location attributes.
   */
  Location?: SegmentLocation;
  /**
   * Custom segment metrics.
   */
  Metrics?: MapOfMetricDimension;
  /**
   * Custom segment user attributes.
   */
  UserAttributes?: MapOfAttributeDimension;
}
export interface SegmentGroup {
  /**
   * List of dimensions to include or exclude.
   */
  Dimensions?: ListOfSegmentDimensions;
  /**
   * The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment.
4074
4075NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
   */
  SourceSegments?: ListOfSegmentReference;
  /**
   * Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
   */
  SourceType?: SourceType;
  /**
   * Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
   */
  Type?: Type;
}
export interface SegmentGroupList {
  /**
   * A set of segment criteria to evaluate.
   */
  Groups?: ListOfSegmentGroup;
  /**
   * Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
   */
  Include?: Include;
}
export interface SegmentImportResource {
  /**
   * The number of channel types in the imported segment.
   */
  ChannelCounts?: MapOf__integer;
  /**
   * (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
   */
  ExternalId?: __string;
  /**
   * The format of the endpoint files that were imported to create this segment.
4108Valid values: CSV, JSON
   */
  Format?: Format;
  /**
   * The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
   */
  RoleArn?: __string;
  /**
   * The URL of the S3 bucket that the segment was imported from.
   */
  S3Url?: __string;
  /**
   * The number of endpoints that were successfully imported to create this segment.
   */
  Size?: __integer;
}
export interface SegmentLocation {
  /**
   * The country or region, in ISO 3166-1 alpha-2 format.
   */
  Country?: SetDimension;
  /**
   * The GPS Point dimension.
   */
  GPSPoint?: GPSPointDimension;
}
export interface SegmentReference {
  /**
   * A unique identifier for the segment.
   */
  Id?: __string;
  /**
   * If specified contains a specific version of the segment included.
   */
  Version?: __integer;
}
export interface SegmentResponse {
  /**
   * The ID of the application that the segment applies to.
   */
  ApplicationId?: __string;
  /**
   * The arn for the segment.
   */
  Arn?: __string;
  /**
   * The date and time when the segment was created.
   */
  CreationDate?: __string;
  /**
   * The segment dimensions attributes.
   */
  Dimensions?: SegmentDimensions;
  /**
   * The unique segment ID.
   */
  Id?: __string;
  /**
   * The import job settings.
   */
  ImportDefinition?: SegmentImportResource;
  /**
   * The date and time when the segment was last modified.
   */
  LastModifiedDate?: __string;
  /**
   * The name of the segment.
   */
  Name?: __string;
  /**
   * A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
   */
  SegmentGroups?: SegmentGroupList;
  /**
   * The segment type:
4183DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource.
4184IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
   */
  SegmentType?: SegmentType;
  /**
   * The Tags for the segment.
   */
  tags?: MapOf__string;
  /**
   * The segment version number.
   */
  Version?: __integer;
}
export type SegmentType = "DIMENSIONAL"|"IMPORT"|string;
export interface SegmentsResponse {
  /**
   * The list of segments.
   */
  Item?: ListOfSegmentResponse;
  /**
   * An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
   */
  NextToken?: __string;
}
export interface SendMessagesRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  MessageRequest: MessageRequest;
}
export interface SendMessagesResponse {
  MessageResponse: MessageResponse;
}
export interface SendUsersMessageRequest {
  /**
   * A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
   */
  Context?: MapOf__string;
  /**
   * Message definitions for the default message and any messages that are tailored for specific channels.
   */
  MessageConfiguration?: DirectMessageConfiguration;
  /**
   * A unique ID that you can use to trace a message. This ID is visible to recipients.
   */
  TraceId?: __string;
  /**
   * A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.
   */
  Users?: MapOfEndpointSendConfiguration;
}
export interface SendUsersMessageResponse {
  /**
   * The unique ID of the Amazon Pinpoint project used to send the message.
   */
  ApplicationId?: __string;
  /**
   * The unique ID assigned to the users-messages request.
   */
  RequestId?: __string;
  /**
   * An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.
   */
  Result?: MapOfMapOfEndpointMessageResult;
}
export interface SendUsersMessagesRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  SendUsersMessageRequest: SendUsersMessageRequest;
}
export interface SendUsersMessagesResponse {
  SendUsersMessageResponse: SendUsersMessageResponse;
}
export interface Session {
  /**
   * The duration of the session, in milliseconds.
   */
  Duration?: __integer;
  /**
   * A unique identifier for the session.
   */
  Id?: __string;
  /**
   * The date and time when the session began.
   */
  StartTimestamp?: __string;
  /**
   * The date and time when the session ended.
   */
  StopTimestamp?: __string;
}
export interface SetDimension {
  /**
   * The type of dimension:
4280
4281INCLUSIVE - Endpoints that match the criteria are included in the segment.
4282
4283EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
   */
  DimensionType?: DimensionType;
  /**
   * The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
   */
  Values?: ListOf__string;
}
export interface SimpleEmail {
  /**
   * The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
   */
  HtmlPart?: SimpleEmailPart;
  /**
   * The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
   */
  Subject?: SimpleEmailPart;
  /**
   * The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
   */
  TextPart?: SimpleEmailPart;
}
export interface SimpleEmailPart {
  /**
   * The character set of the content.
   */
  Charset?: __string;
  /**
   * The textual data of the content.
   */
  Data?: __string;
}
export type SourceType = "ALL"|"ANY"|"NONE"|string;
export interface TagResourceRequest {
  ResourceArn: __string;
  TagsModel: TagsModel;
}
export interface TagsModel {
  tags: MapOf__string;
}
export interface TreatmentResource {
  /**
   * The unique treatment ID.
   */
  Id?: __string;
  /**
   * The message configuration settings.
   */
  MessageConfiguration?: MessageConfiguration;
  /**
   * The campaign schedule.
   */
  Schedule?: Schedule;
  /**
   * The allocated percentage of users for this treatment.
   */
  SizePercent?: __integer;
  /**
   * The treatment status.
   */
  State?: CampaignState;
  /**
   * A custom description for the treatment.
   */
  TreatmentDescription?: __string;
  /**
   * The custom name of a variation of the campaign used for A/B testing.
   */
  TreatmentName?: __string;
}
export type Type = "ALL"|"ANY"|"NONE"|string;
export interface UntagResourceRequest {
  ResourceArn: __string;
  /**
   * The key(s) of tag to be deleted
   */
  TagKeys: ListOf__string;
}
export interface UpdateAdmChannelRequest {
  ADMChannelRequest: ADMChannelRequest;
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface UpdateAdmChannelResponse {
  ADMChannelResponse: ADMChannelResponse;
}
export interface UpdateApnsChannelRequest {
  APNSChannelRequest: APNSChannelRequest;
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface UpdateApnsChannelResponse {
  APNSChannelResponse: APNSChannelResponse;
}
export interface UpdateApnsSandboxChannelRequest {
  APNSSandboxChannelRequest: APNSSandboxChannelRequest;
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface UpdateApnsSandboxChannelResponse {
  APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface UpdateApnsVoipChannelRequest {
  APNSVoipChannelRequest: APNSVoipChannelRequest;
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface UpdateApnsVoipChannelResponse {
  APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface UpdateApnsVoipSandboxChannelRequest {
  APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest;
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
}
export interface UpdateApnsVoipSandboxChannelResponse {
  APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface UpdateApplicationSettingsRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  WriteApplicationSettingsRequest: WriteApplicationSettingsRequest;
}
export interface UpdateApplicationSettingsResponse {
  ApplicationSettingsResource: ApplicationSettingsResource;
}
export interface UpdateAttributesRequest {
  /**
   * The GLOB wildcard for removing the attributes in the application
   */
  Blacklist?: ListOf__string;
}
export interface UpdateBaiduChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  BaiduChannelRequest: BaiduChannelRequest;
}
export interface UpdateBaiduChannelResponse {
  BaiduChannelResponse: BaiduChannelResponse;
}
export interface UpdateCampaignRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the campaign.
   */
  CampaignId: __string;
  WriteCampaignRequest: WriteCampaignRequest;
}
export interface UpdateCampaignResponse {
  CampaignResponse: CampaignResponse;
}
export interface UpdateEmailChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  EmailChannelRequest: EmailChannelRequest;
}
export interface UpdateEmailChannelResponse {
  EmailChannelResponse: EmailChannelResponse;
}
export interface UpdateEndpointRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the endpoint.
   */
  EndpointId: __string;
  EndpointRequest: EndpointRequest;
}
export interface UpdateEndpointResponse {
  MessageBody: MessageBody;
}
export interface UpdateEndpointsBatchRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  EndpointBatchRequest: EndpointBatchRequest;
}
export interface UpdateEndpointsBatchResponse {
  MessageBody: MessageBody;
}
export interface UpdateGcmChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  GCMChannelRequest: GCMChannelRequest;
}
export interface UpdateGcmChannelResponse {
  GCMChannelResponse: GCMChannelResponse;
}
export interface UpdateSegmentRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  /**
   * The unique ID of the segment.
   */
  SegmentId: __string;
  WriteSegmentRequest: WriteSegmentRequest;
}
export interface UpdateSegmentResponse {
  SegmentResponse: SegmentResponse;
}
export interface UpdateSmsChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  SMSChannelRequest: SMSChannelRequest;
}
export interface UpdateSmsChannelResponse {
  SMSChannelResponse: SMSChannelResponse;
}
export interface UpdateVoiceChannelRequest {
  /**
   * The unique ID of your Amazon Pinpoint application.
   */
  ApplicationId: __string;
  VoiceChannelRequest: VoiceChannelRequest;
}
export interface UpdateVoiceChannelResponse {
  VoiceChannelResponse: VoiceChannelResponse;
}
export interface VoiceChannelRequest {
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
}
export interface VoiceChannelResponse {
  /**
   * Application id
   */
  ApplicationId?: __string;
  /**
   * The date that the settings were last updated in ISO 8601 format.
   */
  CreationDate?: __string;
  /**
   * If the channel is enabled for sending messages.
   */
  Enabled?: __boolean;
  HasCredential?: __boolean;
  /**
   * Channel ID. Not used, only for backwards compatibility.
   */
  Id?: __string;
  /**
   * Is this channel archived
   */
  IsArchived?: __boolean;
  /**
   * Who made the last change
   */
  LastModifiedBy?: __string;
  /**
   * Last date this was updated
   */
  LastModifiedDate?: __string;
  /**
   * Platform type. Will be "Voice"
   */
  Platform?: __string;
  /**
   * Version of channel
   */
  Version?: __integer;
}
export interface VoiceMessage {
  /**
   * The message body of the notification, the email body or the text message.
   */
  Body?: __string;
  /**
   * Language of sent message
   */
  LanguageCode?: __string;
  /**
   * Is the number from the pool or messaging service to send from.
   */
  OriginationNumber?: __string;
  /**
   * Default message substitutions. Can be overridden by individual address substitutions.
   */
  Substitutions?: MapOfListOf__string;
  /**
   * Voice ID of sent message.
   */
  VoiceId?: __string;
}
export interface WriteApplicationSettingsRequest {
  /**
   * Default campaign hook information.
   */
  CampaignHook?: CampaignHook;
  /**
   * The CloudWatchMetrics settings for the app.
   */
  CloudWatchMetricsEnabled?: __boolean;
  /**
   * The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.
   */
  Limits?: CampaignLimits;
  /**
   * The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time.
4611
4612Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled.
4613
4614When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true:
4615- The endpoint includes a valid Demographic.Timezone attribute.
4616- The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable).
4617- The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable).
4618
4619Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
   */
  QuietTime?: QuietTime;
}
export interface WriteCampaignRequest {
  /**
   * Treatments that are defined in addition to the default treatment.
   */
  AdditionalTreatments?: ListOfWriteTreatmentResource;
  /**
   * A description of the campaign.
   */
  Description?: __string;
  /**
   * The allocated percentage of end users who will not receive messages from this campaign.
   */
  HoldoutPercent?: __integer;
  /**
   * Campaign hook information.
   */
  Hook?: CampaignHook;
  /**
   * Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
   */
  IsPaused?: __boolean;
  /**
   * The campaign limits settings.
   */
  Limits?: CampaignLimits;
  /**
   * The message configuration settings.
   */
  MessageConfiguration?: MessageConfiguration;
  /**
   * The custom name of the campaign.
   */
  Name?: __string;
  /**
   * The campaign schedule.
   */
  Schedule?: Schedule;
  /**
   * The ID of the segment to which the campaign sends messages.
   */
  SegmentId?: __string;
  /**
   * The version of the segment to which the campaign sends messages.
   */
  SegmentVersion?: __integer;
  /**
   * The Tags for the campaign.
   */
  tags?: MapOf__string;
  /**
   * A custom description for the treatment.
   */
  TreatmentDescription?: __string;
  /**
   * The custom name of a variation of the campaign used for A/B testing.
   */
  TreatmentName?: __string;
}
export interface WriteEventStream {
  /**
   * The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.
Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME
Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
   */
  DestinationStreamArn?: __string;
  /**
   * The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
   */
  RoleArn?: __string;
}
export interface WriteSegmentRequest {
  /**
   * The segment dimensions attributes.
   */
  Dimensions?: SegmentDimensions;
  /**
   * The name of segment
   */
  Name?: __string;
  /**
   * A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
   */
  SegmentGroups?: SegmentGroupList;
  /**
   * The Tags for the segments.
   */
  tags?: MapOf__string;
}
export interface WriteTreatmentResource {
  /**
   * The message configuration settings.
   */
  MessageConfiguration?: MessageConfiguration;
  /**
   * The campaign schedule.
   */
  Schedule?: Schedule;
  /**
   * The allocated percentage of users for this treatment.
   */
  SizePercent?: __integer;
  /**
   * A custom description for the treatment.
   */
  TreatmentDescription?: __string;
  /**
   * The custom name of a variation of the campaign used for A/B testing.
   */
  TreatmentName?: __string;
}
export type __boolean = boolean;
export type __double = number;
export type __integer = number;
export type ListOfActivityResponse = ActivityResponse[];
export type ListOfApplicationResponse = ApplicationResponse[];
export type ListOfCampaignResponse = CampaignResponse[];
export type ListOfEndpointBatchItem = EndpointBatchItem[];
export type ListOfEndpointResponse = EndpointResponse[];
export type ListOfExportJobResponse = ExportJobResponse[];
export type ListOfImportJobResponse = ImportJobResponse[];
export type ListOfSegmentDimensions = SegmentDimensions[];
export type ListOfSegmentGroup = SegmentGroup[];
export type ListOfSegmentReference = SegmentReference[];
export type ListOfSegmentResponse = SegmentResponse[];
export type ListOfTreatmentResource = TreatmentResource[];
export type ListOfWriteTreatmentResource = WriteTreatmentResource[];
export type ListOf__string = __string[];
export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration};
export type MapOfAttributeDimension = {[key: string]: AttributeDimension};
export type MapOfChannelResponse = {[key: string]: ChannelResponse};
export type MapOfEndpointMessageResult = {[key: string]: EndpointMessageResult};
export type MapOfEndpointSendConfiguration = {[key: string]: EndpointSendConfiguration};
export type MapOfEvent = {[key: string]: Event};
export type MapOfEventItemResponse = {[key: string]: EventItemResponse};
export type MapOfEventsBatch = {[key: string]: EventsBatch};
export type MapOfItemResponse = {[key: string]: ItemResponse};
export type MapOfMessageResult = {[key: string]: MessageResult};
export type MapOfMetricDimension = {[key: string]: MetricDimension};
export type MapOf__double = {[key: string]: __double};
export type MapOf__integer = {[key: string]: __integer};
export type MapOfListOf__string = {[key: string]: ListOf__string};
export type MapOfMapOfEndpointMessageResult = {[key: string]: MapOfEndpointMessageResult};
export type MapOf__string = {[key: string]: __string};
export type __string = string;
/**
 * 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.
 */
export type apiVersion = "2016-12-01"|"latest"|string;
export interface ClientApiVersions {
  /**
   * 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.
   */
  apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
 * Contains interfaces for use with the Pinpoint client.
 */
export import Types = Pinpoint;
4782}
4783export = Pinpoint;