2017/06/08 - Amazon Pinpoint - 10 new 23 updated api methods
Changes Starting today Amazon Pinpoint adds SMS Text and Email Messaging support in addition to Mobile Push Notifications, providing developers, product managers and marketers with multi-channel messaging capabilities to drive user engagement in their applications. Pinpoint also enables backend services and applications to message users directly and provides advanced user and app analytics to understand user behavior and messaging performance.
Get an SMS channel
Request Syntax
client.get_sms_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'SenderId': 'string',
'ShortCode': 'string',
'Version': 123
}
}
Response Structure
(dict) --
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
Version (integer) -- Version of channel
Delete an email channel
Request Syntax
client.delete_email_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
(dict) --
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
Get an APNS sandbox channel
Request Syntax
client.get_apns_sandbox_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSSandboxChannelResponse (dict) -- Apple Development Push Notification Service channel definition.
ApplicationId (string) -- Application id
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
Update an APNS sandbox channel
Request Syntax
client.update_apns_sandbox_channel(
APNSSandboxChannelRequest={
'Certificate': 'string',
'Enabled': True|False,
'PrivateKey': 'string'
},
ApplicationId='string'
)
dict
[REQUIRED] Apple Development Push Notification Service channel definition.
Certificate (string) -- The distribution certificate from Apple.
Enabled (boolean) -- If the channel is enabled for sending messages.
PrivateKey (string) -- The certificate private key.
string
[REQUIRED]
dict
Response Syntax
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSSandboxChannelResponse (dict) -- Apple Development Push Notification Service channel definition.
ApplicationId (string) -- Application id
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
Update an email channel
Request Syntax
client.update_email_channel(
ApplicationId='string',
EmailChannelRequest={
'Enabled': True|False,
'FromAddress': 'string',
'Identity': 'string',
'RoleArn': 'string'
}
)
string
[REQUIRED]
dict
[REQUIRED] Email Channel Request
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
Identity (string) -- The ARN of an identity verified with SES.
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
(dict) --
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
Get an email channel
Request Syntax
client.get_email_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
(dict) --
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
Update an SMS channel
Request Syntax
client.update_sms_channel(
ApplicationId='string',
SMSChannelRequest={
'Enabled': True|False,
'SenderId': 'string'
}
)
string
[REQUIRED]
dict
[REQUIRED] SMS Channel Request
Enabled (boolean) -- If the channel is enabled for sending messages.
SenderId (string) -- Sender identifier of your messages.
dict
Response Syntax
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'SenderId': 'string',
'ShortCode': 'string',
'Version': 123
}
}
Response Structure
(dict) --
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
Version (integer) -- Version of channel
Send a batch of messages
Request Syntax
client.send_messages(
ApplicationId='string',
MessageRequest={
'Addresses': {
'string': {
'BodyOverride': 'string',
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'ADM'|'SMS'|'EMAIL',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'Context': {
'string': 'string'
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
}
}
}
}
)
string
[REQUIRED]
dict
[REQUIRED] Send message request.
Addresses (dict) -- A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
(string) --
(dict) -- Address configuration.
BodyOverride (string) -- Body override. If specified will override default body.
ChannelType (string) -- Type of channel of this address
Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
(string) --
(list) --
(string) --
TitleOverride (string) -- Title override. If specified will override default title if applicable.
Context (dict) -- A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
MessageConfiguration (dict) -- Message configuration.
APNSMessage (dict) -- The message to APNS channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Badge (integer) -- Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
Body (string) -- The message body of the notification, the email body or the text message.
Category (string) -- Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
MediaUrl (string) -- The URL that points to a video used in the push notification.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Sound (string) -- Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
ThreadId (string) -- Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Body (string) -- The message body of the notification, the email body or the text message.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
DefaultPushNotificationMessage (dict) -- The default push notification message for all push channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
GCMMessage (dict) -- The message to GCM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
CollapseKey (string) -- This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
RestrictedPackageName (string) -- This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The message to SMS channels. Overrides the default message.
Body (string) -- The message body of the notification, the email body or the text message.
MessageType (string) -- Is this a transaction priority message or lower priority.
SenderId (string) -- Sender ID of sent message.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
dict
Response Syntax
{
'MessageResponse': {
'ApplicationId': 'string',
'RequestId': 'string',
'Result': {
'string': {
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
Response Structure
(dict) --
MessageResponse (dict) -- Send message response.
ApplicationId (string) -- Application id of the message.
RequestId (string) -- Original request Id for which this message was delivered.
Result (dict) -- A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
(string) --
(dict) -- The result from sending a message to an address.
DeliveryStatus (string) -- Delivery status of message.
StatusCode (integer) -- Downstream service status code.
StatusMessage (string) -- Status message for message delivery.
UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)
Delete an APNS sandbox channel
Request Syntax
client.delete_apns_sandbox_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSSandboxChannelResponse (dict) -- Apple Development Push Notification Service channel definition.
ApplicationId (string) -- Application id
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
Delete an SMS channel
Request Syntax
client.delete_sms_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'SenderId': 'string',
'ShortCode': 'string',
'Version': 123
}
}
Response Structure
(dict) --
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- Application id
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
Version (integer) -- Version of channel
{'WriteCampaignRequest': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Creates or updates a campaign.
Request Syntax
client.create_campaign(
ApplicationId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED]
dict
[REQUIRED] Used to create a campaign.
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Used to create a campaign treatment.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'WriteSegmentRequest': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}}}
Response {'SegmentResponse': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}
Used to create or update a segment.
Request Syntax
client.create_segment(
ApplicationId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Name': 'string'
}
)
string
[REQUIRED]
dict
[REQUIRED] Segment definition.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Name (string) -- The name of segment
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) --
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'APNSChannelResponse': {'Enabled': 'boolean'}}
Deletes the APNs channel for an app.
Request Syntax
client.delete_apns_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSChannelResponse (dict) -- Apple Distribution Push Notification Service channel definition.
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Deletes a campaign.
Request Syntax
client.delete_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'GCMChannelResponse': {'Enabled': 'boolean'}}
Deletes the GCM channel for an app.
Request Syntax
client.delete_gcm_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
GCMChannelResponse (dict) -- Google Cloud Messaging channel definition
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Credential (string) -- The GCM API key from Google.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be GCM
Version (integer) -- Version of channel
{'SegmentResponse': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}
Deletes a segment.
Request Syntax
client.delete_segment(
ApplicationId='string',
SegmentId='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) --
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'APNSChannelResponse': {'Enabled': 'boolean'}}
Returns information about the APNs channel for an app.
Request Syntax
client.get_apns_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSChannelResponse (dict) -- Apple Distribution Push Notification Service channel definition.
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Returns information about a campaign.
Request Syntax
client.get_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Returns information about a specific version of a campaign.
Request Syntax
client.get_campaign_version(
ApplicationId='string',
CampaignId='string',
Version='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}}
Returns information about your campaign versions.
Request Syntax
client.get_campaign_versions(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
string
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
CampaignsResponse (dict) -- List of available campaigns.
Item (list) -- A list of campaigns.
(dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}}
Returns information about your campaigns.
Request Syntax
client.get_campaigns(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED]
string
string
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
CampaignsResponse (dict) -- List of available campaigns.
Item (list) -- A list of campaigns.
(dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'EndpointResponse': {'ChannelType': ['APNS_SANDBOX', 'ADM', 'SMS', 'EMAIL']}}
Returns information about an endpoint.
Request Syntax
client.get_endpoint(
ApplicationId='string',
EndpointId='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'EndpointResponse': {
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'ADM'|'SMS'|'EMAIL',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
},
'ShardId': 'string'
}
}
Response Structure
(dict) --
EndpointResponse (dict) -- Endpoint response
Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
ApplicationId (string) -- The ID of the application associated with the endpoint.
Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
(string) --
(list) --
(string) --
ChannelType (string) -- The channel type. Valid values: APNS, GCM
CohortId (string) -- A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
CreationDate (string) -- The last time the endpoint was created. Provided in ISO 8601 format.
Demographic (dict) -- The endpoint demographic attributes.
AppVersion (string) -- The version of the application associated with the endpoint.
Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Make (string) -- The endpoint make, such as such as Apple or Samsung.
Model (string) -- The endpoint model, such as iPhone.
ModelVersion (string) -- The endpoint model version.
Platform (string) -- The endpoint platform, such as ios or android.
PlatformVersion (string) -- The endpoint platform version.
Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
Id (string) -- The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
Location (dict) -- The endpoint location attributes.
City (string) -- The city where the endpoint is located.
Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
PostalCode (string) -- The postal code or zip code of the endpoint.
Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
(string) --
(float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
UserAttributes (dict) -- Custom attributes specific to the user.
(string) --
(list) --
(string) --
UserId (string) -- The unique ID of the user.
ShardId (string) -- The ShardId of endpoint
{'GCMChannelResponse': {'Enabled': 'boolean'}}
Returns information about the GCM channel for an app.
Request Syntax
client.get_gcm_channel(
ApplicationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
GCMChannelResponse (dict) -- Google Cloud Messaging channel definition
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Credential (string) -- The GCM API key from Google.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be GCM
Version (integer) -- Version of channel
{'SegmentResponse': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}
Returns information about a segment.
Request Syntax
client.get_segment(
ApplicationId='string',
SegmentId='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) --
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'SegmentResponse': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}
Returns information about a segment version.
Request Syntax
client.get_segment_version(
ApplicationId='string',
SegmentId='string',
Version='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) --
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'SegmentsResponse': {'Item': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}}
Returns information about your segment versions.
Request Syntax
client.get_segment_versions(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
string
[REQUIRED]
string
string
[REQUIRED]
string
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
SegmentsResponse (dict) -- Segments in your account.
Item (list) -- The list of segments.
(dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
{'SegmentsResponse': {'Item': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}}
Used to get information about your segments.
Request Syntax
client.get_segments(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED]
string
string
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
SegmentsResponse (dict) -- Segments in your account.
Item (list) -- The list of segments.
(dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
{'APNSChannelRequest': {'Enabled': 'boolean'}}
Response {'APNSChannelResponse': {'Enabled': 'boolean'}}
Use to update the APNs channel for an app.
Request Syntax
client.update_apns_channel(
APNSChannelRequest={
'Certificate': 'string',
'Enabled': True|False,
'PrivateKey': 'string'
},
ApplicationId='string'
)
dict
[REQUIRED] Apple Push Notification Service channel definition.
Certificate (string) -- The distribution certificate from Apple.
Enabled (boolean) -- If the channel is enabled for sending messages.
PrivateKey (string) -- The certificate private key.
string
[REQUIRED]
dict
Response Syntax
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
APNSChannelResponse (dict) -- Apple Distribution Push Notification Service channel definition.
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be APNS.
Version (integer) -- Version of channel
{'WriteCampaignRequest': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}},
'MessageConfiguration': {'APNSMessage': {'ImageSmallIconUrl': 'string'},
'DefaultMessage': {'ImageSmallIconUrl': 'string'},
'EmailMessage': {'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'},
'GCMMessage': {'ImageSmallIconUrl': 'string'},
'SMSMessage': {'Body': 'string',
'MessageType': 'TRANSACTIONAL '
'| '
'PROMOTIONAL',
'SenderId': 'string'}}}}
Use to update a campaign.
Request Syntax
client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED]
string
[REQUIRED]
dict
[REQUIRED] Used to create a campaign.
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Used to create a campaign treatment.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'Total': 123
},
'MessageConfiguration': {
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'SilentPush': True|False,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'EndpointRequest': {'ChannelType': ['APNS_SANDBOX', 'ADM', 'SMS', 'EMAIL']}}
Use to update an endpoint.
Request Syntax
client.update_endpoint(
ApplicationId='string',
EndpointId='string',
EndpointRequest={
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'ADM'|'SMS'|'EMAIL',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
)
string
[REQUIRED]
string
[REQUIRED]
dict
[REQUIRED] Endpoint update request
Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
(string) --
(list) --
(string) --
ChannelType (string) -- The channel type. Valid values: APNS, GCM
Demographic (dict) -- The endpoint demographic attributes.
AppVersion (string) -- The version of the application associated with the endpoint.
Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Make (string) -- The endpoint make, such as such as Apple or Samsung.
Model (string) -- The endpoint model, such as iPhone.
ModelVersion (string) -- The endpoint model version.
Platform (string) -- The endpoint platform, such as ios or android.
PlatformVersion (string) -- The endpoint platform version.
Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
Location (dict) -- The endpoint location attributes.
City (string) -- The city where the endpoint is located.
Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
PostalCode (string) -- The postal code or zip code of the endpoint.
Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
(string) --
(float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
UserAttributes (dict) -- Custom attributes specific to the user.
(string) --
(list) --
(string) --
UserId (string) -- The unique ID of the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
MessageBody (dict) -- Simple message object.
Message (string) -- The error message returned from the API.
RequestID (string) -- The unique message body ID.
{'EndpointBatchRequest': {'Item': {'ChannelType': ['APNS_SANDBOX',
'ADM',
'SMS',
'EMAIL']}}}
Use to update a batch of endpoints.
Request Syntax
client.update_endpoints_batch(
ApplicationId='string',
EndpointBatchRequest={
'Item': [
{
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'ADM'|'SMS'|'EMAIL',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
)
string
[REQUIRED]
dict
[REQUIRED] Endpoint batch update request.
Item (list) -- List of items to update. Maximum 100 items
(dict) -- Endpoint update request
Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
(string) --
(list) --
(string) --
ChannelType (string) -- The channel type. Valid values: APNS, GCM
Demographic (dict) -- The endpoint demographic attributes.
AppVersion (string) -- The version of the application associated with the endpoint.
Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Make (string) -- The endpoint make, such as such as Apple or Samsung.
Model (string) -- The endpoint model, such as iPhone.
ModelVersion (string) -- The endpoint model version.
Platform (string) -- The endpoint platform, such as ios or android.
PlatformVersion (string) -- The endpoint platform version.
Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
Id (string) -- The unique Id for the Endpoint in the batch.
Location (dict) -- The endpoint location attributes.
City (string) -- The city where the endpoint is located.
Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
PostalCode (string) -- The postal code or zip code of the endpoint.
Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
(string) --
(float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
UserAttributes (dict) -- Custom attributes specific to the user.
(string) --
(list) --
(string) --
UserId (string) -- The unique ID of the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
MessageBody (dict) -- Simple message object.
Message (string) -- The error message returned from the API.
RequestID (string) -- The unique message body ID.
{'GCMChannelRequest': {'Enabled': 'boolean'}}
Response {'GCMChannelResponse': {'Enabled': 'boolean'}}
Use to update the GCM channel for an app.
Request Syntax
client.update_gcm_channel(
ApplicationId='string',
GCMChannelRequest={
'ApiKey': 'string',
'Enabled': True|False
}
)
string
[REQUIRED]
dict
[REQUIRED] Google Cloud Messaging credentials
ApiKey (string) -- Platform credential API key from Google.
Enabled (boolean) -- If the channel is enabled for sending messages.
dict
Response Syntax
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
GCMChannelResponse (dict) -- Google Cloud Messaging channel definition
ApplicationId (string) -- The ID of the application to which the channel applies.
CreationDate (string) -- When was this segment created
Credential (string) -- The GCM API key from Google.
Enabled (boolean) -- If the channel is enabled for sending messages.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- The platform type. Will be GCM
Version (integer) -- Version of channel
{'WriteSegmentRequest': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}}}
Response {'SegmentResponse': {'Dimensions': {'Demographic': {'Channel': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}},
'ImportDefinition': {'ChannelCounts': {'string': 'integer'}}}}
Use to update a segment.
Request Syntax
client.update_segment(
ApplicationId='string',
SegmentId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Name': 'string'
}
)
string
[REQUIRED]
string
[REQUIRED]
dict
[REQUIRED] Segment definition.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Name (string) -- The name of segment
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) --
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.