Pinpoint / Client / create_push_template

create_push_template#

Pinpoint.Client.create_push_template(**kwargs)#

Creates a message template for messages that are sent through a push notification channel.

Request Syntax

response = client.create_push_template(
    PushNotificationTemplateRequest={
        'ADM': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'APNS': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'MediaUrl': 'string',
            'RawContent': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'Baidu': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'Default': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'DefaultSubstitutions': 'string',
        'GCM': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'RecommenderId': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string'
    },
    TemplateName='string'
)

Parameters:

PushNotificationTemplateRequest (dict) –
[REQUIRED]

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
- ADM (dict) –
  
  The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - Action (string) –
    
    The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
  - Body (string) –
    
    The message body to use in a push notification that’s based on the message template.
  - ImageIconUrl (string) –
    
    The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
  - ImageUrl (string) –
    
    The URL of an image to display in a push notification that’s based on the message template.
  - RawContent (string) –
    
    The raw, JSON-formatted string to use as the payload for a push notification that’s based on the message template. If specified, this value overrides all other content for the message template.
  - SmallImageIconUrl (string) –
    
    The URL of the small icon image to display in the status bar and the content view of a push notification that’s based on the message template.
  - Sound (string) –
    
    The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
  - Title (string) –
    
    The title to use in a push notification that’s based on the message template. This title appears above the notification message on a recipient’s device.
  - Url (string) –
    
    The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
- APNS (dict) –
  
  The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - Action (string) –
    
    The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
  - Body (string) –
    
    The message body to use in push notifications that are based on the message template.
  - MediaUrl (string) –
    
    The URL of an image or video to display in push notifications that are based on the message template.
  - RawContent (string) –
    
    The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
  - Sound (string) –
    
    The key for the sound to play when the recipient receives a push notification that’s based on the message template. The value for this key is the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.
  - Title (string) –
    
    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient’s device.
  - Url (string) –
    
    The URL to open in the recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
- Baidu (dict) –
  
  The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - Action (string) –
    
    The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
  - Body (string) –
    
    The message body to use in a push notification that’s based on the message template.
  - ImageIconUrl (string) –
    
    The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
  - ImageUrl (string) –
    
    The URL of an image to display in a push notification that’s based on the message template.
  - RawContent (string) –
    
    The raw, JSON-formatted string to use as the payload for a push notification that’s based on the message template. If specified, this value overrides all other content for the message template.
  - SmallImageIconUrl (string) –
    
    The URL of the small icon image to display in the status bar and the content view of a push notification that’s based on the message template.
  - Sound (string) –
    
    The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
  - Title (string) –
    
    The title to use in a push notification that’s based on the message template. This title appears above the notification message on a recipient’s device.
  - Url (string) –
    
    The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
- Default (dict) –
  
  The default message template to use for push notification channels.
  - Action (string) –
    
    The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
    - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
  - Body (string) –
    
    The message body to use in push notifications that are based on the message template.
  - Sound (string) –
    
    The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
    
    For an iOS platform, this value is the key for the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.
  - Title (string) –
    
    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient’s device.
  - Url (string) –
    
    The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
- DefaultSubstitutions (string) –
  
  A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.
- GCM (dict) –
  
  The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - Action (string) –
    
    The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
  - Body (string) –
    
    The message body to use in a push notification that’s based on the message template.
  - ImageIconUrl (string) –
    
    The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
  - ImageUrl (string) –
    
    The URL of an image to display in a push notification that’s based on the message template.
  - RawContent (string) –
    
    The raw, JSON-formatted string to use as the payload for a push notification that’s based on the message template. If specified, this value overrides all other content for the message template.
  - SmallImageIconUrl (string) –
    
    The URL of the small icon image to display in the status bar and the content view of a push notification that’s based on the message template.
  - Sound (string) –
    
    The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
  - Title (string) –
    
    The title to use in a push notification that’s based on the message template. This title appears above the notification message on a recipient’s device.
  - Url (string) –
    
    The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
- RecommenderId (string) –
  
  The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
- tags (dict) –
  
  Note
  As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
  
  (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
  - (string) –
    - (string) –
- TemplateDescription (string) –
  
  A custom description of the message template.
TemplateName (string) –
[REQUIRED]

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

(dict) –

The request succeeded and the specified resource was created.
- CreateTemplateMessageBody (dict) –
  
  Provides information about a request to create a message template.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the message template that was created.
  - Message (string) –
    
    The message that’s returned from the API for the request to create the message template.
  - RequestID (string) –
    
    The unique identifier for the request to create the message template.

Exceptions

Pinpoint.Client.exceptions.MethodNotAllowedException
Pinpoint.Client.exceptions.TooManyRequestsException
Pinpoint.Client.exceptions.BadRequestException
Pinpoint.Client.exceptions.InternalServerErrorException
Pinpoint.Client.exceptions.ForbiddenException