2019/10/07 - Amazon Pinpoint - 13 new 9 updated api methods
Changes This release of the Amazon Pinpoint API introduces support for using and managing message templates.
Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
client.get_push_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'PushNotificationTemplateResponse': {
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Arn': 'string',
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'CreationDate': 'string',
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'LastModifiedDate': 'string',
'tags': {
'string': 'string'
},
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'PUSH'
}
}
Response Structure
(dict) --
The request succeeded.
PushNotificationTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
ADM (dict) --
The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
APNS (dict) --
The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
MediaUrl (string) --
The URL of an image or video to display in push notifications that are based on the message template.
Sound (string) --
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Baidu (dict) --
The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
CreationDate (string) --
The date when the message template was created.
Default (dict) --
The default message template that's used for push notification channels.
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
GCM (dict) --
The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
LastModifiedDate (string) --
The date when the message template was last modified.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
client.get_sms_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'SMSTemplateResponse': {
'Arn': 'string',
'Body': 'string',
'CreationDate': 'string',
'LastModifiedDate': 'string',
'tags': {
'string': 'string'
},
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'PUSH'
}
}
Response Structure
(dict) --
The request succeeded.
SMSTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Body (string) --
The message body that's used in text messages that are based on the message template.
CreationDate (string) --
The date when the message template was created.
LastModifiedDate (string) --
The date when the message template was last modified.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For an SMS template, this value is SMS.
Deletes a message template that was designed for use in messages that were sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
client.delete_sms_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Creates a message template that you can use in messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
client.create_email_template(
EmailTemplateRequest={
'HtmlPart': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TextPart': 'string'
},
TemplateName='string'
)
dict
[REQUIRED]
Creates a new message template that you can use in messages that are sent through the email channel.
HtmlPart (string) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
Subject (string) --
The subject line, or title, to use in email messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TextPart (string) --
The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about an API request or response.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Updates an existing message template that you can use in messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
client.update_push_template(
PushNotificationTemplateRequest={
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'tags': {
'string': 'string'
}
},
TemplateName='string'
)
dict
[REQUIRED]
Updates an existing message template that you can use in messages that are sent through a push notification channel.
ADM (dict) --
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
APNS (dict) --
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
MediaUrl (string) --
The URL of an image or video to display in push notifications that are based on the message template.
Sound (string) --
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
Baidu (dict) --
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
Default (dict) --
The default message template to use for push notification channels.
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
GCM (dict) --
The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Creates a message template that you can use in messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
client.create_sms_template(
SMSTemplateRequest={
'Body': 'string',
'tags': {
'string': 'string'
}
},
TemplateName='string'
)
dict
[REQUIRED]
Creates a message template that you can use in messages that are sent through the SMS channel.
Body (string) --
The message body to use in text messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about an API request or response.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Deletes a message template that was designed for use in messages that were sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
client.delete_push_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Creates a message template that you can use in messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
client.create_push_template(
PushNotificationTemplateRequest={
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'tags': {
'string': 'string'
}
},
TemplateName='string'
)
dict
[REQUIRED]
Creates a message template that you can use in messages that are sent through a push notification channel.
ADM (dict) --
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
APNS (dict) --
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
MediaUrl (string) --
The URL of an image or video to display in push notifications that are based on the message template.
Sound (string) --
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
Baidu (dict) --
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
Default (dict) --
The default message template to use for push notification channels.
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in push notifications that are based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
GCM (dict) --
The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about an API request or response.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
client.get_email_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'EmailTemplateResponse': {
'Arn': 'string',
'CreationDate': 'string',
'HtmlPart': 'string',
'LastModifiedDate': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'PUSH',
'TextPart': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
EmailTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
CreationDate (string) --
The date when the message template was created.
HtmlPart (string) --
The message body, in HTML format, that's used in email messages that are based on the message template.
LastModifiedDate (string) --
The date when the message template was last modified.
Subject (string) --
The subject line, or title, that's used in email messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
TextPart (string) --
The message body, in text format, that's used in email messages that are based on the message template.
Updates an existing message template that you can use in messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
client.update_email_template(
EmailTemplateRequest={
'HtmlPart': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TextPart': 'string'
},
TemplateName='string'
)
dict
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
HtmlPart (string) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
Subject (string) --
The subject line, or title, to use in email messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TextPart (string) --
The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
See also: AWS API Documentation
Request Syntax
client.list_templates(
NextToken='string',
PageSize='string',
Prefix='string',
TemplateType='string'
)
string
The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
string
The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
string
The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
string
The type of message template to include in the results. Valid values are: EMAIL, SMS, and PUSH. To include all types of templates in the results, don't include this parameter in your request.
dict
Response Syntax
{
'TemplatesResponse': {
'Item': [
{
'Arn': 'string',
'CreationDate': 'string',
'LastModifiedDate': 'string',
'tags': {
'string': 'string'
},
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'PUSH'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
TemplatesResponse (dict) --
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
Item (list) --
An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
(dict) --
Provides information about a message template that's associated with your Amazon Pinpoint account.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
CreationDate (string) --
The date when the message template was created.
LastModifiedDate (string) --
The date when the message template was last modified.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Deletes a message template that was designed for use in messages that were sent through the email channel.
See also: AWS API Documentation
Request Syntax
client.delete_email_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Updates an existing message template that you can use in messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
client.update_sms_template(
SMSTemplateRequest={
'Body': 'string',
'tags': {
'string': 'string'
}
},
TemplateName='string'
)
dict
[REQUIRED]
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
Body (string) --
The message body to use in text messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
string
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
{'WriteCampaignRequest': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
See also: AWS API Documentation
Request Syntax
client.create_campaign(
ApplicationId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
[REQUIRED]
Specifies the configuration and other settings for a campaign.
AdditionalTreatments (list) --
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) -- [REQUIRED]
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) -- [REQUIRED]
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) -- [REQUIRED]
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) -- [REQUIRED]
The value to compare.
FilterType (string) -- [REQUIRED]
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) -- [REQUIRED]
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) -- [REQUIRED]
The allocated percentage of users (segment members) to send the treatment to.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
IsPaused (boolean) --
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) -- [REQUIRED]
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The custom name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) -- [REQUIRED]
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) -- [REQUIRED]
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) -- [REQUIRED]
The value to compare.
FilterType (string) -- [REQUIRED]
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) -- [REQUIRED]
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment to associate with the campaign.
SegmentVersion (integer) --
The version of the segment to associate with the campaign.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign to use for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign to use for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignResponse': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Deletes a campaign from an application.
See also: AWS API Documentation
Request Syntax
client.delete_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignResponse': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Retrieves information about the status, configuration, and other settings for a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignResponse': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign_version(
ApplicationId='string',
CampaignId='string',
Version='string'
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
string
[REQUIRED]
The unique version number (Version property) for the campaign version.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}}
Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign_versions(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
string
The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
string
The NextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}}
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
See also: AWS API Documentation
Request Syntax
client.get_campaigns(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.
string
The NextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
{'MessageRequest': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Creates and sends a direct message.
See also: AWS API Documentation
Request Syntax
client.send_messages(
ApplicationId='string',
MessageRequest={
'Addresses': {
'string': {
'BodyOverride': 'string',
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'Context': {
'string': 'string'
},
'Endpoints': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'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'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TraceId': 'string'
}
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
[REQUIRED]
Specifies the objects that define configuration and other settings for a message.
Addresses (dict) --
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
(string) --
(dict) --
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
BodyOverride (string) --
The message body to use instead of the default message body. This value overrides the default message body.
ChannelType (string) --
The channel to use when sending the message.
Context (dict) --
An object that maps custom attributes to attributes for the address and is attached to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
(string) --
(string) --
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
Substitutions (dict) --
An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
(string) --
(list) --
(string) --
TitleOverride (string) --
The message title to use instead of the default message title. This value overrides the default message title.
Context (dict) --
A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
(string) --
(string) --
Endpoints (dict) --
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
(string) --
(dict) --
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
BodyOverride (string) --
The body of the message. If specified, this value overrides the default message body.
Context (dict) --
A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
(string) --
(string) --
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
Substitutions (dict) --
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
(string) --
(list) --
(string) --
TitleOverride (string) --
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
MessageConfiguration (dict) -- [REQUIRED]
The set of properties that defines the configuration settings for the message.
ADMMessage (dict) --
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
ConsolidationKey (string) --
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
ExpiresAfter (string) --
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
MD5 (string) --
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Badge (integer) --
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
Body (string) --
The body of the notification message.
Category (string) --
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
CollapseId (string) --
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
Data (dict) --
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
MediaUrl (string) --
The URL of an image or video to display in the push notification.
PreferredAuthenticationMethod (string) --
The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
Priority (string) --
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem> * 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
Sound (string) --
The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Substitutions (dict) --
The default message variables to use in the notification message. You can override these default variables with individual address variables.
(string) --
(list) --
(string) --
ThreadId (string) --
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
TimeToLive (integer) --
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
TimeToLive (integer) --
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message body for all channels.
Body (string) --
The default message body of the push notification, email, or SMS message.
Substitutions (dict) --
The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.
(string) --
(list) --
(string) --
DefaultPushNotificationMessage (dict) --
The default push notification message for all push notification channels.
Action (string) --
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The default body of the notification message.
Data (dict) --
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
SilentPush (boolean) --
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
Title (string) --
The default title to display above the notification message on a recipient's device.
Url (string) --
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The default message for the email channel. This message overrides the default message (DefaultMessage).
Body (string) --
The body of the email message.
FeedbackForwardingAddress (string) --
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
FromAddress (string) --
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
RawEmail (dict) --
The email message, represented as a raw MIME message.
Data (bytes) --
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
ReplyToAddresses (list) --
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
(string) --
SimpleEmail (dict) --
The email message, composed of a subject, a text part, and an HTML part.
HtmlPart (dict) --
The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
Subject (dict) --
The subject line, or title, of the email.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
TextPart (dict) --
The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
Substitutions (dict) --
The default message variables to use in the email message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
GCMMessage (dict) --
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
CollapseKey (string) --
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
Priority (string) --
para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem> * high - The notification is sent immediately and might wake a sleeping device. /para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
RestrictedPackageName (string) --
The package name of the application where registration tokens must match in order for the recipient to receive the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
TimeToLive (integer) --
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
Body (string) --
The body of the SMS message.
Keyword (string) --
The SMS program name that you provided to AWS Support when you requested your dedicated number.
MessageType (string) --
The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
OriginationNumber (string) --
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
Substitutions (dict) --
The message variables to use in the SMS message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
VoiceMessage (dict) --
The default message for the voice channel. This message overrides the default message (DefaultMessage).
Body (string) --
The text script for the voice message.
LanguageCode (string) --
The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
OriginationNumber (string) --
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
Substitutions (dict) --
The default message variables to use in the voice message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
VoiceId (string) --
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
TemplateConfiguration (dict) --
The message template to use for the message.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TraceId (string) --
The unique identifier for tracing the message. This identifier is visible to message recipients.
dict
Response Syntax
{
'MessageResponse': {
'ApplicationId': 'string',
'EndpointResult': {
'string': {
'Address': 'string',
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
},
'RequestId': 'string',
'Result': {
'string': {
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
Response Structure
(dict) --
The request succeeded.
MessageResponse (dict) --
Provides information about the results of a request to send a message to an endpoint address.
ApplicationId (string) --
The unique identifier for the application that was used to send the message.
EndpointResult (dict) --
A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
(string) --
(dict) --
Provides information about the delivery status and results of sending a message directly to an endpoint.
Address (string) --
The endpoint address that the message was delivered to.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
RequestId (string) --
The identifier for the original request that the message was delivered for.
Result (dict) --
A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
(string) --
(dict) --
Provides information about the results of sending a message directly to an endpoint address.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
{'SendUsersMessageRequest': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Creates and sends a message to a list of users.
See also: AWS API Documentation
Request Syntax
client.send_users_messages(
ApplicationId='string',
SendUsersMessageRequest={
'Context': {
'string': 'string'
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'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'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TraceId': 'string',
'Users': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
}
}
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
[REQUIRED]
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
Context (dict) --
A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
(string) --
(string) --
MessageConfiguration (dict) -- [REQUIRED]
The message definitions for the default message and any default messages that you defined for specific channels.
ADMMessage (dict) --
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
ConsolidationKey (string) --
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
ExpiresAfter (string) --
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
MD5 (string) --
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Badge (integer) --
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
Body (string) --
The body of the notification message.
Category (string) --
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
CollapseId (string) --
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
Data (dict) --
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
MediaUrl (string) --
The URL of an image or video to display in the push notification.
PreferredAuthenticationMethod (string) --
The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
Priority (string) --
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem> * 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
Sound (string) --
The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Substitutions (dict) --
The default message variables to use in the notification message. You can override these default variables with individual address variables.
(string) --
(list) --
(string) --
ThreadId (string) --
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
TimeToLive (integer) --
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
TimeToLive (integer) --
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message body for all channels.
Body (string) --
The default message body of the push notification, email, or SMS message.
Substitutions (dict) --
The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.
(string) --
(list) --
(string) --
DefaultPushNotificationMessage (dict) --
The default push notification message for all push notification channels.
Action (string) --
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The default body of the notification message.
Data (dict) --
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
SilentPush (boolean) --
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
Title (string) --
The default title to display above the notification message on a recipient's device.
Url (string) --
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The default message for the email channel. This message overrides the default message (DefaultMessage).
Body (string) --
The body of the email message.
FeedbackForwardingAddress (string) --
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
FromAddress (string) --
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
RawEmail (dict) --
The email message, represented as a raw MIME message.
Data (bytes) --
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
ReplyToAddresses (list) --
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
(string) --
SimpleEmail (dict) --
The email message, composed of a subject, a text part, and an HTML part.
HtmlPart (dict) --
The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
Subject (dict) --
The subject line, or title, of the email.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
TextPart (dict) --
The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
Charset (string) --
The applicable character set for the message content.
Data (string) --
The textual data of the message content.
Substitutions (dict) --
The default message variables to use in the email message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
GCMMessage (dict) --
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
Action (string) --
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message.
CollapseKey (string) --
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
Data (dict) --
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
(string) --
(string) --
IconReference (string) --
The icon image name of the asset saved in your app.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of the push notification.
ImageUrl (string) --
The URL of an image to display in the push notification.
Priority (string) --
para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem> * high - The notification is sent immediately and might wake a sleeping device. /para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
RestrictedPackageName (string) --
The package name of the application where registration tokens must match in order for the recipient to receive the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound (string) --
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions (dict) --
The default message variables to use in the notification message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
TimeToLive (integer) --
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
Title (string) --
The title to display above the notification message on the recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
Body (string) --
The body of the SMS message.
Keyword (string) --
The SMS program name that you provided to AWS Support when you requested your dedicated number.
MessageType (string) --
The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
OriginationNumber (string) --
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
Substitutions (dict) --
The message variables to use in the SMS message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
VoiceMessage (dict) --
The default message for the voice channel. This message overrides the default message (DefaultMessage).
Body (string) --
The text script for the voice message.
LanguageCode (string) --
The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
OriginationNumber (string) --
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
Substitutions (dict) --
The default message variables to use in the voice message. You can override the default variables with individual address variables.
(string) --
(list) --
(string) --
VoiceId (string) --
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
TemplateConfiguration (dict) --
The message template to use for the message.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TraceId (string) --
The unique identifier for tracing the message. This identifier is visible to message recipients.
Users (dict) -- [REQUIRED]
A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
(string) --
(dict) --
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
BodyOverride (string) --
The body of the message. If specified, this value overrides the default message body.
Context (dict) --
A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
(string) --
(string) --
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
Substitutions (dict) --
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
(string) --
(list) --
(string) --
TitleOverride (string) --
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
dict
Response Syntax
{
'SendUsersMessageResponse': {
'ApplicationId': 'string',
'RequestId': 'string',
'Result': {
'string': {
'string': {
'Address': 'string',
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
}
Response Structure
(dict) --
The request succeeded.
SendUsersMessageResponse (dict) --
Provides information about which users and endpoints a message was sent to.
ApplicationId (string) --
The unique identifier for the application that was used to send the message.
RequestId (string) --
The unique identifier that was assigned to the message request.
Result (dict) --
An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
(string) --
(dict) --
(string) --
(dict) --
Provides information about the delivery status and results of sending a message directly to an endpoint.
Address (string) --
The endpoint address that the message was delivered to.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
{'WriteCampaignRequest': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}},
'TemplateConfiguration': {'EmailTemplate': {'Name': 'string'},
'PushTemplate': {'Name': 'string'},
'SMSTemplate': {'Name': 'string'}}}}
Updates the settings for a campaign.
See also: AWS API Documentation
Request Syntax
client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
dict
[REQUIRED]
Specifies the configuration and other settings for a campaign.
AdditionalTreatments (list) --
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) -- [REQUIRED]
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) -- [REQUIRED]
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) -- [REQUIRED]
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) -- [REQUIRED]
The value to compare.
FilterType (string) -- [REQUIRED]
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) -- [REQUIRED]
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) -- [REQUIRED]
The allocated percentage of users (segment members) to send the treatment to.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
IsPaused (boolean) --
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) -- [REQUIRED]
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The custom name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) -- [REQUIRED]
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) -- [REQUIRED]
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) -- [REQUIRED]
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) -- [REQUIRED]
The value to compare.
FilterType (string) -- [REQUIRED]
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) -- [REQUIRED]
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment to associate with the campaign.
SegmentVersion (integer) --
The version of the segment to associate with the campaign.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign to use for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign to use for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'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'|'DELETED'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string'
},
'PushTemplate': {
'Name': 'string'
},
'SMSTemplate': {
'Name': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string) --
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
(string) --
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, 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, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
(string) --
(string) --
TemplateConfiguration (dict) --
Specifies the message template to use for the message, for each type of channel.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.