2021/02/23 - Amazon Pinpoint - 15 updated api methods
Changes Enables AWS Pinpoint customers to use Entity Id and Template Id when sending SMS message. These parameters can be obtained from the regulatory body of the country where you are trying to send the SMS.
{'WriteCampaignRequest': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) -- [REQUIRED]
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
A custom description of the treatment.
TreatmentName (string) --
A custom name for the treatment.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
DeliveryUri (string) -- [REQUIRED]
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
Description (string) --
A 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 invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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 changing 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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
A custom name for the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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) --
The message template to use for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
A custom description of the default treatment for the campaign.
TreatmentName (string) --
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'WriteJourneyRequest': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Response {'JourneyResponse': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Creates a journey for an application.
See also: AWS API Documentation
Request Syntax
client.create_journey(
ApplicationId='string',
WriteJourneyRequest={
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'CreationDate': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'
}
)
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 journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) -- [REQUIRED]
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) -- [REQUIRED]
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) -- [REQUIRED]
The GPS coordinates to measure distance from.
Latitude (float) -- [REQUIRED]
The latitude coordinate of the location.
Longitude (float) -- [REQUIRED]
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) -- [REQUIRED]
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) -- [REQUIRED]
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) -- [REQUIRED]
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) -- [REQUIRED]
The GPS coordinates to measure distance from.
Latitude (float) -- [REQUIRED]
The latitude coordinate of the location.
Longitude (float) -- [REQUIRED]
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
Name (string) -- [REQUIRED]
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) -- [REQUIRED]
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
State (string) --
The status of the journey. Valid values are:
DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey Stateresource.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'JourneyResponse': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Deletes a journey from an application.
See also: AWS API Documentation
Request Syntax
client.delete_journey(
ApplicationId='string',
JourneyId='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 journey.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Retrieves information about the status, configuration, and other settings for all versions of a 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 not supported for application, campaign, and journey metrics.
string
The NextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a 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': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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 not supported for application, campaign, and journey metrics.
string
The NextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a 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.
{'JourneyResponse': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Retrieves information about the status, configuration, and other settings for a journey.
See also: AWS API Documentation
Request Syntax
client.get_journey(
ApplicationId='string',
JourneyId='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 journey.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --
{'JourneysResponse': {'Item': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}}
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
See also: AWS API Documentation
Request Syntax
client.list_journeys(
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 not supported for application, campaign, and journey metrics.
string
The NextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'JourneysResponse': {
'Item': [
{
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
JourneysResponse (dict) --
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Item (list) --
An array of responses, one for each journey that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --
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': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': 'PUSH'|'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': {
'APNSPushType': 'string',
'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',
'MediaUrl': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
},
'EntityId': 'string',
'TemplateId': 'string'
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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 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. Attribute names are case sensitive.
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 all other values for the message.
Substitutions (dict) --
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
(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. Attribute names are case sensitive.
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 all other values for 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 settings and content 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. If specified, this value overrides all other content 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 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).
APNSPushType (string) --
The type of push notification to send. Valid values are:
alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an appβs complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
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 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. If specified, this value overrides all other content for 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. If specified, this value overrides all other content 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 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 for all channels.
Body (string) --
The default body of the message.
Substitutions (dict) --
The default message variables to use in the 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 HTML format for email clients that render HTML content. 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 plain text format. We recommend using plain text format for email clients that don't render HTML content 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. If specified, this value overrides all other content for 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.
MediaUrl (string) --
This field is reserved for future use.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
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) --
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
VoiceMessage (dict) --
The default message for the voice channel. This message overrides the default message (DefaultMessage).
Body (string) --
The text of the script to use for the voice message.
LanguageCode (string) --
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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 won't attempt to send the message again.
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 won't attempt to send the message again.
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': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': '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': {
'APNSPushType': 'string',
'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',
'MediaUrl': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
},
'EntityId': 'string',
'TemplateId': 'string'
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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 settings and content 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. If specified, this value overrides all other content 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 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).
APNSPushType (string) --
The type of push notification to send. Valid values are:
alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an appβs complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
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 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. If specified, this value overrides all other content for 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. If specified, this value overrides all other content 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 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 for all channels.
Body (string) --
The default body of the message.
Substitutions (dict) --
The default message variables to use in the 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 HTML format for email clients that render HTML content. 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 plain text format. We recommend using plain text format for email clients that don't render HTML content 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. If specified, this value overrides all other content for 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.
MediaUrl (string) --
This field is reserved for future use.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
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) --
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
VoiceMessage (dict) --
The default message for the voice channel. This message overrides the default message (DefaultMessage).
Body (string) --
The text of the script to use for the voice message.
LanguageCode (string) --
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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. Attribute names are case sensitive.
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 all other values for 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 won't attempt to send the message again.
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': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}},
'MessageConfiguration': {'SMSMessage': {'EntityId': 'string',
'TemplateId': 'string'}}}}
Updates the configuration and other settings for a campaign.
See also: AWS API Documentation
Request Syntax
client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) -- [REQUIRED]
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
A custom description of the treatment.
TreatmentName (string) --
A custom name for the treatment.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
DeliveryUri (string) -- [REQUIRED]
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
Description (string) --
A 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 invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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 changing 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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
A custom name for the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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) --
The message template to use for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
A custom description of the default treatment for the campaign.
TreatmentName (string) --
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'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'
},
'CustomMessage': {
'Data': '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',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'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'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': '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.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
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, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
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. For an application, this value specifies the default limit for the number of messages that campaigns and journeys 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. For an application, this value specifies the default limit for the number of messages that campaigns 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. If a campaign recurs, this setting applies to all runs 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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. If specified, 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. If specified, this value overrides all other content 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.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render 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 render 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. If specified, 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. If specified, this value overrides all other content 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. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will 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 application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
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 current status of the campaign, or the current 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 if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
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) --
The message template thatβs used for the campaign.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a 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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
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.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
{'WriteJourneyRequest': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Response {'JourneyResponse': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Updates the configuration and other settings for a journey.
See also: AWS API Documentation
Request Syntax
client.update_journey(
ApplicationId='string',
JourneyId='string',
WriteJourneyRequest={
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'CreationDate': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'
}
)
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 journey.
dict
[REQUIRED]
Specifies the configuration and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) -- [REQUIRED]
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) -- [REQUIRED]
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) -- [REQUIRED]
The GPS coordinates to measure distance from.
Latitude (float) -- [REQUIRED]
The latitude coordinate of the location.
Longitude (float) -- [REQUIRED]
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) -- [REQUIRED]
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) -- [REQUIRED]
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) -- [REQUIRED]
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) -- [REQUIRED]
The GPS coordinates to measure distance from.
Latitude (float) -- [REQUIRED]
The latitude coordinate of the location.
Longitude (float) -- [REQUIRED]
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
Name (string) -- [REQUIRED]
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) -- [REQUIRED]
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) -- [REQUIRED]
The unique identifier for the segment to associate with the activity.
State (string) --
The status of the journey. Valid values are:
DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey Stateresource.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --
{'JourneyResponse': {'Activities': {'SMS': {'MessageConfig': {'EntityId': 'string',
'TemplateId': 'string'}}}}}
Cancels (stops) an active journey.
See also: AWS API Documentation
Request Syntax
client.update_journey_state(
ApplicationId='string',
JourneyId='string',
JourneyStateRequest={
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'
}
)
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 journey.
dict
[REQUIRED]
Changes the status of a journey.
State (string) --
The status of the journey. Currently, the only supported value is CANCELLED.
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string) --
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
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) --
Channel (dict) --
The channel criteria for the segment.
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) --
DeviceType (dict) --
The device type criteria for the segment.
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) --
Make (dict) --
The device make criteria for the segment.
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) --
Model (dict) --
The device model criteria for the segment.
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) --
Platform (dict) --
The device platform criteria for the segment.
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) --
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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) --
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(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.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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) --
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
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.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
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. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, 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.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application 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 have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in 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 or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
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 application 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 or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
tags (dict) --
This object is not used or supported.
(string) --
(string) --