Doc Engage API - Amazon Pinpoint API
service : AWS.Config.Region -> AWS.Service.Service
Configuration for this service.
createApp : CreateAppRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateAppResponse
Creates an application.
createCampaign : CreateCampaignRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateCampaignResponse
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
createExportJob : CreateExportJobRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateExportJobResponse
Creates a new export job for an application.
createImportJob : CreateImportJobRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateImportJobResponse
Creates a new import job for an application.
createSegment : CreateSegmentRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateSegmentResponse
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
deleteAdmChannel : DeleteAdmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteAdmChannelResponse
Disables the ADM channel for an application and deletes any existing settings for the channel.
deleteApnsChannel : DeleteApnsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteApnsChannelResponse
Disables the APNs channel for an application and deletes any existing settings for the channel.
deleteApnsSandboxChannel : DeleteApnsSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteApnsSandboxChannelResponse
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
deleteApnsVoipChannel : DeleteApnsVoipChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteApnsVoipChannelResponse
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
deleteApnsVoipSandboxChannel : DeleteApnsVoipSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteApnsVoipSandboxChannelResponse
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
deleteApp : DeleteAppRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteAppResponse
Deletes an application.
deleteBaiduChannel : DeleteBaiduChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteBaiduChannelResponse
Disables the Baidu channel for an application and deletes any existing settings for the channel.
deleteCampaign : DeleteCampaignRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteCampaignResponse
Deletes a campaign from an application.
deleteEmailChannel : DeleteEmailChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteEmailChannelResponse
Disables the email channel for an application and deletes any existing settings for the channel.
deleteEndpoint : DeleteEndpointRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteEndpointResponse
Deletes an endpoint from an application.
deleteEventStream : DeleteEventStreamRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteEventStreamResponse
Deletes the event stream for an application.
deleteGcmChannel : DeleteGcmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteGcmChannelResponse
Disables the GCM channel for an application and deletes any existing settings for the channel.
deleteSegment : DeleteSegmentRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteSegmentResponse
Deletes a segment from an application.
deleteSmsChannel : DeleteSmsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteSmsChannelResponse
Disables the SMS channel for an application and deletes any existing settings for the channel.
deleteUserEndpoints : DeleteUserEndpointsRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteUserEndpointsResponse
Deletes all the endpoints that are associated with a specific user ID.
deleteVoiceChannel : DeleteVoiceChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteVoiceChannelResponse
Disables the voice channel for an application and deletes any existing settings for the channel.
getAdmChannel : GetAdmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetAdmChannelResponse
Retrieves information about the status and settings of the ADM channel for an application.
getApnsChannel : GetApnsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApnsChannelResponse
Retrieves information about the status and settings of the APNs channel for an application.
getApnsSandboxChannel : GetApnsSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApnsSandboxChannelResponse
Retrieves information about the status and settings of the APNs sandbox channel for an application.
getApnsVoipChannel : GetApnsVoipChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApnsVoipChannelResponse
Retrieves information about the status and settings of the APNs VoIP channel for an application.
getApnsVoipSandboxChannel : GetApnsVoipSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApnsVoipSandboxChannelResponse
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
getApp : GetAppRequest -> AWS.Http.Request AWS.Http.AWSAppError GetAppResponse
Retrieves information about an application.
getApplicationDateRangeKpi : GetApplicationDateRangeKpiRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApplicationDateRangeKpiResponse
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
getApplicationSettings : GetApplicationSettingsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetApplicationSettingsResponse
Retrieves information about the settings for an application.
getApps : GetAppsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetAppsResponse
Retrieves information about all of your applications.
getBaiduChannel : GetBaiduChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetBaiduChannelResponse
Retrieves information about the status and settings of the Baidu Cloud Push channel for an application.
getCampaign : GetCampaignRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignResponse
Retrieves information about the status, configuration, and other settings for a campaign.
getCampaignActivities : GetCampaignActivitiesRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignActivitiesResponse
Retrieves information about the activity performed by a campaign.
getCampaignDateRangeKpi : GetCampaignDateRangeKpiRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignDateRangeKpiResponse
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
getCampaignVersion : GetCampaignVersionRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignVersionResponse
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
getCampaignVersions : GetCampaignVersionsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignVersionsResponse
Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.
getCampaigns : GetCampaignsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetCampaignsResponse
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
getChannels : GetChannelsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetChannelsResponse
Retrieves information about the history and status of each channel for an application.
getEmailChannel : GetEmailChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetEmailChannelResponse
Retrieves information about the status and settings of the email channel for an application.
getEndpoint : GetEndpointRequest -> AWS.Http.Request AWS.Http.AWSAppError GetEndpointResponse
Retrieves information about the settings and attributes of a specific endpoint for an application.
getEventStream : GetEventStreamRequest -> AWS.Http.Request AWS.Http.AWSAppError GetEventStreamResponse
Retrieves information about the event stream settings for an application.
getExportJob : GetExportJobRequest -> AWS.Http.Request AWS.Http.AWSAppError GetExportJobResponse
Retrieves information about the status and settings of a specific export job for an application.
getExportJobs : GetExportJobsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetExportJobsResponse
Retrieves information about the status and settings of all the export jobs for an application.
getGcmChannel : GetGcmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetGcmChannelResponse
Retrieves information about the status and settings of the GCM channel for an application.
getImportJob : GetImportJobRequest -> AWS.Http.Request AWS.Http.AWSAppError GetImportJobResponse
Retrieves information about the status and settings of a specific import job for an application.
getImportJobs : GetImportJobsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetImportJobsResponse
Retrieves information about the status and settings of all the import jobs for an application.
getSegment : GetSegmentRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentResponse
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
getSegmentExportJobs : GetSegmentExportJobsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentExportJobsResponse
Retrieves information about the status and settings of the export jobs for a segment.
getSegmentImportJobs : GetSegmentImportJobsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentImportJobsResponse
Retrieves information about the status and settings of the import jobs for a segment.
getSegmentVersion : GetSegmentVersionRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentVersionResponse
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
getSegmentVersions : GetSegmentVersionsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentVersionsResponse
Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.
getSegments : GetSegmentsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSegmentsResponse
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
getSmsChannel : GetSmsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetSmsChannelResponse
Retrieves information about the status and settings of the SMS channel for an application.
getUserEndpoints : GetUserEndpointsRequest -> AWS.Http.Request AWS.Http.AWSAppError GetUserEndpointsResponse
Retrieves information about all the endpoints that are associated with a specific user ID.
getVoiceChannel : GetVoiceChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError GetVoiceChannelResponse
Retrieves information about the status and settings of the voice channel for an application.
listTagsForResource : ListTagsForResourceRequest -> AWS.Http.Request Basics.Never ListTagsForResourceResponse
Retrieves all the tags (keys and values) that are associated with an application, campaign, or segment.
phoneNumberValidate : PhoneNumberValidateRequest -> AWS.Http.Request AWS.Http.AWSAppError PhoneNumberValidateResponse
Retrieves information about a phone number.
putEventStream : PutEventStreamRequest -> AWS.Http.Request AWS.Http.AWSAppError PutEventStreamResponse
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
putEvents : PutEventsRequest -> AWS.Http.Request AWS.Http.AWSAppError PutEventsResponse
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
removeAttributes : RemoveAttributesRequest -> AWS.Http.Request AWS.Http.AWSAppError RemoveAttributesResponse
Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
sendMessages : SendMessagesRequest -> AWS.Http.Request AWS.Http.AWSAppError SendMessagesResponse
Creates and sends a direct message.
sendUsersMessages : SendUsersMessagesRequest -> AWS.Http.Request AWS.Http.AWSAppError SendUsersMessagesResponse
Creates and sends a message to a list of users.
tagResource : TagResourceRequest -> AWS.Http.Request Basics.Never ()
Adds one or more tags (keys and values) to an application, campaign, or segment.
untagResource : UntagResourceRequest -> AWS.Http.Request Basics.Never ()
Removes one or more tags (keys and values) from an application, campaign, or segment.
updateAdmChannel : UpdateAdmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateAdmChannelResponse
Updates the ADM channel settings for an application.
updateApnsChannel : UpdateApnsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateApnsChannelResponse
Updates the APNs channel settings for an application.
updateApnsSandboxChannel : UpdateApnsSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateApnsSandboxChannelResponse
Updates the APNs sandbox channel settings for an application.
updateApnsVoipChannel : UpdateApnsVoipChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateApnsVoipChannelResponse
Updates the APNs VoIP channel settings for an application.
updateApnsVoipSandboxChannel : UpdateApnsVoipSandboxChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateApnsVoipSandboxChannelResponse
Updates the settings for the APNs VoIP sandbox channel for an application.
updateApplicationSettings : UpdateApplicationSettingsRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateApplicationSettingsResponse
Updates the settings for an application.
updateBaiduChannel : UpdateBaiduChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateBaiduChannelResponse
Updates the settings of the Baidu channel for an application.
updateCampaign : UpdateCampaignRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateCampaignResponse
Updates the settings for a campaign.
updateEmailChannel : UpdateEmailChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateEmailChannelResponse
Updates the status and settings of the email channel for an application.
updateEndpoint : UpdateEndpointRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateEndpointResponse
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.
updateEndpointsBatch : UpdateEndpointsBatchRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateEndpointsBatchResponse
Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
updateGcmChannel : UpdateGcmChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateGcmChannelResponse
Updates the status and settings of the GCM channel for an application.
updateSegment : UpdateSegmentRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateSegmentResponse
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
updateSmsChannel : UpdateSmsChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateSmsChannelResponse
Updates the status and settings of the SMS channel for an application.
updateVoiceChannel : UpdateVoiceChannelRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateVoiceChannelResponse
Updates the status and settings of the voice channel for an application.
The Action data model.
{ item : ListOfActivityResponse
, nextToken : Maybe String
}
The ActivitiesResponse data model.
{ applicationId : String
, campaignId : String
, end : Maybe String
, id : String
, result : Maybe String
, scheduledStart : Maybe String
, start : Maybe String
, state : Maybe String
, successfulEndpointCount : Maybe Basics.Int
, timezonesCompletedCount : Maybe Basics.Int
, timezonesTotalCount : Maybe Basics.Int
, totalEndpointCount : Maybe Basics.Int
, treatmentId : Maybe String
}
The ActivityResponse data model.
{ bodyOverride : Maybe String
, channelType : Maybe ChannelType
, context : Maybe MapOfString
, rawContent : Maybe String
, substitutions : Maybe MapOfListOfString
, titleOverride : Maybe String
}
The AddressConfiguration data model.
{ clientId : String
, clientSecret : String
, enabled : Maybe Basics.Bool
}
The AdmchannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The AdmchannelResponse data model.
{ action : Maybe Action
, body : Maybe String
, consolidationKey : Maybe String
, data : Maybe MapOfString
, expiresAfter : Maybe String
, iconReference : Maybe String
, imageIconUrl : Maybe String
, imageUrl : Maybe String
, md5 : Maybe String
, rawContent : Maybe String
, silentPush : Maybe Basics.Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, title : Maybe String
, url : Maybe String
}
The Admmessage data model.
{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, privateKey : Maybe String
, teamId : Maybe String
, tokenKey : Maybe String
, tokenKeyId : Maybe String
}
The ApnschannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, hasTokenKey : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The ApnschannelResponse data model.
{ action : Maybe Action
, badge : Maybe Basics.Int
, body : Maybe String
, category : Maybe String
, collapseId : Maybe String
, data : Maybe MapOfString
, mediaUrl : Maybe String
, preferredAuthenticationMethod : Maybe String
, priority : Maybe String
, rawContent : Maybe String
, silentPush : Maybe Basics.Bool
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, threadId : Maybe String
, timeToLive : Maybe Basics.Int
, title : Maybe String
, url : Maybe String
}
The Apnsmessage data model.
{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, privateKey : Maybe String
, teamId : Maybe String
, tokenKey : Maybe String
, tokenKeyId : Maybe String
}
The ApnssandboxChannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, hasTokenKey : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The ApnssandboxChannelResponse data model.
{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, privateKey : Maybe String
, teamId : Maybe String
, tokenKey : Maybe String
, tokenKeyId : Maybe String
}
The ApnsvoipChannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, hasTokenKey : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The ApnsvoipChannelResponse data model.
{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, privateKey : Maybe String
, teamId : Maybe String
, tokenKey : Maybe String
, tokenKeyId : Maybe String
}
The ApnsvoipSandboxChannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, hasTokenKey : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The ApnsvoipSandboxChannelResponse data model.
{ applicationId : String
, endTime : String
, kpiName : String
, kpiResult : BaseKpiResult
, nextToken : Maybe String
, startTime : String
}
The ApplicationDateRangeKpiResponse data model.
{ arn : String
, id : String
, name : String
, tags : Maybe MapOfString
}
The ApplicationResponse data model.
{ applicationId : String
, campaignHook : Maybe CampaignHook
, lastModifiedDate : Maybe String
, limits : Maybe CampaignLimits
, quietTime : Maybe QuietTime
}
The ApplicationSettingsResource data model.
{ item : Maybe ListOfApplicationResponse
, nextToken : Maybe String
}
The ApplicationsResponse data model.
{ attributeType : Maybe AttributeType
, values : ListOfString
}
The AttributeDimension data model.
The AttributeType data model.
{ applicationId : String
, attributeType : String
, attributes : Maybe ListOfString
}
The AttributesResource data model.
{ apiKey : String
, enabled : Maybe Basics.Bool
, secretKey : String
}
The BaiduChannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, credential : String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The BaiduChannelResponse data model.
{ action : Maybe Action
, body : Maybe String
, data : Maybe MapOfString
, iconReference : Maybe String
, imageIconUrl : Maybe String
, imageUrl : Maybe String
, rawContent : Maybe String
, silentPush : Maybe Basics.Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, timeToLive : Maybe Basics.Int
, title : Maybe String
, url : Maybe String
}
The BaiduMessage data model.
{ rows : ListOfResultRow }
The BaseKpiResult data model.
{ applicationId : String
, campaignId : String
, endTime : String
, kpiName : String
, kpiResult : BaseKpiResult
, nextToken : Maybe String
, startTime : String
}
The CampaignDateRangeKpiResponse data model.
{ body : Maybe String
, fromAddress : Maybe String
, htmlBody : Maybe String
, title : String
}
The CampaignEmailMessage data model.
{ dimensions : EventDimensions
, filterType : FilterType
}
The CampaignEventFilter data model.
{ lambdaFunctionName : Maybe String
, mode : Maybe Mode
, webUrl : Maybe String
}
The CampaignHook data model.
{ daily : Maybe Basics.Int
, maximumDuration : Maybe Basics.Int
, messagesPerSecond : Maybe Basics.Int
, total : Maybe Basics.Int
}
The CampaignLimits data model.
{ additionalTreatments : Maybe ListOfTreatmentResource
, applicationId : String
, arn : String
, creationDate : String
, defaultState : Maybe CampaignState
, description : Maybe String
, holdoutPercent : Maybe Basics.Int
, hook : Maybe CampaignHook
, id : String
, isPaused : Maybe Basics.Bool
, lastModifiedDate : String
, limits : Maybe CampaignLimits
, messageConfiguration : Maybe MessageConfiguration
, name : Maybe String
, schedule : Maybe Schedule
, segmentId : String
, segmentVersion : Basics.Int
, state : Maybe CampaignState
, treatmentDescription : Maybe String
, treatmentName : Maybe String
, version : Maybe Basics.Int
, tags : Maybe MapOfString
}
The CampaignResponse data model.
{ body : Maybe String
, messageType : Maybe MessageType
, senderId : Maybe String
}
The CampaignSmsMessage data model.
{ campaignStatus : Maybe CampaignStatus }
The CampaignState data model.
The CampaignStatus data model.
{ item : ListOfCampaignResponse
, nextToken : Maybe String
}
The CampaignsResponse data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, version : Maybe Basics.Int
}
The ChannelResponse data model.
The ChannelType data model.
{ channels : MapOfChannelResponse }
The ChannelsResponse data model.
{ createApplicationRequest : CreateApplicationRequest }
The CreateAppRequest data model.
{ applicationResponse : ApplicationResponse }
The CreateAppResponse data model.
{ name : String
, tags : Maybe MapOfString
}
The CreateApplicationRequest data model.
{ applicationId : String
, writeCampaignRequest : WriteCampaignRequest
}
The CreateCampaignRequest data model.
{ campaignResponse : CampaignResponse }
The CreateCampaignResponse data model.
{ applicationId : String
, exportJobRequest : ExportJobRequest
}
The CreateExportJobRequest data model.
{ exportJobResponse : ExportJobResponse }
The CreateExportJobResponse data model.
{ applicationId : String
, importJobRequest : ImportJobRequest
}
The CreateImportJobRequest data model.
{ importJobResponse : ImportJobResponse }
The CreateImportJobResponse data model.
{ applicationId : String
, writeSegmentRequest : WriteSegmentRequest
}
The CreateSegmentRequest data model.
{ segmentResponse : SegmentResponse }
The CreateSegmentResponse data model.
{ body : Maybe String
, substitutions : Maybe MapOfListOfString
}
The DefaultMessage data model.
{ action : Maybe Action
, body : Maybe String
, data : Maybe MapOfString
, silentPush : Maybe Basics.Bool
, substitutions : Maybe MapOfListOfString
, title : Maybe String
, url : Maybe String
}
The DefaultPushNotificationMessage data model.
{ applicationId : String }
The DeleteAdmChannelRequest data model.
{ admchannelResponse : AdmchannelResponse }
The DeleteAdmChannelResponse data model.
{ applicationId : String }
The DeleteApnsChannelRequest data model.
{ apnschannelResponse : ApnschannelResponse }
The DeleteApnsChannelResponse data model.
{ applicationId : String }
The DeleteApnsSandboxChannelRequest data model.
{ apnssandboxChannelResponse : ApnssandboxChannelResponse }
The DeleteApnsSandboxChannelResponse data model.
{ applicationId : String }
The DeleteApnsVoipChannelRequest data model.
{ apnsvoipChannelResponse : ApnsvoipChannelResponse }
The DeleteApnsVoipChannelResponse data model.
{ applicationId : String }
The DeleteApnsVoipSandboxChannelRequest data model.
{ apnsvoipSandboxChannelResponse : ApnsvoipSandboxChannelResponse }
The DeleteApnsVoipSandboxChannelResponse data model.
{ applicationId : String }
The DeleteAppRequest data model.
{ applicationResponse : ApplicationResponse }
The DeleteAppResponse data model.
{ applicationId : String }
The DeleteBaiduChannelRequest data model.
{ baiduChannelResponse : BaiduChannelResponse }
The DeleteBaiduChannelResponse data model.
{ applicationId : String
, campaignId : String
}
The DeleteCampaignRequest data model.
{ campaignResponse : CampaignResponse }
The DeleteCampaignResponse data model.
{ applicationId : String }
The DeleteEmailChannelRequest data model.
{ emailChannelResponse : EmailChannelResponse }
The DeleteEmailChannelResponse data model.
{ applicationId : String
, endpointId : String
}
The DeleteEndpointRequest data model.
{ endpointResponse : EndpointResponse }
The DeleteEndpointResponse data model.
{ applicationId : String }
The DeleteEventStreamRequest data model.
{ eventStream : EventStream }
The DeleteEventStreamResponse data model.
{ applicationId : String }
The DeleteGcmChannelRequest data model.
{ gcmchannelResponse : GcmchannelResponse }
The DeleteGcmChannelResponse data model.
{ applicationId : String
, segmentId : String
}
The DeleteSegmentRequest data model.
{ segmentResponse : SegmentResponse }
The DeleteSegmentResponse data model.
{ applicationId : String }
The DeleteSmsChannelRequest data model.
{ smschannelResponse : SmschannelResponse }
The DeleteSmsChannelResponse data model.
{ applicationId : String
, userId : String
}
The DeleteUserEndpointsRequest data model.
{ endpointsResponse : EndpointsResponse }
The DeleteUserEndpointsResponse data model.
{ applicationId : String }
The DeleteVoiceChannelRequest data model.
{ voiceChannelResponse : VoiceChannelResponse }
The DeleteVoiceChannelResponse data model.
The DeliveryStatus data model.
The DimensionType data model.
{ admmessage : Maybe Admmessage
, apnsmessage : Maybe Apnsmessage
, baiduMessage : Maybe BaiduMessage
, defaultMessage : Maybe DefaultMessage
, defaultPushNotificationMessage : Maybe DefaultPushNotificationMessage
, emailMessage : Maybe EmailMessage
, gcmmessage : Maybe Gcmmessage
, smsmessage : Maybe Smsmessage
, voiceMessage : Maybe VoiceMessage
}
The DirectMessageConfiguration data model.
The Duration data model.
{ configurationSet : Maybe String
, enabled : Maybe Basics.Bool
, fromAddress : String
, identity : String
, roleArn : Maybe String
}
The EmailChannelRequest data model.
{ applicationId : Maybe String
, configurationSet : Maybe String
, creationDate : Maybe String
, enabled : Maybe Basics.Bool
, fromAddress : Maybe String
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, identity : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, messagesPerSecond : Maybe Basics.Int
, platform : String
, roleArn : Maybe String
, version : Maybe Basics.Int
}
The EmailChannelResponse data model.
{ body : Maybe String
, feedbackForwardingAddress : Maybe String
, fromAddress : Maybe String
, rawEmail : Maybe RawEmail
, replyToAddresses : Maybe ListOfString
, simpleEmail : Maybe SimpleEmail
, substitutions : Maybe MapOfListOfString
}
The EmailMessage data model.
{ address : Maybe String
, attributes : Maybe MapOfListOfString
, channelType : Maybe ChannelType
, demographic : Maybe EndpointDemographic
, effectiveDate : Maybe String
, endpointStatus : Maybe String
, id : Maybe String
, location : Maybe EndpointLocation
, metrics : Maybe MapOfDouble
, optOut : Maybe String
, requestId : Maybe String
, user : Maybe EndpointUser
}
The EndpointBatchItem data model.
{ item : ListOfEndpointBatchItem }
The EndpointBatchRequest data model.
{ appVersion : Maybe String
, locale : Maybe String
, make : Maybe String
, model : Maybe String
, modelVersion : Maybe String
, platform : Maybe String
, platformVersion : Maybe String
, timezone : Maybe String
}
The EndpointDemographic data model.
{ message : Maybe String
, statusCode : Maybe Basics.Int
}
The EndpointItemResponse data model.
{ city : Maybe String
, country : Maybe String
, latitude : Maybe Basics.Float
, longitude : Maybe Basics.Float
, postalCode : Maybe String
, region : Maybe String
}
The EndpointLocation data model.
{ address : Maybe String
, deliveryStatus : DeliveryStatus
, messageId : Maybe String
, statusCode : Basics.Int
, statusMessage : Maybe String
, updatedToken : Maybe String
}
The EndpointMessageResult data model.
{ address : Maybe String
, attributes : Maybe MapOfListOfString
, channelType : Maybe ChannelType
, demographic : Maybe EndpointDemographic
, effectiveDate : Maybe String
, endpointStatus : Maybe String
, location : Maybe EndpointLocation
, metrics : Maybe MapOfDouble
, optOut : Maybe String
, requestId : Maybe String
, user : Maybe EndpointUser
}
The EndpointRequest data model.
{ address : Maybe String
, applicationId : Maybe String
, attributes : Maybe MapOfListOfString
, channelType : Maybe ChannelType
, cohortId : Maybe String
, creationDate : Maybe String
, demographic : Maybe EndpointDemographic
, effectiveDate : Maybe String
, endpointStatus : Maybe String
, id : Maybe String
, location : Maybe EndpointLocation
, metrics : Maybe MapOfDouble
, optOut : Maybe String
, requestId : Maybe String
, user : Maybe EndpointUser
}
The EndpointResponse data model.
{ bodyOverride : Maybe String
, context : Maybe MapOfString
, rawContent : Maybe String
, substitutions : Maybe MapOfListOfString
, titleOverride : Maybe String
}
The EndpointSendConfiguration data model.
{ userAttributes : Maybe MapOfListOfString
, userId : Maybe String
}
The EndpointUser data model.
{ item : ListOfEndpointResponse }
The EndpointsResponse data model.
{ appPackageName : Maybe String
, appTitle : Maybe String
, appVersionCode : Maybe String
, attributes : Maybe MapOfString
, clientSdkVersion : Maybe String
, eventType : String
, metrics : Maybe MapOfDouble
, sdkName : Maybe String
, session : Maybe Session
, timestamp : String
}
The Event data model.
{ attributes : Maybe MapOfAttributeDimension
, eventType : Maybe SetDimension
, metrics : Maybe MapOfMetricDimension
}
The EventDimensions data model.
{ message : Maybe String
, statusCode : Maybe Basics.Int
}
The EventItemResponse data model.
{ applicationId : String
, destinationStreamArn : String
, externalId : Maybe String
, lastModifiedDate : Maybe String
, lastUpdatedBy : Maybe String
, roleArn : String
}
The EventStream data model.
{ endpoint : PublicEndpoint
, events : MapOfEvent
}
The EventsBatch data model.
{ batchItem : MapOfEventsBatch }
The EventsRequest data model.
{ results : Maybe MapOfItemResponse }
The EventsResponse data model.
{ roleArn : String
, s3UrlPrefix : String
, segmentId : Maybe String
, segmentVersion : Maybe Basics.Int
}
The ExportJobRequest data model.
{ roleArn : String
, s3UrlPrefix : String
, segmentId : Maybe String
, segmentVersion : Maybe Basics.Int
}
The ExportJobResource data model.
{ applicationId : String
, completedPieces : Maybe Basics.Int
, completionDate : Maybe String
, creationDate : String
, definition : ExportJobResource
, failedPieces : Maybe Basics.Int
, failures : Maybe ListOfString
, id : String
, jobStatus : JobStatus
, totalFailures : Maybe Basics.Int
, totalPieces : Maybe Basics.Int
, totalProcessed : Maybe Basics.Int
, type_ : String
}
The ExportJobResponse data model.
{ item : ListOfExportJobResponse
, nextToken : Maybe String
}
The ExportJobsResponse data model.
The FilterType data model.
The Format data model.
The Frequency data model.
{ apiKey : String
, enabled : Maybe Basics.Bool
}
The GcmchannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, credential : String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The GcmchannelResponse data model.
{ action : Maybe Action
, body : Maybe String
, collapseKey : Maybe String
, data : Maybe MapOfString
, iconReference : Maybe String
, imageIconUrl : Maybe String
, imageUrl : Maybe String
, priority : Maybe String
, rawContent : Maybe String
, restrictedPackageName : Maybe String
, silentPush : Maybe Basics.Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, timeToLive : Maybe Basics.Int
, title : Maybe String
, url : Maybe String
}
The Gcmmessage data model.
{ applicationId : String }
The GetAdmChannelRequest data model.
{ admchannelResponse : AdmchannelResponse }
The GetAdmChannelResponse data model.
{ applicationId : String }
The GetApnsChannelRequest data model.
{ apnschannelResponse : ApnschannelResponse }
The GetApnsChannelResponse data model.
{ applicationId : String }
The GetApnsSandboxChannelRequest data model.
{ apnssandboxChannelResponse : ApnssandboxChannelResponse }
The GetApnsSandboxChannelResponse data model.
{ applicationId : String }
The GetApnsVoipChannelRequest data model.
{ apnsvoipChannelResponse : ApnsvoipChannelResponse }
The GetApnsVoipChannelResponse data model.
{ applicationId : String }
The GetApnsVoipSandboxChannelRequest data model.
{ apnsvoipSandboxChannelResponse : ApnsvoipSandboxChannelResponse }
The GetApnsVoipSandboxChannelResponse data model.
{ applicationId : String }
The GetAppRequest data model.
{ applicationResponse : ApplicationResponse }
The GetAppResponse data model.
{ applicationId : String
, endTime : Maybe String
, kpiName : String
, nextToken : Maybe String
, pageSize : Maybe String
, startTime : Maybe String
}
The GetApplicationDateRangeKpiRequest data model.
{ applicationDateRangeKpiResponse : ApplicationDateRangeKpiResponse }
The GetApplicationDateRangeKpiResponse data model.
{ applicationId : String }
The GetApplicationSettingsRequest data model.
{ applicationSettingsResource : ApplicationSettingsResource }
The GetApplicationSettingsResponse data model.
{ pageSize : Maybe String
, token : Maybe String
}
The GetAppsRequest data model.
{ applicationsResponse : ApplicationsResponse }
The GetAppsResponse data model.
{ applicationId : String }
The GetBaiduChannelRequest data model.
{ baiduChannelResponse : BaiduChannelResponse }
The GetBaiduChannelResponse data model.
{ applicationId : String
, campaignId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetCampaignActivitiesRequest data model.
{ activitiesResponse : ActivitiesResponse }
The GetCampaignActivitiesResponse data model.
{ applicationId : String
, campaignId : String
, endTime : Maybe String
, kpiName : String
, nextToken : Maybe String
, pageSize : Maybe String
, startTime : Maybe String
}
The GetCampaignDateRangeKpiRequest data model.
{ campaignDateRangeKpiResponse : CampaignDateRangeKpiResponse }
The GetCampaignDateRangeKpiResponse data model.
{ applicationId : String
, campaignId : String
}
The GetCampaignRequest data model.
{ campaignResponse : CampaignResponse }
The GetCampaignResponse data model.
{ applicationId : String
, campaignId : String
, version : String
}
The GetCampaignVersionRequest data model.
{ campaignResponse : CampaignResponse }
The GetCampaignVersionResponse data model.
{ applicationId : String
, campaignId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetCampaignVersionsRequest data model.
{ campaignsResponse : CampaignsResponse }
The GetCampaignVersionsResponse data model.
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetCampaignsRequest data model.
{ campaignsResponse : CampaignsResponse }
The GetCampaignsResponse data model.
{ applicationId : String }
The GetChannelsRequest data model.
{ channelsResponse : ChannelsResponse }
The GetChannelsResponse data model.
{ applicationId : String }
The GetEmailChannelRequest data model.
{ emailChannelResponse : EmailChannelResponse }
The GetEmailChannelResponse data model.
{ applicationId : String
, endpointId : String
}
The GetEndpointRequest data model.
{ endpointResponse : EndpointResponse }
The GetEndpointResponse data model.
{ applicationId : String }
The GetEventStreamRequest data model.
{ eventStream : EventStream }
The GetEventStreamResponse data model.
{ applicationId : String
, jobId : String
}
The GetExportJobRequest data model.
{ exportJobResponse : ExportJobResponse }
The GetExportJobResponse data model.
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetExportJobsRequest data model.
{ exportJobsResponse : ExportJobsResponse }
The GetExportJobsResponse data model.
{ applicationId : String }
The GetGcmChannelRequest data model.
{ gcmchannelResponse : GcmchannelResponse }
The GetGcmChannelResponse data model.
{ applicationId : String
, jobId : String
}
The GetImportJobRequest data model.
{ importJobResponse : ImportJobResponse }
The GetImportJobResponse data model.
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetImportJobsRequest data model.
{ importJobsResponse : ImportJobsResponse }
The GetImportJobsResponse data model.
{ applicationId : String
, pageSize : Maybe String
, segmentId : String
, token : Maybe String
}
The GetSegmentExportJobsRequest data model.
{ exportJobsResponse : ExportJobsResponse }
The GetSegmentExportJobsResponse data model.
{ applicationId : String
, pageSize : Maybe String
, segmentId : String
, token : Maybe String
}
The GetSegmentImportJobsRequest data model.
{ importJobsResponse : ImportJobsResponse }
The GetSegmentImportJobsResponse data model.
{ applicationId : String
, segmentId : String
}
The GetSegmentRequest data model.
{ segmentResponse : SegmentResponse }
The GetSegmentResponse data model.
{ applicationId : String
, segmentId : String
, version : String
}
The GetSegmentVersionRequest data model.
{ segmentResponse : SegmentResponse }
The GetSegmentVersionResponse data model.
{ applicationId : String
, pageSize : Maybe String
, segmentId : String
, token : Maybe String
}
The GetSegmentVersionsRequest data model.
{ segmentsResponse : SegmentsResponse }
The GetSegmentVersionsResponse data model.
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}
The GetSegmentsRequest data model.
{ segmentsResponse : SegmentsResponse }
The GetSegmentsResponse data model.
{ applicationId : String }
The GetSmsChannelRequest data model.
{ smschannelResponse : SmschannelResponse }
The GetSmsChannelResponse data model.
{ applicationId : String
, userId : String
}
The GetUserEndpointsRequest data model.
{ endpointsResponse : EndpointsResponse }
The GetUserEndpointsResponse data model.
{ applicationId : String }
The GetVoiceChannelRequest data model.
{ voiceChannelResponse : VoiceChannelResponse }
The GetVoiceChannelResponse data model.
{ latitude : Basics.Float
, longitude : Basics.Float
}
The Gpscoordinates data model.
{ coordinates : Gpscoordinates
, rangeInKilometers : Maybe Basics.Float
}
The GpspointDimension data model.
{ defineSegment : Maybe Basics.Bool
, externalId : Maybe String
, format : Format
, registerEndpoints : Maybe Basics.Bool
, roleArn : String
, s3Url : String
, segmentId : Maybe String
, segmentName : Maybe String
}
The ImportJobRequest data model.
{ defineSegment : Maybe Basics.Bool
, externalId : Maybe String
, format : Format
, registerEndpoints : Maybe Basics.Bool
, roleArn : String
, s3Url : String
, segmentId : Maybe String
, segmentName : Maybe String
}
The ImportJobResource data model.
{ applicationId : String
, completedPieces : Maybe Basics.Int
, completionDate : Maybe String
, creationDate : String
, definition : ImportJobResource
, failedPieces : Maybe Basics.Int
, failures : Maybe ListOfString
, id : String
, jobStatus : JobStatus
, totalFailures : Maybe Basics.Int
, totalPieces : Maybe Basics.Int
, totalProcessed : Maybe Basics.Int
, type_ : String
}
The ImportJobResponse data model.
{ item : ListOfImportJobResponse
, nextToken : Maybe String
}
The ImportJobsResponse data model.
The Include data model.
{ endpointItemResponse : Maybe EndpointItemResponse
, eventsItemResponse : Maybe MapOfEventItemResponse
}
The ItemResponse data model.
The JobStatus data model.
List ActivityResponse
The ListOfActivityResponse data model.
List ApplicationResponse
The ListOfApplicationResponse data model.
List CampaignResponse
The ListOfCampaignResponse data model.
List EndpointBatchItem
The ListOfEndpointBatchItem data model.
List EndpointResponse
The ListOfEndpointResponse data model.
List ExportJobResponse
The ListOfExportJobResponse data model.
List ImportJobResponse
The ListOfImportJobResponse data model.
List ResultRow
The ListOfResultRow data model.
List ResultRowValue
The ListOfResultRowValue data model.
List SegmentDimensions
The ListOfSegmentDimensions data model.
List SegmentGroup
The ListOfSegmentGroup data model.
List SegmentReference
The ListOfSegmentReference data model.
List SegmentResponse
The ListOfSegmentResponse data model.
List String
The ListOfString data model.
List TreatmentResource
The ListOfTreatmentResource data model.
List WriteTreatmentResource
The ListOfWriteTreatmentResource data model.
{ resourceArn : String }
The ListTagsForResourceRequest data model.
{ tagsModel : TagsModel }
The ListTagsForResourceResponse data model.
Dict String AddressConfiguration
The MapOfAddressConfiguration data model.
Dict String AttributeDimension
The MapOfAttributeDimension data model.
Dict String ChannelResponse
The MapOfChannelResponse data model.
Dict String Basics.Float
The MapOfDouble data model.
Dict String EndpointMessageResult
The MapOfEndpointMessageResult data model.
Dict String EndpointSendConfiguration
The MapOfEndpointSendConfiguration data model.
Dict String Event
The MapOfEvent data model.
Dict String EventItemResponse
The MapOfEventItemResponse data model.
Dict String EventsBatch
The MapOfEventsBatch data model.
Dict String Basics.Int
The MapOfInteger data model.
Dict String ItemResponse
The MapOfItemResponse data model.
Dict String ListOfString
The MapOfListOfString data model.
Dict String MapOfEndpointMessageResult
The MapOfMapOfEndpointMessageResult data model.
Dict String MessageResult
The MapOfMessageResult data model.
Dict String MetricDimension
The MapOfMetricDimension data model.
Dict String String
The MapOfString data model.
{ action : Maybe Action
, body : Maybe String
, imageIconUrl : Maybe String
, imageSmallIconUrl : Maybe String
, imageUrl : Maybe String
, jsonBody : Maybe String
, mediaUrl : Maybe String
, rawContent : Maybe String
, silentPush : Maybe Basics.Bool
, timeToLive : Maybe Basics.Int
, title : Maybe String
, url : Maybe String
}
The Message data model.
{ message : Maybe String
, requestId : Maybe String
}
The MessageBody data model.
{ admmessage : Maybe Message
, apnsmessage : Maybe Message
, baiduMessage : Maybe Message
, defaultMessage : Maybe Message
, emailMessage : Maybe CampaignEmailMessage
, gcmmessage : Maybe Message
, smsmessage : Maybe CampaignSmsMessage
}
The MessageConfiguration data model.
{ addresses : Maybe MapOfAddressConfiguration
, context : Maybe MapOfString
, endpoints : Maybe MapOfEndpointSendConfiguration
, messageConfiguration : DirectMessageConfiguration
, traceId : Maybe String
}
The MessageRequest data model.
{ applicationId : String
, endpointResult : Maybe MapOfEndpointMessageResult
, requestId : Maybe String
, result : Maybe MapOfMessageResult
}
The MessageResponse data model.
{ deliveryStatus : DeliveryStatus
, messageId : Maybe String
, statusCode : Basics.Int
, statusMessage : Maybe String
, updatedToken : Maybe String
}
The MessageResult data model.
The MessageType data model.
{ comparisonOperator : String
, value : Basics.Float
}
The MetricDimension data model.
The Mode data model.
{ isoCountryCode : Maybe String
, phoneNumber : Maybe String
}
The NumberValidateRequest data model.
{ carrier : Maybe String
, city : Maybe String
, cleansedPhoneNumberE164 : Maybe String
, cleansedPhoneNumberNational : Maybe String
, country : Maybe String
, countryCodeIso2 : Maybe String
, countryCodeNumeric : Maybe String
, county : Maybe String
, originalCountryCodeIso2 : Maybe String
, originalPhoneNumber : Maybe String
, phoneType : Maybe String
, phoneTypeCode : Maybe Basics.Int
, timezone : Maybe String
, zipCode : Maybe String
}
The NumberValidateResponse data model.
{ numberValidateRequest : NumberValidateRequest }
The PhoneNumberValidateRequest data model.
{ numberValidateResponse : NumberValidateResponse }
The PhoneNumberValidateResponse data model.
{ address : Maybe String
, attributes : Maybe MapOfListOfString
, channelType : Maybe ChannelType
, demographic : Maybe EndpointDemographic
, effectiveDate : Maybe String
, endpointStatus : Maybe String
, location : Maybe EndpointLocation
, metrics : Maybe MapOfDouble
, optOut : Maybe String
, requestId : Maybe String
, user : Maybe EndpointUser
}
The PublicEndpoint data model.
{ applicationId : String
, writeEventStream : WriteEventStream
}
The PutEventStreamRequest data model.
{ eventStream : EventStream }
The PutEventStreamResponse data model.
{ applicationId : String
, eventsRequest : EventsRequest
}
The PutEventsRequest data model.
{ eventsResponse : EventsResponse }
The PutEventsResponse data model.
{ end : Maybe String
, start : Maybe String
}
The QuietTime data model.
{ data : Maybe String }
The RawEmail data model.
{ duration : Duration
, recencyType : RecencyType
}
The RecencyDimension data model.
The RecencyType data model.
{ applicationId : String
, attributeType : String
, updateAttributesRequest : UpdateAttributesRequest
}
The RemoveAttributesRequest data model.
{ attributesResource : AttributesResource }
The RemoveAttributesResponse data model.
{ groupedBys : ListOfResultRowValue
, values : ListOfResultRowValue
}
The ResultRow data model.
{ key : String
, type_ : String
, value : String
}
The ResultRowValue data model.
{ endTime : Maybe String
, eventFilter : Maybe CampaignEventFilter
, frequency : Maybe Frequency
, isLocalTime : Maybe Basics.Bool
, quietTime : Maybe QuietTime
, startTime : String
, timezone : Maybe String
}
The Schedule data model.
{ recency : Maybe RecencyDimension }
The SegmentBehaviors data model.
{ appVersion : Maybe SetDimension
, channel : Maybe SetDimension
, deviceType : Maybe SetDimension
, make : Maybe SetDimension
, model : Maybe SetDimension
, platform : Maybe SetDimension
}
The SegmentDemographics data model.
{ attributes : Maybe MapOfAttributeDimension
, behavior : Maybe SegmentBehaviors
, demographic : Maybe SegmentDemographics
, location : Maybe SegmentLocation
, metrics : Maybe MapOfMetricDimension
, userAttributes : Maybe MapOfAttributeDimension
}
The SegmentDimensions data model.
{ dimensions : Maybe ListOfSegmentDimensions
, sourceSegments : Maybe ListOfSegmentReference
, sourceType : Maybe SourceType
, type_ : Maybe Type
}
The SegmentGroup data model.
{ groups : Maybe ListOfSegmentGroup
, include : Maybe Include
}
The SegmentGroupList data model.
{ channelCounts : Maybe MapOfInteger
, externalId : String
, format : Format
, roleArn : String
, s3Url : String
, size : Basics.Int
}
The SegmentImportResource data model.
{ country : Maybe SetDimension
, gpspoint : Maybe GpspointDimension
}
The SegmentLocation data model.
{ id : String
, version : Maybe Basics.Int
}
The SegmentReference data model.
{ applicationId : String
, arn : String
, creationDate : String
, dimensions : Maybe SegmentDimensions
, id : String
, importDefinition : Maybe SegmentImportResource
, lastModifiedDate : Maybe String
, name : Maybe String
, segmentGroups : Maybe SegmentGroupList
, segmentType : SegmentType
, version : Maybe Basics.Int
, tags : Maybe MapOfString
}
The SegmentResponse data model.
The SegmentType data model.
{ item : ListOfSegmentResponse
, nextToken : Maybe String
}
The SegmentsResponse data model.
{ applicationId : String
, messageRequest : MessageRequest
}
The SendMessagesRequest data model.
{ messageResponse : MessageResponse }
The SendMessagesResponse data model.
{ context : Maybe MapOfString
, messageConfiguration : DirectMessageConfiguration
, traceId : Maybe String
, users : MapOfEndpointSendConfiguration
}
The SendUsersMessageRequest data model.
{ applicationId : String
, requestId : Maybe String
, result : Maybe MapOfMapOfEndpointMessageResult
}
The SendUsersMessageResponse data model.
{ applicationId : String
, sendUsersMessageRequest : SendUsersMessageRequest
}
The SendUsersMessagesRequest data model.
{ sendUsersMessageResponse : SendUsersMessageResponse }
The SendUsersMessagesResponse data model.
{ duration : Maybe Basics.Int
, id : String
, startTimestamp : String
, stopTimestamp : Maybe String
}
The Session data model.
{ dimensionType : Maybe DimensionType
, values : ListOfString
}
The SetDimension data model.
{ htmlPart : Maybe SimpleEmailPart
, subject : Maybe SimpleEmailPart
, textPart : Maybe SimpleEmailPart
}
The SimpleEmail data model.
{ charset : Maybe String
, data : Maybe String
}
The SimpleEmailPart data model.
{ enabled : Maybe Basics.Bool
, senderId : Maybe String
, shortCode : Maybe String
}
The SmschannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, promotionalMessagesPerSecond : Maybe Basics.Int
, senderId : Maybe String
, shortCode : Maybe String
, transactionalMessagesPerSecond : Maybe Basics.Int
, version : Maybe Basics.Int
}
The SmschannelResponse data model.
{ body : Maybe String
, keyword : Maybe String
, messageType : Maybe MessageType
, originationNumber : Maybe String
, senderId : Maybe String
, substitutions : Maybe MapOfListOfString
}
The Smsmessage data model.
The SourceType data model.
{ resourceArn : String
, tagsModel : TagsModel
}
The TagResourceRequest data model.
{ tags : MapOfString }
The TagsModel data model.
{ id : String
, messageConfiguration : Maybe MessageConfiguration
, schedule : Maybe Schedule
, sizePercent : Basics.Int
, state : Maybe CampaignState
, treatmentDescription : Maybe String
, treatmentName : Maybe String
}
The TreatmentResource data model.
The Type data model.
{ resourceArn : String
, tagKeys : ListOfString
}
The UntagResourceRequest data model.
{ admchannelRequest : AdmchannelRequest
, applicationId : String
}
The UpdateAdmChannelRequest data model.
{ admchannelResponse : AdmchannelResponse }
The UpdateAdmChannelResponse data model.
{ apnschannelRequest : ApnschannelRequest
, applicationId : String
}
The UpdateApnsChannelRequest data model.
{ apnschannelResponse : ApnschannelResponse }
The UpdateApnsChannelResponse data model.
{ apnssandboxChannelRequest : ApnssandboxChannelRequest
, applicationId : String
}
The UpdateApnsSandboxChannelRequest data model.
{ apnssandboxChannelResponse : ApnssandboxChannelResponse }
The UpdateApnsSandboxChannelResponse data model.
{ apnsvoipChannelRequest : ApnsvoipChannelRequest
, applicationId : String
}
The UpdateApnsVoipChannelRequest data model.
{ apnsvoipChannelResponse : ApnsvoipChannelResponse }
The UpdateApnsVoipChannelResponse data model.
{ apnsvoipSandboxChannelRequest : ApnsvoipSandboxChannelRequest
, applicationId : String
}
The UpdateApnsVoipSandboxChannelRequest data model.
{ apnsvoipSandboxChannelResponse : ApnsvoipSandboxChannelResponse }
The UpdateApnsVoipSandboxChannelResponse data model.
{ applicationId : String
, writeApplicationSettingsRequest : WriteApplicationSettingsRequest
}
The UpdateApplicationSettingsRequest data model.
{ applicationSettingsResource : ApplicationSettingsResource }
The UpdateApplicationSettingsResponse data model.
{ blacklist : Maybe ListOfString }
The UpdateAttributesRequest data model.
{ applicationId : String
, baiduChannelRequest : BaiduChannelRequest
}
The UpdateBaiduChannelRequest data model.
{ baiduChannelResponse : BaiduChannelResponse }
The UpdateBaiduChannelResponse data model.
{ applicationId : String
, campaignId : String
, writeCampaignRequest : WriteCampaignRequest
}
The UpdateCampaignRequest data model.
{ campaignResponse : CampaignResponse }
The UpdateCampaignResponse data model.
{ applicationId : String
, emailChannelRequest : EmailChannelRequest
}
The UpdateEmailChannelRequest data model.
{ emailChannelResponse : EmailChannelResponse }
The UpdateEmailChannelResponse data model.
{ applicationId : String
, endpointId : String
, endpointRequest : EndpointRequest
}
The UpdateEndpointRequest data model.
{ messageBody : MessageBody }
The UpdateEndpointResponse data model.
{ applicationId : String
, endpointBatchRequest : EndpointBatchRequest
}
The UpdateEndpointsBatchRequest data model.
{ messageBody : MessageBody }
The UpdateEndpointsBatchResponse data model.
{ applicationId : String
, gcmchannelRequest : GcmchannelRequest
}
The UpdateGcmChannelRequest data model.
{ gcmchannelResponse : GcmchannelResponse }
The UpdateGcmChannelResponse data model.
{ applicationId : String
, segmentId : String
, writeSegmentRequest : WriteSegmentRequest
}
The UpdateSegmentRequest data model.
{ segmentResponse : SegmentResponse }
The UpdateSegmentResponse data model.
{ applicationId : String
, smschannelRequest : SmschannelRequest
}
The UpdateSmsChannelRequest data model.
{ smschannelResponse : SmschannelResponse }
The UpdateSmsChannelResponse data model.
{ applicationId : String
, voiceChannelRequest : VoiceChannelRequest
}
The UpdateVoiceChannelRequest data model.
{ voiceChannelResponse : VoiceChannelResponse }
The UpdateVoiceChannelResponse data model.
{ enabled : Maybe Basics.Bool }
The VoiceChannelRequest data model.
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Basics.Bool
, hasCredential : Maybe Basics.Bool
, id : Maybe String
, isArchived : Maybe Basics.Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Basics.Int
}
The VoiceChannelResponse data model.
{ body : Maybe String
, languageCode : Maybe String
, originationNumber : Maybe String
, substitutions : Maybe MapOfListOfString
, voiceId : Maybe String
}
The VoiceMessage data model.
{ campaignHook : Maybe CampaignHook
, cloudWatchMetricsEnabled : Maybe Basics.Bool
, limits : Maybe CampaignLimits
, quietTime : Maybe QuietTime
}
The WriteApplicationSettingsRequest data model.
{ additionalTreatments : Maybe ListOfWriteTreatmentResource
, description : Maybe String
, holdoutPercent : Maybe Basics.Int
, hook : Maybe CampaignHook
, isPaused : Maybe Basics.Bool
, limits : Maybe CampaignLimits
, messageConfiguration : Maybe MessageConfiguration
, name : Maybe String
, schedule : Maybe Schedule
, segmentId : Maybe String
, segmentVersion : Maybe Basics.Int
, treatmentDescription : Maybe String
, treatmentName : Maybe String
, tags : Maybe MapOfString
}
The WriteCampaignRequest data model.
{ destinationStreamArn : String
, roleArn : String
}
The WriteEventStream data model.
{ dimensions : Maybe SegmentDimensions
, name : Maybe String
, segmentGroups : Maybe SegmentGroupList
, tags : Maybe MapOfString
}
The WriteSegmentRequest data model.
{ messageConfiguration : Maybe MessageConfiguration
, schedule : Maybe Schedule
, sizePercent : Basics.Int
, treatmentDescription : Maybe String
, treatmentName : Maybe String
}
The WriteTreatmentResource data model.
action : Enum Action
The Action data model.
attributeType : Enum AttributeType
The AttributeType data model.
campaignStatus : Enum CampaignStatus
The CampaignStatus data model.
channelType : Enum ChannelType
The ChannelType data model.
deliveryStatus : Enum DeliveryStatus
The DeliveryStatus data model.
dimensionType : Enum DimensionType
The DimensionType data model.
duration : Enum Duration
The Duration data model.
filterType : Enum FilterType
The FilterType data model.
format : Enum Format
The Format data model.
frequency : Enum Frequency
The Frequency data model.
include : Enum Include
The Include data model.
jobStatus : Enum JobStatus
The JobStatus data model.
messageType : Enum MessageType
The MessageType data model.
mode : Enum Mode
The Mode data model.
recencyType : Enum RecencyType
The RecencyType data model.
segmentType : Enum SegmentType
The SegmentType data model.
sourceType : Enum SourceType
The SourceType data model.
type_ : Enum Type
The Type data model.