PackagesReroutesAboutlamdera.com

canceraiddev/elm-aws-pinpoint/1.0.1

READMEAboutVersionsSourceModules

AWS.Pinpoint

Doc Engage API - Amazon Pinpoint API

Service definition.

service : Region -> Service

Configuration for this service.

Service endpoints.

createApp : CreateAppRequest -> Request AWSAppError CreateAppResponse

Creates an application.

CreateCampaignRequest
-> Request AWSAppError CreateCampaignResponse

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

CreateExportJobRequest
-> Request AWSAppError CreateExportJobResponse

Creates a new export job for an application.

CreateImportJobRequest
-> Request AWSAppError CreateImportJobResponse

Creates a new import job for an application.

createSegment : CreateSegmentRequest -> Request 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.

DeleteAdmChannelRequest
-> Request AWSAppError DeleteAdmChannelResponse

Disables the ADM channel for an application and deletes any existing settings for the channel.

DeleteApnsChannelRequest
-> Request AWSAppError DeleteApnsChannelResponse

Disables the APNs channel for an application and deletes any existing settings for the channel.

DeleteApnsSandboxChannelRequest
-> Request AWSAppError DeleteApnsSandboxChannelResponse

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

DeleteApnsVoipChannelRequest
-> Request AWSAppError DeleteApnsVoipChannelResponse

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

DeleteApnsVoipSandboxChannelRequest
-> Request AWSAppError DeleteApnsVoipSandboxChannelResponse

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

deleteApp : DeleteAppRequest -> Request AWSAppError DeleteAppResponse

Deletes an application.

DeleteBaiduChannelRequest
-> Request AWSAppError DeleteBaiduChannelResponse

Disables the Baidu channel for an application and deletes any existing settings for the channel.

DeleteCampaignRequest
-> Request AWSAppError DeleteCampaignResponse

Deletes a campaign from an application.

DeleteEmailChannelRequest
-> Request AWSAppError DeleteEmailChannelResponse

Disables the email channel for an application and deletes any existing settings for the channel.

DeleteEndpointRequest
-> Request AWSAppError DeleteEndpointResponse

Deletes an endpoint from an application.

DeleteEventStreamRequest
-> Request AWSAppError DeleteEventStreamResponse

Deletes the event stream for an application.

DeleteGcmChannelRequest
-> Request AWSAppError DeleteGcmChannelResponse

Disables the GCM channel for an application and deletes any existing settings for the channel.

deleteSegment : DeleteSegmentRequest -> Request AWSAppError DeleteSegmentResponse

Deletes a segment from an application.

DeleteSmsChannelRequest
-> Request AWSAppError DeleteSmsChannelResponse

Disables the SMS channel for an application and deletes any existing settings for the channel.

DeleteUserEndpointsRequest
-> Request AWSAppError DeleteUserEndpointsResponse

Deletes all the endpoints that are associated with a specific user ID.

DeleteVoiceChannelRequest
-> Request AWSAppError DeleteVoiceChannelResponse

Disables the voice channel for an application and deletes any existing settings for the channel.

getAdmChannel : GetAdmChannelRequest -> Request AWSAppError GetAdmChannelResponse

Retrieves information about the status and settings of the ADM channel for an application.

GetApnsChannelRequest
-> Request AWSAppError GetApnsChannelResponse

Retrieves information about the status and settings of the APNs channel for an application.

GetApnsSandboxChannelRequest
-> Request AWSAppError GetApnsSandboxChannelResponse

Retrieves information about the status and settings of the APNs sandbox channel for an application.

GetApnsVoipChannelRequest
-> Request AWSAppError GetApnsVoipChannelResponse

Retrieves information about the status and settings of the APNs VoIP channel for an application.

GetApnsVoipSandboxChannelRequest
-> Request AWSAppError GetApnsVoipSandboxChannelResponse

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

getApp : GetAppRequest -> Request AWSAppError GetAppResponse

Retrieves information about an application.

GetApplicationDateRangeKpiRequest
-> Request AWSAppError GetApplicationDateRangeKpiResponse

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

GetApplicationSettingsRequest
-> Request AWSAppError GetApplicationSettingsResponse

Retrieves information about the settings for an application.

getApps : GetAppsRequest -> Request AWSAppError GetAppsResponse

Retrieves information about all of your applications.

GetBaiduChannelRequest
-> Request AWSAppError GetBaiduChannelResponse

Retrieves information about the status and settings of the Baidu Cloud Push channel for an application.

getCampaign : GetCampaignRequest -> Request AWSAppError GetCampaignResponse

Retrieves information about the status, configuration, and other settings for a campaign.

GetCampaignActivitiesRequest
-> Request AWSAppError GetCampaignActivitiesResponse

Retrieves information about the activity performed by a campaign.

GetCampaignDateRangeKpiRequest
-> Request AWSAppError GetCampaignDateRangeKpiResponse

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

GetCampaignVersionRequest
-> Request AWSAppError GetCampaignVersionResponse

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

GetCampaignVersionsRequest
-> Request AWSAppError GetCampaignVersionsResponse

Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.

getCampaigns : GetCampaignsRequest -> Request AWSAppError GetCampaignsResponse

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

getChannels : GetChannelsRequest -> Request AWSAppError GetChannelsResponse

Retrieves information about the history and status of each channel for an application.

GetEmailChannelRequest
-> Request AWSAppError GetEmailChannelResponse

Retrieves information about the status and settings of the email channel for an application.

getEndpoint : GetEndpointRequest -> Request AWSAppError GetEndpointResponse

Retrieves information about the settings and attributes of a specific endpoint for an application.

GetEventStreamRequest
-> Request AWSAppError GetEventStreamResponse

Retrieves information about the event stream settings for an application.

getExportJob : GetExportJobRequest -> Request AWSAppError GetExportJobResponse

Retrieves information about the status and settings of a specific export job for an application.

getExportJobs : GetExportJobsRequest -> Request AWSAppError GetExportJobsResponse

Retrieves information about the status and settings of all the export jobs for an application.

getGcmChannel : GetGcmChannelRequest -> Request AWSAppError GetGcmChannelResponse

Retrieves information about the status and settings of the GCM channel for an application.

getImportJob : GetImportJobRequest -> Request AWSAppError GetImportJobResponse

Retrieves information about the status and settings of a specific import job for an application.

getImportJobs : GetImportJobsRequest -> Request AWSAppError GetImportJobsResponse

Retrieves information about the status and settings of all the import jobs for an application.

getSegment : GetSegmentRequest -> Request AWSAppError GetSegmentResponse

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

GetSegmentExportJobsRequest
-> Request AWSAppError GetSegmentExportJobsResponse

Retrieves information about the status and settings of the export jobs for a segment.

GetSegmentImportJobsRequest
-> Request AWSAppError GetSegmentImportJobsResponse

Retrieves information about the status and settings of the import jobs for a segment.

GetSegmentVersionRequest
-> Request AWSAppError GetSegmentVersionResponse

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

GetSegmentVersionsRequest
-> Request 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 -> Request AWSAppError GetSegmentsResponse

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

getSmsChannel : GetSmsChannelRequest -> Request AWSAppError GetSmsChannelResponse

Retrieves information about the status and settings of the SMS channel for an application.

GetUserEndpointsRequest
-> Request AWSAppError GetUserEndpointsResponse

Retrieves information about all the endpoints that are associated with a specific user ID.

GetVoiceChannelRequest
-> Request AWSAppError GetVoiceChannelResponse

Retrieves information about the status and settings of the voice channel for an application.

ListTagsForResourceRequest
-> Request Never ListTagsForResourceResponse

Retrieves all the tags (keys and values) that are associated with an application, campaign, or segment.

PhoneNumberValidateRequest
-> Request AWSAppError PhoneNumberValidateResponse

Retrieves information about a phone number.

PutEventStreamRequest
-> Request AWSAppError PutEventStreamResponse

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

putEvents : PutEventsRequest -> Request AWSAppError PutEventsResponse

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

RemoveAttributesRequest
-> Request AWSAppError RemoveAttributesResponse

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

sendMessages : SendMessagesRequest -> Request AWSAppError SendMessagesResponse

Creates and sends a direct message.

SendUsersMessagesRequest
-> Request AWSAppError SendUsersMessagesResponse

Creates and sends a message to a list of users.

tagResource : TagResourceRequest -> Request Never ()

Adds one or more tags (keys and values) to an application, campaign, or segment.

untagResource : UntagResourceRequest -> Request Never ()

Removes one or more tags (keys and values) from an application, campaign, or segment.

UpdateAdmChannelRequest
-> Request AWSAppError UpdateAdmChannelResponse

Updates the ADM channel settings for an application.

UpdateApnsChannelRequest
-> Request AWSAppError UpdateApnsChannelResponse

Updates the APNs channel settings for an application.

UpdateApnsSandboxChannelRequest
-> Request AWSAppError UpdateApnsSandboxChannelResponse

Updates the APNs sandbox channel settings for an application.

UpdateApnsVoipChannelRequest
-> Request AWSAppError UpdateApnsVoipChannelResponse

Updates the APNs VoIP channel settings for an application.

UpdateApnsVoipSandboxChannelRequest
-> Request AWSAppError UpdateApnsVoipSandboxChannelResponse

Updates the settings for the APNs VoIP sandbox channel for an application.

UpdateApplicationSettingsRequest
-> Request AWSAppError UpdateApplicationSettingsResponse

Updates the settings for an application.

UpdateBaiduChannelRequest
-> Request AWSAppError UpdateBaiduChannelResponse

Updates the settings of the Baidu channel for an application.

UpdateCampaignRequest
-> Request AWSAppError UpdateCampaignResponse

Updates the settings for a campaign.

UpdateEmailChannelRequest
-> Request AWSAppError UpdateEmailChannelResponse

Updates the status and settings of the email channel for an application.

UpdateEndpointRequest
-> Request 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.

UpdateEndpointsBatchRequest
-> Request 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.

UpdateGcmChannelRequest
-> Request AWSAppError UpdateGcmChannelResponse

Updates the status and settings of the GCM channel for an application.

updateSegment : UpdateSegmentRequest -> Request 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.

UpdateSmsChannelRequest
-> Request AWSAppError UpdateSmsChannelResponse

Updates the status and settings of the SMS channel for an application.

UpdateVoiceChannelRequest
-> Request AWSAppError UpdateVoiceChannelResponse

Updates the status and settings of the voice channel for an application.

API data model.

type Action
= ActionOpenApp
| ActionDeepLink
| ActionUrl

The Action data model.

type alias ActivitiesResponse =
{ item : ListOfActivityResponse
, nextToken : Maybe String
}

The ActivitiesResponse data model.

type alias ActivityResponse =
{ applicationId : String
, campaignId : String
, end : Maybe String
, id : String
, result : Maybe String
, scheduledStart : Maybe String
, start : Maybe String
, state : Maybe String
, successfulEndpointCount : Maybe Int
, timezonesCompletedCount : Maybe Int
, timezonesTotalCount : Maybe Int
, totalEndpointCount : Maybe 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.

type alias AdmchannelRequest =
{ clientId : String
, clientSecret : String
, enabled : Maybe Bool
}

The AdmchannelRequest data model.

type alias AdmchannelResponse =
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The AdmchannelResponse data model.

type alias Admmessage =
{ 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 Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, title : Maybe String
, url : Maybe String
}

The Admmessage data model.

type alias ApnschannelRequest =
{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Bool
, privateKey : Maybe String
, teamId : Maybe String
, tokenKey : Maybe String
, tokenKeyId : Maybe String
}

The ApnschannelRequest data model.

type alias ApnschannelResponse =
{ applicationId : Maybe String
, creationDate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, hasTokenKey : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The ApnschannelResponse data model.

type alias Apnsmessage =
{ action : Maybe Action
, badge : Maybe 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 Bool
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, threadId : Maybe String
, timeToLive : Maybe Int
, title : Maybe String
, url : Maybe String
}

The Apnsmessage data model.

{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe 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 Bool
, hasCredential : Maybe Bool
, hasTokenKey : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The ApnssandboxChannelResponse data model.

{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe 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 Bool
, hasCredential : Maybe Bool
, hasTokenKey : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The ApnsvoipChannelResponse data model.

{ bundleId : Maybe String
, certificate : Maybe String
, defaultAuthenticationMethod : Maybe String
, enabled : Maybe 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 Bool
, hasCredential : Maybe Bool
, hasTokenKey : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The ApnsvoipSandboxChannelResponse data model.

{ applicationId : String
, endTime : String
, kpiName : String
, kpiResult : BaseKpiResult
, nextToken : Maybe String
, startTime : String
}

The ApplicationDateRangeKpiResponse data model.

type alias ApplicationResponse =
{ 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.

type alias AttributeDimension =
{ attributeType : Maybe AttributeType
, values : ListOfString
}

The AttributeDimension data model.

= AttributeTypeInclusive
| AttributeTypeExclusive

The AttributeType data model.

type alias AttributesResource =
{ applicationId : String
, attributeType : String
, attributes : Maybe ListOfString
}

The AttributesResource data model.

type alias BaiduChannelRequest =
{ apiKey : String
, enabled : Maybe Bool
, secretKey : String
}

The BaiduChannelRequest data model.

{ applicationId : Maybe String
, creationDate : Maybe String
, credential : String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The BaiduChannelResponse data model.

type alias BaiduMessage =
{ action : Maybe Action
, body : Maybe String
, data : Maybe MapOfString
, iconReference : Maybe String
, imageIconUrl : Maybe String
, imageUrl : Maybe String
, rawContent : Maybe String
, silentPush : Maybe Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, timeToLive : Maybe Int
, title : Maybe String
, url : Maybe String
}

The BaiduMessage data model.

type alias BaseKpiResult =
{ 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.

type alias CampaignEventFilter =
{ dimensions : EventDimensions
, filterType : FilterType
}

The CampaignEventFilter data model.

type alias CampaignHook =
{ lambdaFunctionName : Maybe String
, mode : Maybe Mode
, webUrl : Maybe String
}

The CampaignHook data model.

type alias CampaignLimits =
{ daily : Maybe Int
, maximumDuration : Maybe Int
, messagesPerSecond : Maybe Int
, total : Maybe Int
}

The CampaignLimits data model.

type alias CampaignResponse =
{ additionalTreatments : Maybe ListOfTreatmentResource
, applicationId : String
, arn : String
, creationDate : String
, defaultState : Maybe CampaignState
, description : Maybe String
, holdoutPercent : Maybe Int
, hook : Maybe CampaignHook
, id : String
, isPaused : Maybe Bool
, lastModifiedDate : String
, limits : Maybe CampaignLimits
, messageConfiguration : Maybe MessageConfiguration
, name : Maybe String
, schedule : Maybe Schedule
, segmentId : String
, segmentVersion : Int
, state : Maybe CampaignState
, treatmentDescription : Maybe String
, treatmentName : Maybe String
, version : Maybe Int
, tags : Maybe MapOfString
}

The CampaignResponse data model.

type alias CampaignSmsMessage =
{ body : Maybe String
, messageType : Maybe MessageType
, senderId : Maybe String
}

The CampaignSmsMessage data model.

type alias CampaignState =
{ campaignStatus : Maybe CampaignStatus }

The CampaignState data model.

= CampaignStatusScheduled
| CampaignStatusExecuting
| CampaignStatusPendingNextRun
| CampaignStatusCompleted
| CampaignStatusPaused
| CampaignStatusDeleted

The CampaignStatus data model.

type alias CampaignsResponse =
{ item : ListOfCampaignResponse
, nextToken : Maybe String
}

The CampaignsResponse data model.

type alias ChannelResponse =
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, version : Maybe Int
}

The ChannelResponse data model.

= ChannelTypeGcm
| ChannelTypeApns
| ChannelTypeApnsSandbox
| ChannelTypeApnsVoip
| ChannelTypeApnsVoipSandbox
| ChannelTypeAdm
| ChannelTypeSms
| ChannelTypeVoice
| ChannelTypeEmail
| ChannelTypeBaidu
| ChannelTypeCustom

The ChannelType data model.

type alias ChannelsResponse =
{ channels : MapOfChannelResponse }

The ChannelsResponse data model.

type alias CreateAppRequest =
{ createApplicationRequest : CreateApplicationRequest }

The CreateAppRequest data model.

type alias CreateAppResponse =
{ 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.

type alias DefaultMessage =
{ body : Maybe String
, substitutions : Maybe MapOfListOfString
}

The DefaultMessage data model.

{ action : Maybe Action
, body : Maybe String
, data : Maybe MapOfString
, silentPush : Maybe 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.

type alias DeleteAppRequest =
{ applicationId : String }

The DeleteAppRequest data model.

type alias DeleteAppResponse =
{ 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.

= DeliveryStatusSuccessful
| DeliveryStatusThrottled
| DeliveryStatusTemporaryFailure
| DeliveryStatusPermanentFailure
| DeliveryStatusUnknownFailure
| DeliveryStatusOptOut
| DeliveryStatusDuplicate

The DeliveryStatus data model.

= DimensionTypeInclusive
| DimensionTypeExclusive

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.

= DurationHr24
| DurationDay7
| DurationDay14
| DurationDay30

The Duration data model.

type alias EmailChannelRequest =
{ configurationSet : Maybe String
, enabled : Maybe Bool
, fromAddress : String
, identity : String
, roleArn : Maybe String
}

The EmailChannelRequest data model.

{ applicationId : Maybe String
, configurationSet : Maybe String
, creationDate : Maybe String
, enabled : Maybe Bool
, fromAddress : Maybe String
, hasCredential : Maybe Bool
, id : Maybe String
, identity : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, messagesPerSecond : Maybe Int
, platform : String
, roleArn : Maybe String
, version : Maybe Int
}

The EmailChannelResponse data model.

type alias EmailMessage =
{ 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.

type alias EndpointBatchItem =
{ 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.

type alias EndpointDemographic =
{ 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 Int
}

The EndpointItemResponse data model.

type alias EndpointLocation =
{ city : Maybe String
, country : Maybe String
, latitude : Maybe Float
, longitude : Maybe Float
, postalCode : Maybe String
, region : Maybe String
}

The EndpointLocation data model.

{ address : Maybe String
, deliveryStatus : DeliveryStatus
, messageId : Maybe String
, statusCode : Int
, statusMessage : Maybe String
, updatedToken : Maybe String
}

The EndpointMessageResult data model.

type alias EndpointRequest =
{ 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.

type alias EndpointResponse =
{ 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.

type alias EndpointUser =
{ userAttributes : Maybe MapOfListOfString
, userId : Maybe String
}

The EndpointUser data model.

type alias EndpointsResponse =
{ item : ListOfEndpointResponse }

The EndpointsResponse data model.

type alias Event =
{ 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.

type alias EventDimensions =
{ attributes : Maybe MapOfAttributeDimension
, eventType : Maybe SetDimension
, metrics : Maybe MapOfMetricDimension
}

The EventDimensions data model.

type alias EventItemResponse =
{ message : Maybe String
, statusCode : Maybe Int
}

The EventItemResponse data model.

type alias EventStream =
{ applicationId : String
, destinationStreamArn : String
, externalId : Maybe String
, lastModifiedDate : Maybe String
, lastUpdatedBy : Maybe String
, roleArn : String
}

The EventStream data model.

type alias EventsBatch =
{ endpoint : PublicEndpoint
, events : MapOfEvent
}

The EventsBatch data model.

type alias EventsRequest =
{ batchItem : MapOfEventsBatch }

The EventsRequest data model.

type alias EventsResponse =
{ results : Maybe MapOfItemResponse }

The EventsResponse data model.

type alias ExportJobRequest =
{ roleArn : String
, s3UrlPrefix : String
, segmentId : Maybe String
, segmentVersion : Maybe Int
}

The ExportJobRequest data model.

type alias ExportJobResource =
{ roleArn : String
, s3UrlPrefix : String
, segmentId : Maybe String
, segmentVersion : Maybe Int
}

The ExportJobResource data model.

type alias ExportJobResponse =
{ applicationId : String
, completedPieces : Maybe Int
, completionDate : Maybe String
, creationDate : String
, definition : ExportJobResource
, failedPieces : Maybe Int
, failures : Maybe ListOfString
, id : String
, jobStatus : JobStatus
, totalFailures : Maybe Int
, totalPieces : Maybe Int
, totalProcessed : Maybe Int
, type_ : String
}

The ExportJobResponse data model.

type alias ExportJobsResponse =
{ item : ListOfExportJobResponse
, nextToken : Maybe String
}

The ExportJobsResponse data model.

= FilterTypeSystem
| FilterTypeEndpoint

The FilterType data model.

type Format
= FormatCsv
| FormatJson

The Format data model.

= FrequencyOnce
| FrequencyHourly
| FrequencyDaily
| FrequencyWeekly
| FrequencyMonthly
| FrequencyEvent

The Frequency data model.

type alias GcmchannelRequest =
{ apiKey : String
, enabled : Maybe Bool
}

The GcmchannelRequest data model.

type alias GcmchannelResponse =
{ applicationId : Maybe String
, creationDate : Maybe String
, credential : String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The GcmchannelResponse data model.

type alias Gcmmessage =
{ 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 Bool
, smallImageIconUrl : Maybe String
, sound : Maybe String
, substitutions : Maybe MapOfListOfString
, timeToLive : Maybe 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.

type alias GetAppRequest =
{ applicationId : String }

The GetAppRequest data model.

type alias GetAppResponse =
{ 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.

type alias GetAppsRequest =
{ pageSize : Maybe String
, token : Maybe String
}

The GetAppsRequest data model.

type alias GetAppsResponse =
{ 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.

type alias GetCampaignRequest =
{ applicationId : String
, campaignId : String
}

The GetCampaignRequest data model.

type alias GetCampaignResponse =
{ 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.

type alias GetCampaignsRequest =
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}

The GetCampaignsRequest data model.

{ campaignsResponse : CampaignsResponse }

The GetCampaignsResponse data model.

type alias GetChannelsRequest =
{ applicationId : String }

The GetChannelsRequest data model.

type alias GetChannelsResponse =
{ channelsResponse : ChannelsResponse }

The GetChannelsResponse data model.

{ applicationId : String }

The GetEmailChannelRequest data model.

{ emailChannelResponse : EmailChannelResponse }

The GetEmailChannelResponse data model.

type alias GetEndpointRequest =
{ applicationId : String
, endpointId : String
}

The GetEndpointRequest data model.

type alias GetEndpointResponse =
{ endpointResponse : EndpointResponse }

The GetEndpointResponse data model.

{ applicationId : String }

The GetEventStreamRequest data model.

{ eventStream : EventStream }

The GetEventStreamResponse data model.

type alias GetExportJobRequest =
{ 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.

type alias GetImportJobRequest =
{ 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.

type alias GetSegmentRequest =
{ applicationId : String
, segmentId : String
}

The GetSegmentRequest data model.

type alias GetSegmentResponse =
{ 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.

type alias GetSegmentsRequest =
{ applicationId : String
, pageSize : Maybe String
, token : Maybe String
}

The GetSegmentsRequest data model.

type alias GetSegmentsResponse =
{ 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.

type alias Gpscoordinates =
{ latitude : Float
, longitude : Float
}

The Gpscoordinates data model.

type alias GpspointDimension =
{ coordinates : Gpscoordinates
, rangeInKilometers : Maybe Float
}

The GpspointDimension data model.

type alias ImportJobRequest =
{ defineSegment : Maybe Bool
, externalId : Maybe String
, format : Format
, registerEndpoints : Maybe Bool
, roleArn : String
, s3Url : String
, segmentId : Maybe String
, segmentName : Maybe String
}

The ImportJobRequest data model.

type alias ImportJobResource =
{ defineSegment : Maybe Bool
, externalId : Maybe String
, format : Format
, registerEndpoints : Maybe Bool
, roleArn : String
, s3Url : String
, segmentId : Maybe String
, segmentName : Maybe String
}

The ImportJobResource data model.

type alias ImportJobResponse =
{ applicationId : String
, completedPieces : Maybe Int
, completionDate : Maybe String
, creationDate : String
, definition : ImportJobResource
, failedPieces : Maybe Int
, failures : Maybe ListOfString
, id : String
, jobStatus : JobStatus
, totalFailures : Maybe Int
, totalPieces : Maybe Int
, totalProcessed : Maybe Int
, type_ : String
}

The ImportJobResponse data model.

type alias ImportJobsResponse =
{ item : ListOfImportJobResponse
, nextToken : Maybe String
}

The ImportJobsResponse data model.

type Include
= IncludeAll
| IncludeAny
| IncludeNone

The Include data model.

type alias ItemResponse =
{ endpointItemResponse : Maybe EndpointItemResponse
, eventsItemResponse : Maybe MapOfEventItemResponse
}

The ItemResponse data model.

= JobStatusCreated
| JobStatusInitializing
| JobStatusProcessing
| JobStatusCompleting
| JobStatusCompleted
| JobStatusFailing
| JobStatusFailed

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.

type alias ListOfResultRow =
List ResultRow

The ListOfResultRow data model.

List ResultRowValue

The ListOfResultRowValue data model.

List SegmentDimensions

The ListOfSegmentDimensions data model.

type alias ListOfSegmentGroup =
List SegmentGroup

The ListOfSegmentGroup data model.

List SegmentReference

The ListOfSegmentReference data model.

List SegmentResponse

The ListOfSegmentResponse data model.

type alias ListOfString =
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.

type alias MapOfDouble =
Dict String Float

The MapOfDouble data model.

Dict String EndpointMessageResult

The MapOfEndpointMessageResult data model.

Dict String EndpointSendConfiguration

The MapOfEndpointSendConfiguration data model.

type alias MapOfEvent =
Dict String Event

The MapOfEvent data model.

Dict String EventItemResponse

The MapOfEventItemResponse data model.

type alias MapOfEventsBatch =
Dict String EventsBatch

The MapOfEventsBatch data model.

type alias MapOfInteger =
Dict String Int

The MapOfInteger data model.

type alias MapOfItemResponse =
Dict String ItemResponse

The MapOfItemResponse data model.

type alias MapOfListOfString =
Dict String ListOfString

The MapOfListOfString data model.

Dict String MapOfEndpointMessageResult

The MapOfMapOfEndpointMessageResult data model.

type alias MapOfMessageResult =
Dict String MessageResult

The MapOfMessageResult data model.

Dict String MetricDimension

The MapOfMetricDimension data model.

type alias MapOfString =
Dict String String

The MapOfString data model.

type alias Message =
{ 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 Bool
, timeToLive : Maybe Int
, title : Maybe String
, url : Maybe String
}

The Message data model.

type alias MessageBody =
{ 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.

type alias MessageRequest =
{ addresses : Maybe MapOfAddressConfiguration
, context : Maybe MapOfString
, endpoints : Maybe MapOfEndpointSendConfiguration
, messageConfiguration : DirectMessageConfiguration
, traceId : Maybe String
}

The MessageRequest data model.

type alias MessageResponse =
{ applicationId : String
, endpointResult : Maybe MapOfEndpointMessageResult
, requestId : Maybe String
, result : Maybe MapOfMessageResult
}

The MessageResponse data model.

type alias MessageResult =
{ deliveryStatus : DeliveryStatus
, messageId : Maybe String
, statusCode : Int
, statusMessage : Maybe String
, updatedToken : Maybe String
}

The MessageResult data model.

= MessageTypeTransactional
| MessageTypePromotional

The MessageType data model.

type alias MetricDimension =
{ comparisonOperator : String
, value : Float
}

The MetricDimension data model.

type Mode
= ModeDelivery
| ModeFilter

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 Int
, timezone : Maybe String
, zipCode : Maybe String
}

The NumberValidateResponse data model.

{ numberValidateRequest : NumberValidateRequest }

The PhoneNumberValidateRequest data model.

{ numberValidateResponse : NumberValidateResponse }

The PhoneNumberValidateResponse data model.

type alias PublicEndpoint =
{ 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.

type alias PutEventsRequest =
{ applicationId : String
, eventsRequest : EventsRequest
}

The PutEventsRequest data model.

type alias PutEventsResponse =
{ eventsResponse : EventsResponse }

The PutEventsResponse data model.

type alias QuietTime =
{ end : Maybe String
, start : Maybe String
}

The QuietTime data model.

type alias RawEmail =
{ data : Maybe String }

The RawEmail data model.

type alias RecencyDimension =
{ duration : Duration
, recencyType : RecencyType
}

The RecencyDimension data model.

= RecencyTypeActive
| RecencyTypeInactive

The RecencyType data model.

{ applicationId : String
, attributeType : String
, updateAttributesRequest : UpdateAttributesRequest
}

The RemoveAttributesRequest data model.

{ attributesResource : AttributesResource }

The RemoveAttributesResponse data model.

type alias ResultRow =
{ groupedBys : ListOfResultRowValue
, values : ListOfResultRowValue
}

The ResultRow data model.

type alias ResultRowValue =
{ key : String
, type_ : String
, value : String
}

The ResultRowValue data model.

type alias Schedule =
{ endTime : Maybe String
, eventFilter : Maybe CampaignEventFilter
, frequency : Maybe Frequency
, isLocalTime : Maybe Bool
, quietTime : Maybe QuietTime
, startTime : String
, timezone : Maybe String
}

The Schedule data model.

type alias SegmentBehaviors =
{ recency : Maybe RecencyDimension }

The SegmentBehaviors data model.

type alias SegmentDemographics =
{ appVersion : Maybe SetDimension
, channel : Maybe SetDimension
, deviceType : Maybe SetDimension
, make : Maybe SetDimension
, model : Maybe SetDimension
, platform : Maybe SetDimension
}

The SegmentDemographics data model.

type alias SegmentDimensions =
{ attributes : Maybe MapOfAttributeDimension
, behavior : Maybe SegmentBehaviors
, demographic : Maybe SegmentDemographics
, location : Maybe SegmentLocation
, metrics : Maybe MapOfMetricDimension
, userAttributes : Maybe MapOfAttributeDimension
}

The SegmentDimensions data model.

type alias SegmentGroup =
{ dimensions : Maybe ListOfSegmentDimensions
, sourceSegments : Maybe ListOfSegmentReference
, sourceType : Maybe SourceType
, type_ : Maybe Type
}

The SegmentGroup data model.

type alias SegmentGroupList =
{ groups : Maybe ListOfSegmentGroup
, include : Maybe Include
}

The SegmentGroupList data model.

{ channelCounts : Maybe MapOfInteger
, externalId : String
, format : Format
, roleArn : String
, s3Url : String
, size : Int
}

The SegmentImportResource data model.

type alias SegmentLocation =
{ country : Maybe SetDimension
, gpspoint : Maybe GpspointDimension
}

The SegmentLocation data model.

type alias SegmentReference =
{ id : String
, version : Maybe Int
}

The SegmentReference data model.

type alias SegmentResponse =
{ 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 Int
, tags : Maybe MapOfString
}

The SegmentResponse data model.

= SegmentTypeDimensional
| SegmentTypeImport

The SegmentType data model.

type alias SegmentsResponse =
{ item : ListOfSegmentResponse
, nextToken : Maybe String
}

The SegmentsResponse data model.

type alias SendMessagesRequest =
{ 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.

type alias Session =
{ duration : Maybe Int
, id : String
, startTimestamp : String
, stopTimestamp : Maybe String
}

The Session data model.

type alias SetDimension =
{ dimensionType : Maybe DimensionType
, values : ListOfString
}

The SetDimension data model.

type alias SimpleEmail =
{ htmlPart : Maybe SimpleEmailPart
, subject : Maybe SimpleEmailPart
, textPart : Maybe SimpleEmailPart
}

The SimpleEmail data model.

type alias SimpleEmailPart =
{ charset : Maybe String
, data : Maybe String
}

The SimpleEmailPart data model.

type alias SmschannelRequest =
{ enabled : Maybe Bool
, senderId : Maybe String
, shortCode : Maybe String
}

The SmschannelRequest data model.

type alias SmschannelResponse =
{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, promotionalMessagesPerSecond : Maybe Int
, senderId : Maybe String
, shortCode : Maybe String
, transactionalMessagesPerSecond : Maybe Int
, version : Maybe Int
}

The SmschannelResponse data model.

type alias Smsmessage =
{ body : Maybe String
, keyword : Maybe String
, messageType : Maybe MessageType
, originationNumber : Maybe String
, senderId : Maybe String
, substitutions : Maybe MapOfListOfString
}

The Smsmessage data model.

= SourceTypeAll
| SourceTypeAny
| SourceTypeNone

The SourceType data model.

type alias TagResourceRequest =
{ resourceArn : String
, tagsModel : TagsModel
}

The TagResourceRequest data model.

type alias TagsModel =
{ tags : MapOfString }

The TagsModel data model.

type alias TreatmentResource =
{ id : String
, messageConfiguration : Maybe MessageConfiguration
, schedule : Maybe Schedule
, sizePercent : Int
, state : Maybe CampaignState
, treatmentDescription : Maybe String
, treatmentName : Maybe String
}

The TreatmentResource data model.

type Type
= TypeAll
| TypeAny
| TypeNone

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.

type alias VoiceChannelRequest =
{ enabled : Maybe Bool }

The VoiceChannelRequest data model.

{ applicationId : Maybe String
, creationDate : Maybe String
, enabled : Maybe Bool
, hasCredential : Maybe Bool
, id : Maybe String
, isArchived : Maybe Bool
, lastModifiedBy : Maybe String
, lastModifiedDate : Maybe String
, platform : String
, version : Maybe Int
}

The VoiceChannelResponse data model.

type alias VoiceMessage =
{ body : Maybe String
, languageCode : Maybe String
, originationNumber : Maybe String
, substitutions : Maybe MapOfListOfString
, voiceId : Maybe String
}

The VoiceMessage data model.

{ campaignHook : Maybe CampaignHook
, cloudWatchMetricsEnabled : Maybe Bool
, limits : Maybe CampaignLimits
, quietTime : Maybe QuietTime
}

The WriteApplicationSettingsRequest data model.

{ additionalTreatments : Maybe ListOfWriteTreatmentResource
, description : Maybe String
, holdoutPercent : Maybe Int
, hook : Maybe CampaignHook
, isPaused : Maybe Bool
, limits : Maybe CampaignLimits
, messageConfiguration : Maybe MessageConfiguration
, name : Maybe String
, schedule : Maybe Schedule
, segmentId : Maybe String
, segmentVersion : Maybe Int
, treatmentDescription : Maybe String
, treatmentName : Maybe String
, tags : Maybe MapOfString
}

The WriteCampaignRequest data model.

type alias WriteEventStream =
{ destinationStreamArn : String
, roleArn : String
}

The WriteEventStream data model.

type alias WriteSegmentRequest =
{ dimensions : Maybe SegmentDimensions
, name : Maybe String
, segmentGroups : Maybe SegmentGroupList
, tags : Maybe MapOfString
}

The WriteSegmentRequest data model.

{ messageConfiguration : Maybe MessageConfiguration
, schedule : Maybe Schedule
, sizePercent : Int
, treatmentDescription : Maybe String
, treatmentName : Maybe String
}

The WriteTreatmentResource data model.

action : Enum Action

The Action data model.

The AttributeType data model.

The CampaignStatus data model.

The ChannelType data model.

The DeliveryStatus data model.

The DimensionType data model.

The Duration data model.

The FilterType data model.

format : Enum Format

The Format data model.

The Frequency data model.

The Include data model.

The JobStatus data model.

The MessageType data model.

mode : Enum Mode

The Mode data model.

The RecencyType data model.

The SegmentType data model.

The SourceType data model.

type_ : Enum Type

The Type data model.

Modules

About this package serverReroutesreroutes.json
Pages and docs rendering from package.elm-lang.org, © 2012-2020 Evan Czaplicki. © 2026 Lamdera