2018/07/05 - Amazon Pinpoint - 5 new 27 updated api methods
Changes This release of the Amazon Pinpoint SDK adds the ability to create complex segments and validate phone numbers for SMS messages. It also adds the ability to get or delete endpoints based on user IDs, remove attributes from endpoints, and list the defined channels for an app.
Deletes endpoints associated with an user id.
See also: AWS API Documentation
Request Syntax
client.delete_user_endpoints(
ApplicationId='string',
UserId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of 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'|'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) -- 202 response
EndpointsResponse (dict) -- List of endpoints
Item (list) -- The list of endpoints.
(dict) -- Endpoint response
Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
ApplicationId (string) -- The ID of the application associated with the endpoint.
Attributes (dict) -- Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
(string) --
(list) --
(string) --
ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
CohortId (string) -- A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
CreationDate (string) -- The last time the endpoint was created. Provided in ISO 8601 format.
Demographic (dict) -- The endpoint demographic attributes.
AppVersion (string) -- The version of the application associated with the endpoint.
Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Make (string) -- The endpoint make, such as such as Apple or Samsung.
Model (string) -- The endpoint model, such as iPhone.
ModelVersion (string) -- The endpoint model version.
Platform (string) -- The endpoint platform, such as ios or android.
PlatformVersion (string) -- The endpoint platform version.
Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- Unused.
Id (string) -- The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
Location (dict) -- The endpoint location attributes.
City (string) -- The city where the endpoint is located.
Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
PostalCode (string) -- The postal code or zip code of the endpoint.
Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
(string) --
(float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
UserAttributes (dict) -- Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
(string) --
(list) --
(string) --
UserId (string) -- The unique ID of the user.
Returns information about the specified phone number.
See also: AWS API Documentation
Request Syntax
client.phone_number_validate(
NumberValidateRequest={
'IsoCountryCode': 'string',
'PhoneNumber': 'string'
}
)
dict
[REQUIRED] Phone Number Information request.
IsoCountryCode (string) -- (Optional) The two-character ISO country code for the country where the phone number was originally registered.
PhoneNumber (string) -- The phone number to get information about.
dict
Response Syntax
{
'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
(dict) -- 200 response
NumberValidateResponse (dict) -- Phone Number Information response.
Carrier (string) -- The carrier that the phone number is registered with.
City (string) -- The city where the phone number was originally registered.
CleansedPhoneNumberE164 (string) -- The cleansed (standardized) phone number in E.164 format.
CleansedPhoneNumberNational (string) -- The cleansed phone number in national format.
Country (string) -- The country where the phone number was originally registered.
CountryCodeIso2 (string) -- The two-character ISO country code for the country where the phone number was originally registered.
CountryCodeNumeric (string) -- The numeric country code for the country where the phone number was originally registered.
County (string) -- The county where the phone number was originally registered.
OriginalCountryCodeIso2 (string) -- The two-character ISO country code that was included in the request body.
OriginalPhoneNumber (string) -- The phone number that you included in the request body.
PhoneType (string) -- A description of the phone type. Possible values include MOBILE, LANDLINE, VOIP, INVALID, and OTHER.
PhoneTypeCode (integer) -- The phone type as an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), and 4 (OTHER).
Timezone (string) -- The time zone for the location where the phone number was originally registered.
ZipCode (string) -- The zip code for the location where the phone number was originally registered.
Returns information about the endpoints associated with an user id.
See also: AWS API Documentation
Request Syntax
client.get_user_endpoints(
ApplicationId='string',
UserId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of 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'|'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) -- 200 response
EndpointsResponse (dict) -- List of endpoints
Item (list) -- The list of endpoints.
(dict) -- Endpoint response
Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
ApplicationId (string) -- The ID of the application associated with the endpoint.
Attributes (dict) -- Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
(string) --
(list) --
(string) --
ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
CohortId (string) -- A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
CreationDate (string) -- The last time the endpoint was created. Provided in ISO 8601 format.
Demographic (dict) -- The endpoint demographic attributes.
AppVersion (string) -- The version of the application associated with the endpoint.
Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Make (string) -- The endpoint make, such as such as Apple or Samsung.
Model (string) -- The endpoint model, such as iPhone.
ModelVersion (string) -- The endpoint model version.
Platform (string) -- The endpoint platform, such as ios or android.
PlatformVersion (string) -- The endpoint platform version.
Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- Unused.
Id (string) -- The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
Location (dict) -- The endpoint location attributes.
City (string) -- The city where the endpoint is located.
Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
PostalCode (string) -- The postal code or zip code of the endpoint.
Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
(string) --
(float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
UserAttributes (dict) -- Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
(string) --
(list) --
(string) --
UserId (string) -- The unique ID of the user.
Get all channels.
See also: AWS API Documentation
Request Syntax
client.get_channels(
ApplicationId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
Response Syntax
{
'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
(dict) -- 200 response
ChannelsResponse (dict) -- Get channels definition
Channels (dict) -- A map of channels, with the ChannelType as the key and the Channel as the value.
(string) --
(dict) -- Base definition for channel response.
ApplicationId (string) -- Application id
CreationDate (string) -- When was this segment created
Enabled (boolean) -- If the channel is enabled for sending messages.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who made the last change
LastModifiedDate (string) -- Last date this was updated
Version (integer) -- Version of channel
Used to remove the attributes for an app
See also: AWS API Documentation
Request Syntax
client.remove_attributes(
ApplicationId='string',
AttributeType='string',
UpdateAttributesRequest={
'Blacklist': [
'string',
]
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes.
dict
[REQUIRED] Update attributes request
Blacklist (list) -- The GLOB wildcard for removing the attributes in the application
(string) --
dict
Response Syntax
{
'AttributesResource': {
'ApplicationId': 'string',
'AttributeType': 'string',
'Attributes': [
'string',
]
}
}
Response Structure
(dict) -- 200 response
AttributesResource (dict) -- Attributes.
ApplicationId (string) -- The unique ID for the application.
AttributeType (string) -- The attribute type for the application.
Attributes (list) -- The attributes for the application.
(string) --
{'WriteCampaignRequest': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}}},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}
Creates or updates a campaign.
See also: AWS API Documentation
Request Syntax
client.create_campaign(
ApplicationId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Used to create a campaign.
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Used to create a campaign treatment.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) -- 201 response
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'ExportJobRequest': {'SegmentVersion': 'integer'}}
Response {'ExportJobResponse': {'Definition': {'SegmentVersion': 'integer'}}}
Creates an export job.
See also: AWS API Documentation
Request Syntax
client.create_export_job(
ApplicationId='string',
ExportJobRequest={
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Export job request.
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
SegmentVersion (integer) -- The version of the segment to export 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) -- 202 response
ExportJobResponse (dict) -- Export job response.
ApplicationId (string) -- The unique ID of the application to which the job applies.
CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
CompletionDate (string) -- The date the job completed in ISO 8601 format.
CreationDate (string) -- The date the job was created in ISO 8601 format.
Definition (dict) -- The export job settings.
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
SegmentVersion (integer) -- The version of the segment to export if specified.
FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
(string) --
Id (string) -- The unique ID of the job.
JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
TotalProcessed (integer) -- The number of endpoints that were processed by the job.
Type (string) -- The job type. Will be 'EXPORT'.
{'WriteSegmentRequest': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | '
'ANY',
'Type': 'ALL | ANY | '
'NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Response {'SegmentResponse': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | ANY',
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Used to create or update a segment.
See also: AWS API Documentation
Request Syntax
client.create_segment(
ApplicationId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
}
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Segment definition.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) -- 201 response
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}
Deletes a campaign.
See also: AWS API Documentation
Request Syntax
client.delete_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of 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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'EmailChannelResponse': {'MessagesPerSecond': 'integer'}}
Delete an email channel.
See also: AWS API Documentation
Request Syntax
client.delete_email_channel(
ApplicationId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': '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) -- 200 response
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- The unique ID of the application to which the email channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
MessagesPerSecond (integer) -- Messages per second that can be sent
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
{'SegmentResponse': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | ANY',
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Deletes a segment.
See also: AWS API Documentation
Request Syntax
client.delete_segment(
ApplicationId='string',
SegmentId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'SMSChannelResponse': {'PromotionalMessagesPerSecond': 'integer',
'TransactionalMessagesPerSecond': 'integer'}}
Delete an SMS channel.
See also: AWS API Documentation
Request Syntax
client.delete_sms_channel(
ApplicationId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
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) -- 200 response
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- The unique ID of the application to which the SMS channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
PromotionalMessagesPerSecond (integer) -- Promotional messages per second that can be sent
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
TransactionalMessagesPerSecond (integer) -- Transactional messages per second that can be sent
Version (integer) -- Version of channel
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}
Returns information about a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign(
ApplicationId='string',
CampaignId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of 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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}
Returns information about a specific version of a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign_version(
ApplicationId='string',
CampaignId='string',
Version='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the campaign.
string
[REQUIRED] The version of 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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}}
Returns information about your campaign versions.
See also: AWS API Documentation
Request Syntax
client.get_campaign_versions(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the campaign.
string
The number of entries you want on each page in the response.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) -- 200 response
CampaignsResponse (dict) -- List of available campaigns.
Item (list) -- A list of campaigns.
(dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'CampaignsResponse': {'Item': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}}
Returns information about your campaigns.
See also: AWS API Documentation
Request Syntax
client.get_campaigns(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
The number of entries you want on each page in the response.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) -- 200 response
CampaignsResponse (dict) -- List of available campaigns.
Item (list) -- A list of campaigns.
(dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'EmailChannelResponse': {'MessagesPerSecond': 'integer'}}
Get an email channel.
See also: AWS API Documentation
Request Syntax
client.get_email_channel(
ApplicationId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': '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) -- 200 response
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- The unique ID of the application to which the email channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
MessagesPerSecond (integer) -- Messages per second that can be sent
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
{'ExportJobResponse': {'Definition': {'SegmentVersion': 'integer'}}}
Returns information about an export job.
See also: AWS API Documentation
Request Syntax
client.get_export_job(
ApplicationId='string',
JobId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of 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) -- 200 response
ExportJobResponse (dict) -- Export job response.
ApplicationId (string) -- The unique ID of the application to which the job applies.
CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
CompletionDate (string) -- The date the job completed in ISO 8601 format.
CreationDate (string) -- The date the job was created in ISO 8601 format.
Definition (dict) -- The export job settings.
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
SegmentVersion (integer) -- The version of the segment to export if specified.
FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
(string) --
Id (string) -- The unique ID of the job.
JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
TotalProcessed (integer) -- The number of endpoints that were processed by the job.
Type (string) -- The job type. Will be 'EXPORT'.
{'ExportJobsResponse': {'Item': {'Definition': {'SegmentVersion': 'integer'}}}}
Returns information about your export jobs.
See also: AWS API Documentation
Request Syntax
client.get_export_jobs(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
The number of entries you want on each page in the response.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
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) -- 200 response
ExportJobsResponse (dict) -- Export job list.
Item (list) -- A list of export jobs for the application.
(dict) -- Export job response.
ApplicationId (string) -- The unique ID of the application to which the job applies.
CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
CompletionDate (string) -- The date the job completed in ISO 8601 format.
CreationDate (string) -- The date the job was created in ISO 8601 format.
Definition (dict) -- The export job settings.
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
SegmentVersion (integer) -- The version of the segment to export if specified.
FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
(string) --
Id (string) -- The unique ID of the job.
JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
TotalProcessed (integer) -- The number of endpoints that were processed by the job.
Type (string) -- The job type. Will be 'EXPORT'.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'SegmentResponse': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | ANY',
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Returns information about a segment.
See also: AWS API Documentation
Request Syntax
client.get_segment(
ApplicationId='string',
SegmentId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'ExportJobsResponse': {'Item': {'Definition': {'SegmentVersion': 'integer'}}}}
Returns a list of export jobs for a specific segment.
See also: AWS API Documentation
Request Syntax
client.get_segment_export_jobs(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
The number of entries you want on each page in the response.
string
[REQUIRED] The unique ID of the segment.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
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) -- 200 response
ExportJobsResponse (dict) -- Export job list.
Item (list) -- A list of export jobs for the application.
(dict) -- Export job response.
ApplicationId (string) -- The unique ID of the application to which the job applies.
CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
CompletionDate (string) -- The date the job completed in ISO 8601 format.
CreationDate (string) -- The date the job was created in ISO 8601 format.
Definition (dict) -- The export job settings.
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
SegmentVersion (integer) -- The version of the segment to export if specified.
FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
(string) --
Id (string) -- The unique ID of the job.
JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
TotalProcessed (integer) -- The number of endpoints that were processed by the job.
Type (string) -- The job type. Will be 'EXPORT'.
NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.
{'SegmentResponse': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | ANY',
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Returns information about a segment version.
See also: AWS API Documentation
Request Syntax
client.get_segment_version(
ApplicationId='string',
SegmentId='string',
Version='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the segment.
string
[REQUIRED] The segment version.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'SegmentsResponse': {'Item': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL '
'| '
'ANY',
'Type': 'ALL | '
'ANY | '
'NONE'}],
'Include': 'ALL | ANY | '
'NONE'}}}}
Returns information about your segment versions.
See also: AWS API Documentation
Request Syntax
client.get_segment_versions(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
The number of entries you want on each page in the response.
string
[REQUIRED] The unique ID of the segment.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) -- 200 response
SegmentsResponse (dict) -- Segments in your account.
Item (list) -- The list of segments.
(dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
{'SegmentsResponse': {'Item': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL '
'| '
'ANY',
'Type': 'ALL | '
'ANY | '
'NONE'}],
'Include': 'ALL | ANY | '
'NONE'}}}}
Used to get information about your segments.
See also: AWS API Documentation
Request Syntax
client.get_segments(
ApplicationId='string',
PageSize='string',
Token='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
The number of entries you want on each page in the response.
string
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) -- 200 response
SegmentsResponse (dict) -- Segments in your account.
Item (list) -- The list of segments.
(dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
{'SMSChannelResponse': {'PromotionalMessagesPerSecond': 'integer',
'TransactionalMessagesPerSecond': 'integer'}}
Get an SMS channel.
See also: AWS API Documentation
Request Syntax
client.get_sms_channel(
ApplicationId='string'
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
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) -- 200 response
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- The unique ID of the application to which the SMS channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
PromotionalMessagesPerSecond (integer) -- Promotional messages per second that can be sent
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
TransactionalMessagesPerSecond (integer) -- Transactional messages per second that can be sent
Version (integer) -- Version of channel
{'MessageRequest': {'MessageConfiguration': {'BaiduMessage': {'TimeToLive': 'integer'},
'SMSMessage': {'Keyword': 'string'}}}}
Response {'MessageResponse': {'EndpointResult': {'MessageId': 'string'},
'Result': {'MessageId': 'string'}}}
Use this resource to send a direct message, which is a one time message that you send to a limited audience without creating a campaign. You can send the message to up to 100 recipients. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of sending a direct message. You can send a direct message as a push notification to your mobile app or as an SMS message to SMS-enabled devices.
See also: AWS API Documentation
Request Syntax
client.send_messages(
ApplicationId='string',
MessageRequest={
'Addresses': {
'string': {
'BodyOverride': 'string',
'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'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'
},
'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',
]
}
}
}
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Send message request.
Addresses (dict) -- A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.
(string) --
(dict) -- Address configuration.
BodyOverride (string) -- Body override. If specified will override default body.
ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
(string) --
(list) --
(string) --
TitleOverride (string) -- Title override. If specified will override default title if applicable.
Context (dict) -- A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
Endpoints (dict) -- A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
(string) --
(dict) -- Endpoint send configuration.
BodyOverride (string) -- Body override. If specified will override default body.
Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
(string) --
(list) --
(string) --
TitleOverride (string) -- Title override. If specified will override default title if applicable.
MessageConfiguration (dict) -- Message configuration.
ADMMessage (dict) -- The message to ADM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
ConsolidationKey (string) -- Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
ExpiresAfter (string) -- Optional. Number of seconds ADM should retain the message if the device is offline
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
MD5 (string) -- Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message to APNS channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Badge (integer) -- Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
Body (string) -- The message body of the notification, the email body or the text message.
Category (string) -- Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
CollapseId (string) -- An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
MediaUrl (string) -- The URL that points to a video used in the push notification.
PreferredAuthenticationMethod (string) -- The preferred authentication method, either "CERTIFICATE" or "TOKEN"
Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Sound (string) -- Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
ThreadId (string) -- Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
TimeToLive (integer) -- The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message to Baidu GCM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Body (string) -- The message body of the notification, the email body or the text message.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
DefaultPushNotificationMessage (dict) -- The default push notification message for all push channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
GCMMessage (dict) -- The message to GCM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
CollapseKey (string) -- This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
RestrictedPackageName (string) -- This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
TimeToLive (integer) -- The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The message to SMS channels. Overrides the default message.
Body (string) -- The body of the SMS message.
Keyword (string) -- The SMS program name that you provided to AWS Support when you requested your dedicated number.
MessageType (string) -- Is this a transaction priority message or lower priority.
OriginationNumber (string) -- The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
SenderId (string) -- The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
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) -- 200 response
MessageResponse (dict) -- Send message response.
ApplicationId (string) -- Application id of the message.
EndpointResult (dict) -- A map containing a multi part response for each address, with the endpointId as the key and the result as the value.
(string) --
(dict) -- The result from sending a message to an endpoint.
Address (string) -- Address that endpoint message was delivered to.
DeliveryStatus (string) -- Delivery status of message.
MessageId (string) -- Unique message identifier associated with the message that was sent.
StatusCode (integer) -- Downstream service status code.
StatusMessage (string) -- Status message for message delivery.
UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)
RequestId (string) -- Original request Id for which this message was delivered.
Result (dict) -- A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
(string) --
(dict) -- The result from sending a message to an address.
DeliveryStatus (string) -- Delivery status of message.
MessageId (string) -- Unique message identifier associated with the message that was sent.
StatusCode (integer) -- Downstream service status code.
StatusMessage (string) -- Status message for message delivery.
UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)
{'SendUsersMessageRequest': {'MessageConfiguration': {'BaiduMessage': {'TimeToLive': 'integer'},
'SMSMessage': {'Keyword': 'string'}}}}
Response {'SendUsersMessageResponse': {'Result': {'MessageId': 'string'}}}
Use this resource to message a list of users. Amazon Pinpoint sends the message to all of the endpoints that are associated with each user. A user represents an individual who is assigned a unique user ID, and this ID is assigned to one or more endpoints. For example, if an individual uses your app on multiple devices, your app could assign that person's user ID to the endpoint for each device. With the users-messages resource, you specify the message recipients as user IDs. For each user ID, Amazon Pinpoint delivers the message to all of the user's endpoints. Within the body of your request, you can specify a default message, and you can tailor your message for different channels, including those for mobile push and SMS. With this resource, you send a direct message, which is a one time message that you send to a limited audience without creating a campaign. You can send the message to up to 100 users per request. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of using the users-messages resource.
See also: AWS API Documentation
Request Syntax
client.send_users_messages(
ApplicationId='string',
SendUsersMessageRequest={
'Context': {
'string': 'string'
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'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',
]
}
}
},
'Users': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
}
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Send message request.
Context (dict) -- A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
(string) --
(string) --
MessageConfiguration (dict) -- Message definitions for the default message and any messages that are tailored for specific channels.
ADMMessage (dict) -- The message to ADM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
ConsolidationKey (string) -- Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
ExpiresAfter (string) -- Optional. Number of seconds ADM should retain the message if the device is offline
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
MD5 (string) -- Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message to APNS channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Badge (integer) -- Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
Body (string) -- The message body of the notification, the email body or the text message.
Category (string) -- Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
CollapseId (string) -- An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
MediaUrl (string) -- The URL that points to a video used in the push notification.
PreferredAuthenticationMethod (string) -- The preferred authentication method, either "CERTIFICATE" or "TOKEN"
Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Sound (string) -- Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
ThreadId (string) -- Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
TimeToLive (integer) -- The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message to Baidu GCM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Body (string) -- The message body of the notification, the email body or the text message.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
DefaultPushNotificationMessage (dict) -- The default push notification message for all push channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
GCMMessage (dict) -- The message to GCM channels. Overrides the default push notification message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
Body (string) -- The message body of the notification, the email body or the text message.
CollapseKey (string) -- This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
(string) --
(string) --
IconReference (string) -- The icon image name of the asset saved in your application.
ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
ImageUrl (string) -- The URL that points to an image used in the push notification.
Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
RestrictedPackageName (string) -- This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
TimeToLive (integer) -- The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The message to SMS channels. Overrides the default message.
Body (string) -- The body of the SMS message.
Keyword (string) -- The SMS program name that you provided to AWS Support when you requested your dedicated number.
MessageType (string) -- Is this a transaction priority message or lower priority.
OriginationNumber (string) -- The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
SenderId (string) -- The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
(string) --
(list) --
(string) --
Users (dict) -- A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.
(string) --
(dict) -- Endpoint send configuration.
BodyOverride (string) -- Body override. If specified will override default body.
Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
(string) --
(string) --
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
(string) --
(list) --
(string) --
TitleOverride (string) -- Title override. If specified will override default title if applicable.
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) -- 200 response
SendUsersMessageResponse (dict) -- User send message response.
ApplicationId (string) -- The unique ID of the Amazon Pinpoint project used to send the message.
RequestId (string) -- The unique ID assigned to the users-messages request.
Result (dict) -- An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.
(string) --
(dict) --
(string) --
(dict) -- The result from sending a message to an endpoint.
Address (string) -- Address that endpoint message was delivered to.
DeliveryStatus (string) -- Delivery status of message.
MessageId (string) -- Unique message identifier associated with the message that was sent.
StatusCode (integer) -- Downstream service status code.
StatusMessage (string) -- Status message for message delivery.
UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)
{'WriteApplicationSettingsRequest': {'CloudWatchMetricsEnabled': 'boolean'}}
Used to update the settings for an app.
See also: AWS API Documentation
Request Syntax
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'
}
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Creating application setting request
CampaignHook (dict) -- Default campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
CloudWatchMetricsEnabled (boolean) -- The CloudWatchMetrics settings for the app.
Limits (dict) -- The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
QuietTime (dict) -- The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
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) -- 200 response
ApplicationSettingsResource (dict) -- Application settings.
ApplicationId (string) -- The unique ID for the application.
CampaignHook (dict) -- Default campaign hook.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
LastModifiedDate (string) -- The date that the settings were last updated in ISO 8601 format.
Limits (dict) -- The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
QuietTime (dict) -- The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
{'WriteCampaignRequest': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}}},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}}}}
Response {'CampaignResponse': {'AdditionalTreatments': {'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}},
'DefaultState': {'CampaignStatus': ['DELETED']},
'MessageConfiguration': {'ADMMessage': {'TimeToLive': 'integer'},
'APNSMessage': {'TimeToLive': 'integer'},
'BaiduMessage': {'TimeToLive': 'integer'},
'DefaultMessage': {'TimeToLive': 'integer'},
'GCMMessage': {'TimeToLive': 'integer'}},
'State': {'CampaignStatus': ['DELETED']}}}
Use to update a campaign.
See also: AWS API Documentation
Request Syntax
client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'SenderId': 'string'
}
},
'Schedule': {
'EndTime': 'string',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'Description': 'string',
'HoldoutPercent': 123,
'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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'TreatmentDescription': 'string',
'TreatmentName': 'string'
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the campaign.
dict
[REQUIRED] Used to create a campaign.
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Used to create a campaign treatment.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'Id': 'string',
'MessageConfiguration': {
'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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': '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',
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
CampaignResponse (dict) -- Campaign definition
AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
(dict) -- Treatment resource
Id (string) -- The unique treatment ID.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SizePercent (integer) -- The allocated percentage of users for this treatment.
State (dict) -- The treatment status.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
ApplicationId (string) -- The ID of the application to which the campaign applies.
CreationDate (string) -- The date the campaign was created in ISO 8601 format.
DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
Mode (string) -- What mode Lambda should be invoked in.
WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Id (string) -- The unique campaign ID.
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
Limits (dict) -- The campaign limits settings.
Daily (integer) -- The maximum number of messages that the campaign can send daily.
MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
DefaultMessage (dict) -- The default message for all channels.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
EmailMessage (dict) -- The email message configuration.
Body (string) -- The email text body.
FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
HtmlBody (string) -- The email html body.
Title (string) -- The email title (Or subject).
GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body (string) -- The message body. Can include up to 140 characters.
ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl (string) -- The URL that points to an image used in the push notification.
JsonBody (string) -- The JSON payload used for a silent push.
MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title (string) -- The message title that displays above the message on the user's device.
Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
SMSMessage (dict) -- The SMS message configuration.
Body (string) -- The SMS text body.
MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime (dict) -- The time during which the campaign sends no messages.
End (string) -- The default end time for quiet time in ISO 8601 format.
Start (string) -- The default start time for quiet time in ISO 8601 format.
StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Version (integer) -- The campaign version number.
{'EmailChannelResponse': {'MessagesPerSecond': 'integer'}}
Update an email channel.
See also: AWS API Documentation
Request Syntax
client.update_email_channel(
ApplicationId='string',
EmailChannelRequest={
'Enabled': True|False,
'FromAddress': 'string',
'Identity': 'string',
'RoleArn': 'string'
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] Email Channel Request
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
Identity (string) -- The ARN of an identity verified with SES.
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'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) -- 200 response
EmailChannelResponse (dict) -- Email Channel Response.
ApplicationId (string) -- The unique ID of the application to which the email channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
FromAddress (string) -- The email address used to send emails from.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
Identity (string) -- The ARN of an identity verified with SES.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
MessagesPerSecond (integer) -- Messages per second that can be sent
Platform (string) -- Platform type. Will be "EMAIL"
RoleArn (string) -- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
Version (integer) -- Version of channel
{'WriteSegmentRequest': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | '
'ANY',
'Type': 'ALL | ANY | '
'NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Response {'SegmentResponse': {'Dimensions': {'Location': {'GPSPoint': {'Coordinates': {'Latitude': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}}},
'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': 'double',
'Longitude': 'double'},
'RangeInKilometers': 'double'}},
'Metrics': {'string': {'ComparisonOperator': 'string',
'Value': 'double'}},
'UserAttributes': {'string': {'AttributeType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['string']}}}],
'SourceSegments': [{'Id': 'string',
'Version': 'integer'}],
'SourceType': 'ALL | ANY',
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}}
Use to update a segment.
See also: AWS API Documentation
Request Syntax
client.update_segment(
ApplicationId='string',
SegmentId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
}
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
string
[REQUIRED] The unique ID of the segment.
dict
[REQUIRED] Segment definition.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'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',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'Version': 123
}
}
Response Structure
(dict) -- 200 response
SegmentResponse (dict) -- Segment definition.
ApplicationId (string) -- The ID of the application to which the segment applies.
CreationDate (string) -- The date the segment was created in ISO 8601 format.
Dimensions (dict) -- The segment dimensions attributes.
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Id (string) -- The unique segment ID.
ImportDefinition (dict) -- The import job settings.
ChannelCounts (dict) -- Channel type counts
(string) --
(integer) --
ExternalId (string) -- DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
S3Url (string) -- A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
Size (integer) -- The number of endpoints that were successfully imported to create this segment.
LastModifiedDate (string) -- The date the segment was last updated in ISO 8601 format.
Name (string) -- The name of segment
SegmentGroups (dict) -- Segment definition groups. We currently only support one. If specified Dimensions must be empty.
Groups (list) -- List of dimension groups to evaluate.
(dict) -- Segment group definition.
Dimensions (list) -- List of dimensions to include or exclude.
(dict) -- Segment dimensions
Attributes (dict) -- Custom segment attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Behavior (dict) -- The segment behaviors attributes.
Recency (dict) -- The recency of use.
Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
Demographic (dict) -- The segment demographics attributes.
AppVersion (dict) -- The app version criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Channel (dict) -- The channel criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
DeviceType (dict) -- The device type criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Make (dict) -- The device make criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Model (dict) -- The device model criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Platform (dict) -- The device platform criteria for the segment.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
Location (dict) -- The segment location attributes.
Country (dict) -- The country filter according to ISO 3166-1 Alpha-2 codes.
DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
GPSPoint (dict) -- The GPS Point dimension.
Coordinates (dict) -- Coordinate to measure distance from.
Latitude (float) -- Latitude
Longitude (float) -- Longitude
RangeInKilometers (float) -- Range in kilometers from the coordinate.
Metrics (dict) -- Custom segment metrics.
(string) --
(dict) -- Custom metric dimension
ComparisonOperator (string) -- GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL
Value (float) -- Value to be compared.
UserAttributes (dict) -- Custom segment user attributes.
(string) --
(dict) -- Custom attibute dimension
AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
(string) --
SourceSegments (list) -- Segments that define the source of this segment. Currently a maximum of 1 import segment is supported.
(dict) -- Segment reference.
Id (string) -- Segment Id.
Version (integer) -- If specified contains a specific version of the segment included.
SourceType (string) -- Include or exclude the source.
Type (string) -- How should the dimensions be applied for the result
Include (string) -- How should the groups be applied for the result
SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
Version (integer) -- The segment version number.
{'SMSChannelResponse': {'PromotionalMessagesPerSecond': 'integer',
'TransactionalMessagesPerSecond': 'integer'}}
Update an SMS channel.
See also: AWS API Documentation
Request Syntax
client.update_sms_channel(
ApplicationId='string',
SMSChannelRequest={
'Enabled': True|False,
'SenderId': 'string',
'ShortCode': 'string'
}
)
string
[REQUIRED] The unique ID of your Amazon Pinpoint application.
dict
[REQUIRED] SMS Channel Request
Enabled (boolean) -- If the channel is enabled for sending messages.
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- ShortCode registered with phone provider.
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) -- 200 response
SMSChannelResponse (dict) -- SMS Channel Response.
ApplicationId (string) -- The unique ID of the application to which the SMS channel belongs.
CreationDate (string) -- The date that the settings were last updated in ISO 8601 format.
Enabled (boolean) -- If the channel is enabled for sending messages.
HasCredential (boolean) -- Not used. Retained for backwards compatibility.
Id (string) -- Channel ID. Not used, only for backwards compatibility.
IsArchived (boolean) -- Is this channel archived
LastModifiedBy (string) -- Who last updated this entry
LastModifiedDate (string) -- Last date this was updated
Platform (string) -- Platform type. Will be "SMS"
PromotionalMessagesPerSecond (integer) -- Promotional messages per second that can be sent
SenderId (string) -- Sender identifier of your messages.
ShortCode (string) -- The short code registered with the phone provider.
TransactionalMessagesPerSecond (integer) -- Transactional messages per second that can be sent
Version (integer) -- Version of channel