A low-level client representing Amazon Pinpoint:
import boto3
client = boto3.client('pinpoint')
These are the available methods:
Check if an operation can be paginated.
Creates an application.
See also: AWS API Documentation
Request Syntax
response = client.create_app(
CreateApplicationRequest={
'Name': 'string',
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
Specifies the display name of an application and the tags to associate with the application.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
The request succeeded and the specified resource was created.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
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
response = client.create_campaign(
ApplicationId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a campaign.
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
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.
The message configuration settings for the treatment.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the email channel.
The body of the email for recipients whose email clients don't support HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients support HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the SMS channel.
The body of the SMS message.
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
The sender ID to display on recipients' devices when they receive the SMS message.
The schedule settings for the treatment.
The scheduled time, in ISO 8601 format, for the campaign to end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
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.
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.
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
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.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
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.
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:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
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.
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.
The scheduled time, in ISO 8601 format, for the campaign to begin.
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.
The allocated percentage of users (segment members) to send the treatment to.
The custom description of the treatment.
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
The custom description of the campaign.
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
The settings for the AWS Lambda function to use as a code hook for the campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Specifies which Lambda mode to use when invoking the AWS Lambda function.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
The messaging limits for the campaign.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
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.
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
The message configuration settings for the campaign.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the email channel.
The body of the email for recipients whose email clients don't support HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients support HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the SMS channel.
The body of the SMS message.
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
The sender ID to display on recipients' devices when they receive the SMS message.
The custom name of the campaign.
The schedule settings for the campaign.
The scheduled time, in ISO 8601 format, for the campaign to end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
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.
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.
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
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.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
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.
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:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
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.
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.
The scheduled time, in ISO 8601 format, for the campaign to begin.
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.
The unique identifier for the segment to associate with the campaign.
The version of the segment to associate with the campaign.
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.
The custom description of a variation of the campaign to use for A/B testing.
The custom name of a variation of the campaign to use for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Creates a new export job for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_export_job(
ApplicationId='string',
ExportJobRequest={
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
The version of the segment to export endpoint definitions from, if specified.
dict
Response Syntax
{
'ExportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
ExportJobResponse (dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
Creates a new import job for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_import_job(
ApplicationId='string',
ImportJobRequest={
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
dict
Response Syntax
{
'ImportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
ImportJobResponse (dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.create_segment(
ApplicationId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
The criteria that define the dimensions for the segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
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.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
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.
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.
The channel criteria for the segment.
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.
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.
The device type criteria for the segment.
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.
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.
The device make criteria for the segment.
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.
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.
The device model criteria for the segment.
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.
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.
The device platform criteria for the segment.
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.
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.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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.
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.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the segment.
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
An array that defines the dimensions for the segment.
Specifies the dimension settings for a segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
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.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
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.
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.
The channel criteria for the segment.
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.
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.
The device type criteria for the segment.
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.
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.
The device make criteria for the segment.
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.
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.
The device model criteria for the segment.
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.
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.
The device platform criteria for the segment.
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.
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.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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.
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.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
Specifies the segment identifier and version of a segment.
The unique identifier for the segment.
The version number of the segment.
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Disables the ADM channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_adm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The unique identifier for the application that the ADM channel applies to.
The date and time when the ADM channel was enabled.
Specifies whether the ADM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
Specifies whether the ADM channel is archived.
The user who last modified the ADM channel.
The date and time when the ADM channel was last modified.
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
The current version of the ADM channel.
Disables the APNs channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
The unique identifier for the application that the APNs channel applies to.
The date and time when the APNs channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
Specifies whether the APNs channel is archived.
The user who last modified the APNs channel.
The date and time when the APNs channel was last modified.
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
The current version of the APNs channel.
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The unique identifier for the application that the APNs sandbox channel applies to.
The date and time when the APNs sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is archived.
The user who last modified the APNs sandbox channel.
The date and time when the APNs sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
The current version of the APNs sandbox channel.
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_voip_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The unique identifier for the application that the APNs VoIP channel applies to.
The date and time when the APNs VoIP channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs VoIP channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is archived.
The user who last modified the APNs VoIP channel.
The date and time when the APNs VoIP channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
The current version of the APNs VoIP channel.
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_voip_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
The date and time when the APNs VoIP sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is archived.
The user who last modified the APNs VoIP sandbox channel.
The date and time when the APNs VoIP sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
The current version of the APNs VoIP sandbox channel.
Deletes an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_app(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
The request succeeded.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
Disables the Baidu channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_baidu_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The unique identifier for the application that the Baidu channel applies to.
The date and time when the Baidu channel was enabled.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether the Baidu channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Specifies whether the Baidu channel is archived.
The user who last modified the Baidu channel.
The date and time when the Baidu channel was last modified.
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
The current version of the Baidu channel.
Deletes a campaign from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_campaign(
ApplicationId='string',
CampaignId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Disables the email channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the email channel for an application.
The unique identifier for the application that the email channel applies to.
The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API .
The date and time, in ISO 8601 format, when the email channel was enabled.
Specifies whether the email channel is enabled for the application.
The verified email address that you send email from when you send email through the channel.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
Specifies whether the email channel is archived.
The user who last modified the email channel.
The date and time, in ISO 8601 format, when the email channel was last modified.
The maximum number of emails that you can send through the channel each second.
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
The current version of the email channel.
Deletes an endpoint from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
ApplicationId='string',
EndpointId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
dict
Response Syntax
{
'EndpointResponse': {
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EndpointResponse (dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as Apple or Samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as iOS or Android.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Not used.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Deletes the event stream for an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_stream(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
The request succeeded.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
The unique identifier for the application to publish event data for.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The date, in ISO 8601 format, when the event stream was last modified.
The IAM user who last modified the event stream.
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Disables the GCM channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_gcm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The unique identifier for the application that the GCM channel applies to.
The date and time when the GCM channel was enabled.
The API key, also referred to as a server key , that you received from Google to communicate with Google services.
Specifies whether the GCM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
Specifies whether the GCM channel is archived.
The user who last modified the GCM channel.
The date and time when the GCM channel was last modified.
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
The current version of the GCM channel.
Deletes a segment from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_segment(
ApplicationId='string',
SegmentId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Disables the SMS channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_sms_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the SMS channel for an application.
The unique identifier for the application that the SMS channel applies to.
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Specifies whether the SMS channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Specifies whether the SMS channel is archived.
The user who last modified the SMS channel.
The date and time, in ISO 8601 format, when the SMS channel was last modified.
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
The maximum number of promotional messages that you can send through the SMS channel each second.
The identity that displays on recipients' devices when they receive messages from the SMS channel.
The registered short code to use when you send messages through the SMS channel.
The maximum number of transactional messages that you can send through the SMS channel each second.
The current version of the SMS channel.
Deletes all the endpoints that are associated with a specific user ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_endpoints(
ApplicationId='string',
UserId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the user.
dict
Response Syntax
{
'EndpointsResponse': {
'Item': [
{
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EndpointsResponse (dict) --
Provides information about all the endpoints that are associated with a user ID.
Item (list) --
An array of responses, one for each endpoint that's associated with the user ID.
(dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as Apple or Samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as iOS or Android.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Not used.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Disables the voice channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the voice channel for an application.
The unique identifier for the application that the voice channel applies to.
The date and time, in ISO 8601 format, when the voice channel was enabled.
Specifies whether the voice channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
Specifies whether the voice channel is archived.
The user who last modified the voice channel.
The date and time, in ISO 8601 format, when the voice channel was last modified.
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
The current version of the voice channel.
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves information about the status and settings of the ADM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_adm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The unique identifier for the application that the ADM channel applies to.
The date and time when the ADM channel was enabled.
Specifies whether the ADM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
Specifies whether the ADM channel is archived.
The user who last modified the ADM channel.
The date and time when the ADM channel was last modified.
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
The current version of the ADM channel.
Retrieves information about the status and settings of the APNs channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
The unique identifier for the application that the APNs channel applies to.
The date and time when the APNs channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
Specifies whether the APNs channel is archived.
The user who last modified the APNs channel.
The date and time when the APNs channel was last modified.
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
The current version of the APNs channel.
Retrieves information about the status and settings of the APNs sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The unique identifier for the application that the APNs sandbox channel applies to.
The date and time when the APNs sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is archived.
The user who last modified the APNs sandbox channel.
The date and time when the APNs sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
The current version of the APNs sandbox channel.
Retrieves information about the status and settings of the APNs VoIP channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_voip_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The unique identifier for the application that the APNs VoIP channel applies to.
The date and time when the APNs VoIP channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs VoIP channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is archived.
The user who last modified the APNs VoIP channel.
The date and time when the APNs VoIP channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
The current version of the APNs VoIP channel.
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_voip_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
The date and time when the APNs VoIP sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is archived.
The user who last modified the APNs VoIP sandbox channel.
The date and time when the APNs VoIP sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
The current version of the APNs VoIP sandbox channel.
Retrieves information about an application.
See also: AWS API Documentation
Request Syntax
response = client.get_app(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
The request succeeded.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
Retrieves information about the settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application_settings(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationSettingsResource': {
'ApplicationId': 'string',
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
}
Response Structure
The request succeeded.
Provides information about an application, including the default settings for an application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Specifies which Lambda mode to use when invoking the AWS Lambda function.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
The date and time, in ISO 8601 format, when the application's settings were last modified.
The default sending limits for campaigns in the application.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
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.
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
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.
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.
Retrieves information about all of your applications.
See also: AWS API Documentation
Request Syntax
response = client.get_apps(
PageSize='string',
Token='string'
)
dict
Response Syntax
{
'ApplicationsResponse': {
'Item': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationsResponse (dict) --
Provides information about all of your applications.
Item (list) --
An array of responses, one for each application that was returned.
(dict) --
Provides information about an application.
Arn (string) --
The Amazon Resource Name (ARN) of the application.
Id (string) --
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Name (string) --
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
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.
Retrieves information about the status and settings of the Baidu Cloud Push channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_baidu_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The unique identifier for the application that the Baidu channel applies to.
The date and time when the Baidu channel was enabled.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether the Baidu channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Specifies whether the Baidu channel is archived.
The user who last modified the Baidu channel.
The date and time when the Baidu channel was last modified.
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
The current version of the Baidu channel.
Retrieves information about the status, configuration, and other settings for a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign(
ApplicationId='string',
CampaignId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Retrieves information about the activity performed by a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_activities(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'ActivitiesResponse': {
'Item': [
{
'ApplicationId': 'string',
'CampaignId': 'string',
'End': 'string',
'Id': 'string',
'Result': 'string',
'ScheduledStart': 'string',
'Start': 'string',
'State': 'string',
'SuccessfulEndpointCount': 123,
'TimezonesCompletedCount': 123,
'TimezonesTotalCount': 123,
'TotalEndpointCount': 123,
'TreatmentId': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ActivitiesResponse (dict) --
Provides information about the activities that were performed by a campaign.
Item (list) --
An array of responses, one for each activity that was performed by the campaign.
(dict) --
Provides information about an activity that was performed by a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
CampaignId (string) --
The unique identifier for the campaign that the activity applies to.
End (string) --
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
Id (string) --
The unique identifier for the activity.
Result (string) --
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
ScheduledStart (string) --
The scheduled start time, in ISO 8601 format, for the activity.
Start (string) --
The actual start time, in ISO 8601 format, of the activity.
State (string) --
The state of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
SuccessfulEndpointCount (integer) --
The total number of endpoints that the campaign successfully delivered messages to.
TimezonesCompletedCount (integer) --
The total number of time zones that were completed.
TimezonesTotalCount (integer) --
The total number of unique time zones that are in the segment for the campaign.
TotalEndpointCount (integer) --
The total number of endpoints that the campaign attempted to deliver messages to.
TreatmentId (string) --
The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a 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.
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_version(
ApplicationId='string',
CampaignId='string',
Version='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
[REQUIRED]
The unique version number (Version property) for the campaign version.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Retrieves information about the status, configuration, and other settings for all versions of a specific campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_versions(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
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
response = client.get_campaigns(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Retrieves information about the history and status of each channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_channels(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ChannelsResponse': {
'Channels': {
'string': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Version': 123
}
}
}
}
Response Structure
The request succeeded.
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
Provides information about the general settings and status of a channel for an application.
The unique identifier for the application.
The date and time, in ISO 8601 format, when the channel was enabled.
Specifies whether the channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
Specifies whether the channel is archived.
The user who last modified the channel.
The date and time, in ISO 8601 format, when the channel was last modified.
The current version of the channel.
Retrieves information about the status and settings of the email channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_email_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the email channel for an application.
The unique identifier for the application that the email channel applies to.
The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API .
The date and time, in ISO 8601 format, when the email channel was enabled.
Specifies whether the email channel is enabled for the application.
The verified email address that you send email from when you send email through the channel.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
Specifies whether the email channel is archived.
The user who last modified the email channel.
The date and time, in ISO 8601 format, when the email channel was last modified.
The maximum number of emails that you can send through the channel each second.
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
The current version of the email channel.
Retrieves information about the settings and attributes of a specific endpoint for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_endpoint(
ApplicationId='string',
EndpointId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
dict
Response Syntax
{
'EndpointResponse': {
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
EndpointResponse (dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as Apple or Samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as iOS or Android.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Not used.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Retrieves information about the event stream settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_event_stream(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
The request succeeded.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
The unique identifier for the application to publish event data for.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The date, in ISO 8601 format, when the event stream was last modified.
The IAM user who last modified the event stream.
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Retrieves information about the status and settings of a specific export job for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_export_job(
ApplicationId='string',
JobId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the job.
dict
Response Syntax
{
'ExportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobResponse (dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
Retrieves information about the status and settings of all the export jobs for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_export_jobs(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ExportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobsResponse (dict) --
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
Item (list) --
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
(dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
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.
Retrieves information about the status and settings of the GCM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_gcm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The unique identifier for the application that the GCM channel applies to.
The date and time when the GCM channel was enabled.
The API key, also referred to as a server key , that you received from Google to communicate with Google services.
Specifies whether the GCM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
Specifies whether the GCM channel is archived.
The user who last modified the GCM channel.
The date and time when the GCM channel was last modified.
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
The current version of the GCM channel.
Retrieves information about the status and settings of a specific import job for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_import_job(
ApplicationId='string',
JobId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the job.
dict
Response Syntax
{
'ImportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobResponse (dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
Retrieves information about the status and settings of all the import jobs for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_import_jobs(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ImportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobsResponse (dict) --
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
Item (list) --
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
(dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
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.
Create a paginator for an operation.
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment(
ApplicationId='string',
SegmentId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Retrieves information about the status and settings of the export jobs for a segment.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_export_jobs(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'ExportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobsResponse (dict) --
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
Item (list) --
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
(dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
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.
Retrieves information about the status and settings of the import jobs for a segment.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_import_jobs(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'ImportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobsResponse (dict) --
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
Item (list) --
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
(dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
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.
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_version(
ApplicationId='string',
SegmentId='string',
Version='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
[REQUIRED]
The unique version number (Version property) for the campaign version.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_versions(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
SegmentsResponse (dict) --
Provides information about all the segments that are associated with an application.
Item (list) --
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
(dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
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.
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segments(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
SegmentsResponse (dict) --
Provides information about all the segments that are associated with an application.
Item (list) --
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
(dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
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.
Retrieves information about the status and settings of the SMS channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_sms_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the SMS channel for an application.
The unique identifier for the application that the SMS channel applies to.
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Specifies whether the SMS channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Specifies whether the SMS channel is archived.
The user who last modified the SMS channel.
The date and time, in ISO 8601 format, when the SMS channel was last modified.
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
The maximum number of promotional messages that you can send through the SMS channel each second.
The identity that displays on recipients' devices when they receive messages from the SMS channel.
The registered short code to use when you send messages through the SMS channel.
The maximum number of transactional messages that you can send through the SMS channel each second.
The current version of the SMS channel.
Retrieves information about all the endpoints that are associated with a specific user ID.
See also: AWS API Documentation
Request Syntax
response = client.get_user_endpoints(
ApplicationId='string',
UserId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the user.
dict
Response Syntax
{
'EndpointsResponse': {
'Item': [
{
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
}
Response Structure
(dict) --
The request succeeded.
EndpointsResponse (dict) --
Provides information about all the endpoints that are associated with a user ID.
Item (list) --
An array of responses, one for each endpoint that's associated with the user ID.
(dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as Apple or Samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as iOS or Android.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Not used.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Retrieves information about the status and settings of the voice channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the voice channel for an application.
The unique identifier for the application that the voice channel applies to.
The date and time, in ISO 8601 format, when the voice channel was enabled.
Specifies whether the voice channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
Specifies whether the voice channel is archived.
The user who last modified the voice channel.
The date and time, in ISO 8601 format, when the voice channel was last modified.
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
The current version of the voice channel.
Returns an object that can wait for some condition.
Retrieves all the tags (keys and values) that are associated with an application, campaign, or segment.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application, campaign, or segment.
{
'TagsModel': {
'tags': {
'string': 'string'
}
}
}
Response Structure
The request succeeded.
Specifies the tags (keys and values) for an application, campaign, or segment.
A string-to-string map of key-value pairs that defines the tags for an application, campaign, or segment. A project, campaign, or segment can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Retrieves information about a phone number.
See also: AWS API Documentation
Request Syntax
response = client.phone_number_validate(
NumberValidateRequest={
'IsoCountryCode': 'string',
'PhoneNumber': 'string'
}
)
[REQUIRED]
Specifies a phone number to validate and retrieve information about.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
{
'NumberValidateResponse': {
'Carrier': 'string',
'City': 'string',
'CleansedPhoneNumberE164': 'string',
'CleansedPhoneNumberNational': 'string',
'Country': 'string',
'CountryCodeIso2': 'string',
'CountryCodeNumeric': 'string',
'County': 'string',
'OriginalCountryCodeIso2': 'string',
'OriginalPhoneNumber': 'string',
'PhoneType': 'string',
'PhoneTypeCode': 123,
'Timezone': 'string',
'ZipCode': 'string'
}
}
Response Structure
The request succeeded.
Provides information about a phone number.
The carrier or service provider that the phone number is currently registered with.
The name of the city where the phone number was originally registered.
The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
The cleansed phone number, in the format for the location where the phone number was originally registered.
The name of the country or region where the phone number was originally registered.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
The numeric code for the country or region where the phone number was originally registered.
The name of the county where the phone number was originally registered.
The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
The phone number that was sent in the request body.
The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
The time zone for the location where the phone number was originally registered.
The postal or ZIP code for the location where the phone number was originally registered.
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
See also: AWS API Documentation
Request Syntax
response = client.put_event_stream(
ApplicationId='string',
WriteEventStream={
'DestinationStreamArn': 'string',
'RoleArn': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
dict
Response Syntax
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
EventStream (dict) --
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
ApplicationId (string) --
The unique identifier for the application to publish event data for.
DestinationStreamArn (string) --
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the event stream was last modified.
LastUpdatedBy (string) --
The IAM user who last modified the event stream.
RoleArn (string) --
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
See also: AWS API Documentation
Request Syntax
response = client.put_events(
ApplicationId='string',
EventsRequest={
'BatchItem': {
'string': {
'Endpoint': {
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
'Events': {
'string': {
'AppPackageName': 'string',
'AppTitle': 'string',
'AppVersionCode': 'string',
'Attributes': {
'string': 'string'
},
'ClientSdkVersion': 'string',
'EventType': 'string',
'Metrics': {
'string': 123.0
},
'SdkName': 'string',
'Session': {
'Duration': 123,
'Id': 'string',
'StartTimestamp': 'string',
'StopTimestamp': 'string'
},
'Timestamp': 'string'
}
}
}
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies a batch of events to process.
The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
Specifies a batch of endpoints and events to process.
A set of properties and attributes that are associated with the endpoint.
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
The channel that's used when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as Apple or Samsung.
The model name or number of the endpoint device, such as iPhone.
The model version of the endpoint device.
The platform of the endpoint device, such as iOS or Android.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint was last updated.
The status of the update request for the endpoint. Possible values are: INACTIVE, the update failed; and, ACTIVE, the endpoint was updated successfully.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
A unique identifier that's generated each time the endpoint is updated.
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
The unique identifier for the user.
A set of properties that are associated with the event.
Specifies information about an event that reports data to Amazon Pinpoint.
The package name of the app that's recording the event.
The title of the app that's recording the event.
The version number of the app that's recording the event.
One or more custom attributes that are associated with the event.
The version of the SDK that's running on the client device.
The name of the event.
One or more custom metrics that are associated with the event.
The name of the SDK that's being used to record the event.
Information about the session in which the event occurred.
The duration of the session, in milliseconds.
The unique identifier for the session.
The date and time when the session began.
The date and time when the session ended.
The date and time, in ISO 8601 format, when the event occurred.
dict
Response Syntax
{
'EventsResponse': {
'Results': {
'string': {
'EndpointItemResponse': {
'Message': 'string',
'StatusCode': 123
},
'EventsItemResponse': {
'string': {
'Message': 'string',
'StatusCode': 123
}
}
}
}
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EventsResponse (dict) --
Provides information about endpoints and the events that they're associated with.
Results (dict) --
A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
(string) --
(dict) --
Provides information about the results of a request to create or update an endpoint that's associated with an event.
EndpointItemResponse (dict) --
The response that was received after the endpoint data was accepted.
Message (string) --
The custom message that's returned in the response as a result of processing the endpoint data.
StatusCode (integer) --
The status code that's returned in the response as a result of processing the endpoint data.
EventsItemResponse (dict) --
A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
(string) --
(dict) --
Provides the status code and message that result from processing an event.
Message (string) --
A custom message that's returned in the response as a result of processing the event.
StatusCode (integer) --
The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.remove_attributes(
ApplicationId='string',
AttributeType='string',
UpdateAttributesRequest={
'Blacklist': [
'string',
]
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The type of attribute or attributes to remove. Valid values are:
[REQUIRED]
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
dict
Response Syntax
{
'AttributesResource': {
'ApplicationId': 'string',
'AttributeType': 'string',
'Attributes': [
'string',
]
}
}
Response Structure
(dict) --
The request succeeded.
AttributesResource (dict) --
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
ApplicationId (string) --
The unique identifier for the application.
AttributeType (string) --
The type of attribute or attributes that were removed from the endpoints. Valid values are:
Attributes (list) --
An array that specifies the names of the attributes that were removed from the endpoints.
Creates and sends a direct message.
See also: AWS API Documentation
Request Syntax
response = client.send_messages(
ApplicationId='string',
MessageRequest={
'Addresses': {
'string': {
'BodyOverride': 'string',
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'Context': {
'string': 'string'
},
'Endpoints': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TraceId': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the objects that define configuration and other settings for a message.
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.
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
The message body to use instead of the default message body. This value overrides the default message body.
The channel to use when sending the message.
An object that maps custom attributes to attributes for the address and is attached to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
The message title to use instead of the default message title. This value overrides the default message title.
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.
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.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
The body of the message. If specified, this value overrides the default message body.
A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
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.
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
The set of properties that defines the configuration settings for the message.
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
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.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The title to display above the notification message on the recipient's device.
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.
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
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.
The body of the notification message.
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.
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.
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The URL of an image or video to display in the push notification.
The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The key for the sound to play when the recipient receives the push notification. The value of 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.
The default message variables to use in the notification message. You can override these default variables with individual address variables.
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.
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.
The title to display above the notification message on the recipient's device.
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.
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
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).
The title to display above the notification message on the recipient's device.
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.
The default message body for all channels.
The default message body of the push notification, email, or SMS message.
The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.
The default push notification message for all push channels.
The default action to occur if a recipient taps the push notification. Valid values are:
The default body of the notification message.
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.
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.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The default title to display above the notification message on a recipient's device.
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.
The default message for the email channel. This message overrides the default message (DefaultMessage).
The body of the email message.
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
The email message, represented as a raw MIME message.
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
The email message, composed of a subject, a text part, and an HTML part.
The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
The applicable character set for the message content.
The textual data of the message content.
The subject line, or title, of the email.
The applicable character set for the message content.
The textual data of the message content.
The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
The applicable character set for the message content.
The textual data of the message content.
The default message variables to use in the email message. You can override the default variables with individual address variables.
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).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
The package name of the application where registration tokens must match in order for the recipient to receive the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
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.
The title to display above the notification message on the recipient's device.
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.
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
The body of the SMS message.
The SMS program name that you provided to AWS Support when you requested your dedicated number.
The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
The number that the SMS message originates from. This should be one of the dedicated long codes or short codes that you requested from AWS Support and is 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.
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.
The message variables to use in the SMS message. You can override the default variables with individual address variables.
The default message for the voice channel. This message overrides the default message (DefaultMessage).
The text script for the voice message.
The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide .
The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
The default message variables to use in the voice message. You can override the default variables with individual address variables.
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide .
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:
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 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:
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 token was updated as part of delivering the message.
Creates and sends a message to a list of users.
See also: AWS API Documentation
Request Syntax
response = client.send_users_messages(
ApplicationId='string',
SendUsersMessageRequest={
'Context': {
'string': 'string'
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TraceId': 'string',
'Users': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
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.
The message definitions for the default message and any default messages that you defined for specific channels.
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
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.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The title to display above the notification message on the recipient's device.
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.
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
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.
The body of the notification message.
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.
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.
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The URL of an image or video to display in the push notification.
The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The key for the sound to play when the recipient receives the push notification. The value of 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.
The default message variables to use in the notification message. You can override these default variables with individual address variables.
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.
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.
The title to display above the notification message on the recipient's device.
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.
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
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).
The title to display above the notification message on the recipient's device.
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.
The default message body for all channels.
The default message body of the push notification, email, or SMS message.
The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.
The default push notification message for all push channels.
The default action to occur if a recipient taps the push notification. Valid values are:
The default body of the notification message.
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.
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.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The default title to display above the notification message on a recipient's device.
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.
The default message for the email channel. This message overrides the default message (DefaultMessage).
The body of the email message.
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
The email message, represented as a raw MIME message.
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
The email message, composed of a subject, a text part, and an HTML part.
The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
The applicable character set for the message content.
The textual data of the message content.
The subject line, or title, of the email.
The applicable character set for the message content.
The textual data of the message content.
The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.
The applicable character set for the message content.
The textual data of the message content.
The default message variables to use in the email message. You can override the default variables with individual address variables.
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).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
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.
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.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
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.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
The package name of the application where registration tokens must match in order for the recipient to receive the message.
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.
The URL of the small icon image to display in the status bar and the content view of the push notification.
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/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
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.
The title to display above the notification message on the recipient's device.
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.
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
The body of the SMS message.
The SMS program name that you provided to AWS Support when you requested your dedicated number.
The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
The number that the SMS message originates from. This should be one of the dedicated long codes or short codes that you requested from AWS Support and is 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.
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.
The message variables to use in the SMS message. You can override the default variables with individual address variables.
The default message for the voice channel. This message overrides the default message (DefaultMessage).
The text script for the voice message.
The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide .
The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
The default message variables to use in the voice message. You can override the default variables with individual address variables.
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide .
The unique identifier for tracing the message. This identifier is visible to message recipients.
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.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
The body of the message. If specified, this value overrides the default message body.
A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
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.
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:
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 token was updated as part of delivering the message.
Adds one or more tags (keys and values) to an application, campaign, or segment.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
TagsModel={
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application, campaign, or segment.
[REQUIRED]
Specifies the tags (keys and values) for an application, campaign, or segment.
A string-to-string map of key-value pairs that defines the tags for an application, campaign, or segment. A project, campaign, or segment can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
None
Removes one or more tags (keys and values) from an application, campaign, or segment.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application, campaign, or segment.
[REQUIRED]
The key of the tag to remove from the application, campaign, or segment. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).
None
Updates the ADM channel settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_adm_channel(
ADMChannelRequest={
'ClientId': 'string',
'ClientSecret': 'string',
'Enabled': True|False
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The Client ID that you received from Amazon to send messages by using ADM.
The Client Secret that you received from Amazon to send messages by using ADM.
Specifies whether to enable the ADM channel for the application.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
ADMChannelResponse (dict) --
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the ADM channel applies to.
CreationDate (string) --
The date and time when the ADM channel was enabled.
Enabled (boolean) --
Specifies whether the ADM channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the ADM channel is archived.
LastModifiedBy (string) --
The user who last modified the ADM channel.
LastModifiedDate (string) --
The date and time when the ADM channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
Version (integer) --
The current version of the ADM channel.
Updates the APNs channel settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_channel(
APNSChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Specifies whether to enable the APNs channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs channel applies to.
CreationDate (string) --
The date and time when the APNs channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs channel.
LastModifiedDate (string) --
The date and time when the APNs channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
Version (integer) --
The current version of the APNs channel.
Updates the APNs sandbox channel settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_sandbox_channel(
APNSSandboxChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
Specifies whether to enable the APNs sandbox channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSSandboxChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs sandbox channel applies to.
CreationDate (string) --
The date and time when the APNs sandbox channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs sandbox channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs sandbox channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs sandbox channel.
LastModifiedDate (string) --
The date and time when the APNs sandbox channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
Version (integer) --
The current version of the APNs sandbox channel.
Updates the APNs VoIP channel settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_voip_channel(
APNSVoipChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Specifies whether to enable the APNs VoIP channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSVoipChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs VoIP channel applies to.
CreationDate (string) --
The date and time when the APNs VoIP channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs VoIP channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs VoIP channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs VoIP channel.
LastModifiedDate (string) --
The date and time when the APNs VoIP channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
Version (integer) --
The current version of the APNs VoIP channel.
Updates the settings for the APNs VoIP sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_voip_sandbox_channel(
APNSVoipSandboxChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSVoipSandboxChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
CreationDate (string) --
The date and time when the APNs VoIP sandbox channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs VoIP sandbox channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs VoIP sandbox channel.
LastModifiedDate (string) --
The date and time when the APNs VoIP sandbox channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
Version (integer) --
The current version of the APNs VoIP sandbox channel.
Updates the settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application_settings(
ApplicationId='string',
WriteApplicationSettingsRequest={
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'CloudWatchMetricsEnabled': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the default settings for an application.
The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaignresource to define custom Lambda function settings for the campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Specifies which Lambda mode to use when invoking the AWS Lambda function.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to enable application-related alarms in Amazon CloudWatch.
The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaignresource to define custom limits for the campaign.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
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.
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign, use the Campaignresource to define a custom quiet time for the campaign.
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.
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.
dict
Response Syntax
{
'ApplicationSettingsResource': {
'ApplicationId': 'string',
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationSettingsResource (dict) --
Provides information about an application, including the default settings for an application.
ApplicationId (string) --
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
CampaignHook (dict) --
The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the application's settings were last modified.
Limits (dict) --
The default sending limits for campaigns in the application.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
QuietTime (dict) --
The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a 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.
Updates the settings of the Baidu channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_baidu_channel(
ApplicationId='string',
BaiduChannelRequest={
'ApiKey': 'string',
'Enabled': True|False,
'SecretKey': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether to enable the Baidu channel for the application.
The secret key that you received from the Baidu Cloud Push service to communicate with the service.
dict
Response Syntax
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
BaiduChannelResponse (dict) --
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the Baidu channel applies to.
CreationDate (string) --
The date and time when the Baidu channel was enabled.
Credential (string) --
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Enabled (boolean) --
Specifies whether the Baidu channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the Baidu channel is archived.
LastModifiedBy (string) --
The user who last modified the Baidu channel.
LastModifiedDate (string) --
The date and time when the Baidu channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
Version (integer) --
The current version of the Baidu channel.
Updates the settings for a campaign.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
[REQUIRED]
Specifies the configuration and other settings for a campaign.
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
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.
The message configuration settings for the treatment.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the email channel.
The body of the email for recipients whose email clients don't support HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients support HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the SMS channel.
The body of the SMS message.
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
The sender ID to display on recipients' devices when they receive the SMS message.
The schedule settings for the treatment.
The scheduled time, in ISO 8601 format, for the campaign to end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
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.
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.
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
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.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
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.
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:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
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.
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.
The scheduled time, in ISO 8601 format, for the campaign to begin.
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.
The allocated percentage of users (segment members) to send the treatment to.
The custom description of the treatment.
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
The custom description of the campaign.
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
The settings for the AWS Lambda function to use as a code hook for the campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Specifies which Lambda mode to use when invoking the AWS Lambda function.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
The messaging limits for the campaign.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
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.
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
The message configuration settings for the campaign.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the email channel.
The body of the email for recipients whose email clients don't support HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients support HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
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.
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.
The title to display above the notification message on a recipient's device.
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.
The message that the campaign sends through the SMS channel.
The body of the SMS message.
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
The sender ID to display on recipients' devices when they receive the SMS message.
The custom name of the campaign.
The schedule settings for the campaign.
The scheduled time, in ISO 8601 format, for the campaign to end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
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.
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.
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
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.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
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.
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:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
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.
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.
The scheduled time, in ISO 8601 format, for the campaign to begin.
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.
The unique identifier for the segment to associate with the campaign.
The version of the segment to associate with the campaign.
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.
The custom description of a variation of the campaign to use for A/B testing.
The custom name of a variation of the campaign to use for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'tags': {
'string': 'string'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The status of the treatment.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, ISO 8601 format, when the campaign was created.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
Mode (string) --
Specifies which Lambda mode to use when invoking the AWS Lambda function.
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel.
Body (string) --
The body of the email for recipients whose email clients don't support HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients support HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel.
Body (string) --
The body of the SMS message.
MessageType (string) --
The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent. This can be a standard type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time, in ISO 8601 format, for the campaign to begin.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TreatmentDescription (string) --
The custom description of a variation of the campaign that's used for A/B testing.
TreatmentName (string) --
The custom name of a variation of the campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Updates the status and settings of the email channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_email_channel(
ApplicationId='string',
EmailChannelRequest={
'ConfigurationSet': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'Identity': 'string',
'RoleArn': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the email channel for an application.
The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API .
Specifies whether to enable the email channel for the application.
The verified email address that you want to send email from when you send email through the channel.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
EmailChannelResponse (dict) --
Provides information about the status and settings of the email channel for an application.
ApplicationId (string) --
The unique identifier for the application that the email channel applies to.
ConfigurationSet (string) --
The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API .
CreationDate (string) --
The date and time, in ISO 8601 format, when the email channel was enabled.
Enabled (boolean) --
Specifies whether the email channel is enabled for the application.
FromAddress (string) --
The verified email address that you send email from when you send email through the channel.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
Identity (string) --
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
IsArchived (boolean) --
Specifies whether the email channel is archived.
LastModifiedBy (string) --
The user who last modified the email channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the email channel was last modified.
MessagesPerSecond (integer) --
The maximum number of emails that you can send through the channel each second.
Platform (string) --
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
RoleArn (string) --
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
Version (integer) --
The current version of the email channel.
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoint(
ApplicationId='string',
EndpointId='string',
EndpointRequest={
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
[REQUIRED]
Specifies the channel type and other settings for an endpoint.
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
The channel to use when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as Apple or Samsung.
The model name or number of the endpoint device, such as iPhone.
The model version of the endpoint device.
The platform of the endpoint device, such as iOS or Android.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint is updated.
Not used.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
The unique identifier for the most recent request to update the endpoint.
One or more custom user attributes that describe the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
The unique identifier for the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoints_batch(
ApplicationId='string',
EndpointBatchRequest={
'Item': [
{
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
The channel to use when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as Apple or Samsung.
The model name or number of the endpoint device, such as iPhone.
The model version of the endpoint device.
The platform of the endpoint device, such as iOS or Android.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint was created or updated.
Not used.
The unique identifier for the endpoint in the context of the batch.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
The unique identifier for the request to create or update the endpoint.
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
The unique identifier for the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Updates the status and settings of the GCM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_gcm_channel(
ApplicationId='string',
GCMChannelRequest={
'ApiKey': 'string',
'Enabled': True|False
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The API key, also referred to as a server key , that you received from Google to communicate with Google services.
Specifies whether to enable the GCM channel for the application.
dict
Response Syntax
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
GCMChannelResponse (dict) --
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
ApplicationId (string) --
The unique identifier for the application that the GCM channel applies to.
CreationDate (string) --
The date and time when the GCM channel was enabled.
Credential (string) --
The API key, also referred to as a server key , that you received from Google to communicate with Google services.
Enabled (boolean) --
Specifies whether the GCM channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the GCM channel is archived.
LastModifiedBy (string) --
The user who last modified the GCM channel.
LastModifiedDate (string) --
The date and time when the GCM channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
Version (integer) --
The current version of the GCM channel.
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.update_segment(
ApplicationId='string',
SegmentId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
[REQUIRED]
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
The criteria that define the dimensions for the segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
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.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
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.
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.
The channel criteria for the segment.
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.
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.
The device type criteria for the segment.
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.
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.
The device make criteria for the segment.
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.
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.
The device model criteria for the segment.
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.
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.
The device platform criteria for the segment.
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.
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.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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.
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.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The name of the segment.
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
An array that defines the dimensions for the segment.
Specifies the dimension settings for a segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
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.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
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.
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.
The channel criteria for the segment.
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.
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.
The device type criteria for the segment.
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.
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.
The device make criteria for the segment.
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.
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.
The device model criteria for the segment.
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.
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.
The device platform criteria for the segment.
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.
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.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
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.
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.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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.
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.
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
Specifies the segment identifier and version of a segment.
The unique identifier for the segment.
The version number of the segment.
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
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.
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.
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.
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.
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.
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.
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.
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 match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Updates the status and settings of the SMS channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_sms_channel(
ApplicationId='string',
SMSChannelRequest={
'Enabled': True|False,
'SenderId': 'string',
'ShortCode': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the SMS channel for an application.
Specifies whether to enable the SMS channel for the application.
The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
The registered short code that you want to use when you send messages through the SMS channel.
dict
Response Syntax
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SMSChannelResponse (dict) --
Provides information about the status and settings of the SMS channel for an application.
ApplicationId (string) --
The unique identifier for the application that the SMS channel applies to.
CreationDate (string) --
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Enabled (boolean) --
Specifies whether the SMS channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the SMS channel is archived.
LastModifiedBy (string) --
The user who last modified the SMS channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the SMS channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
PromotionalMessagesPerSecond (integer) --
The maximum number of promotional messages that you can send through the SMS channel each second.
SenderId (string) --
The identity that displays on recipients' devices when they receive messages from the SMS channel.
ShortCode (string) --
The registered short code to use when you send messages through the SMS channel.
TransactionalMessagesPerSecond (integer) --
The maximum number of transactional messages that you can send through the SMS channel each second.
Version (integer) --
The current version of the SMS channel.
Updates the status and settings of the voice channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_voice_channel(
ApplicationId='string',
VoiceChannelRequest={
'Enabled': True|False
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the voice channel for an application.
Specifies whether to enable the voice channel for the application.
dict
Response Syntax
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
VoiceChannelResponse (dict) --
Provides information about the status and settings of the voice channel for an application.
ApplicationId (string) --
The unique identifier for the application that the voice channel applies to.
CreationDate (string) --
The date and time, in ISO 8601 format, when the voice channel was enabled.
Enabled (boolean) --
Specifies whether the voice channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the voice channel is archived.
LastModifiedBy (string) --
The user who last modified the voice channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the voice channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
Version (integer) --
The current version of the voice channel.