Pinpoint / Client / get_push_template

get_push_template#

Pinpoint.Client.get_push_template(**kwargs)#

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

Request Syntax

response = client.get_push_template(
    TemplateName='string',
    Version='string'
)

Parameters:

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.
Version (string) –
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

If you don’t specify a value for this parameter, Amazon Pinpoint does the following:
- For a get operation, retrieves information about the active version of the template.
- For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.
- For a delete operation, deletes the template, including all versions of the template.

Return type:

dict

Returns:

Response Syntax

{
    'PushNotificationTemplateResponse': {
        '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'
        },
        'Arn': 'string',
        'Baidu': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'ImageIconUrl': 'string',
            'ImageUrl': 'string',
            'RawContent': 'string',
            'SmallImageIconUrl': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        'CreationDate': 'string',
        'Default': {
            'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
            'Body': 'string',
            'Sound': 'string',
            'Title': 'string',
            'Url': 'string'
        },
        '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'
        },
        'LastModifiedDate': 'string',
        'RecommenderId': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'TemplateName': 'string',
        'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
        'Version': 'string'
    }
}

Response Structure

(dict) –

The request succeeded.
- PushNotificationTemplateResponse (dict) –
  
  Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
  - ADM (dict) –
    
    The message template that’s used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    - Action (string) –
      
      The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
      - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
      - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
    - Body (string) –
      
      The message body to use in a push notification that’s based on the message template.
    - ImageIconUrl (string) –
      
      The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
    - ImageUrl (string) –
      
      The URL of an image to display in a push notification that’s based on the message template.
    - 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 that’s used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    - Action (string) –
      
      The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
      - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
      - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
    - Body (string) –
      
      The message body to use in push notifications that are based on the message template.
    - MediaUrl (string) –
      
      The URL of an image or video to display in push notifications that are based on the message template.
    - 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.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the message template.
  - Baidu (dict) –
    
    The message template that’s used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    - Action (string) –
      
      The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
      - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
      - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
    - Body (string) –
      
      The message body to use in a push notification that’s based on the message template.
    - ImageIconUrl (string) –
      
      The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
    - ImageUrl (string) –
      
      The URL of an image to display in a push notification that’s based on the message template.
    - 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.
  - CreationDate (string) –
    
    The date, in ISO 8601 format, when the message template was created.
  - Default (dict) –
    
    The default message template that’s used for push notification channels.
    - Action (string) –
      
      The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
      - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
      - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
    - Body (string) –
      
      The message body to use in push notifications that are based on the message template.
    - Sound (string) –
      
      The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
      
      For an iOS platform, this value is the key for the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.
    - Title (string) –
      
      The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient’s device.
    - Url (string) –
      
      The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL.
  - DefaultSubstitutions (string) –
    
    The JSON object that specifies the default values that are used 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.
  - GCM (dict) –
    
    The message template that’s used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    - Action (string) –
      
      The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are:
      - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
      - URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.
    - Body (string) –
      
      The message body to use in a push notification that’s based on the message template.
    - ImageIconUrl (string) –
      
      The URL of the large icon image to display in the content view of a push notification that’s based on the message template.
    - ImageUrl (string) –
      
      The URL of an image to display in a push notification that’s based on the message template.
    - 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.
  - LastModifiedDate (string) –
    
    The date, in ISO 8601 format, when the message template was last modified.
  - RecommenderId (string) –
    
    The unique identifier for the recommender model that’s used by the message template.
  - tags (dict) –
    
    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
    - (string) –
      - (string) –
  - TemplateDescription (string) –
    
    The custom description of the message template.
  - TemplateName (string) –
    
    The name of the message template.
  - TemplateType (string) –
    
    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
  - Version (string) –
    
    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

Exceptions

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