AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Pinpoint CreatePushTemplate API operation.

Syntax

New-PINPushTemplate
-TemplateName <String>
-ADM_Action <Action>
-APNS_Action <Action>
-Baidu_Action <Action>
-Default_Action <Action>
-GCM_Action <Action>
-ADM_Body <String>
-APNS_Body <String>
-Baidu_Body <String>
-Default_Body <String>
-GCM_Body <String>
-PushNotificationTemplateRequest_DefaultSubstitution <String>
-ADM_ImageIconUrl <String>
-Baidu_ImageIconUrl <String>
-GCM_ImageIconUrl <String>
-ADM_ImageUrl <String>
-Baidu_ImageUrl <String>
-GCM_ImageUrl <String>
-APNS_MediaUrl <String>
-ADM_RawContent <String>
-APNS_RawContent <String>
-Baidu_RawContent <String>
-GCM_RawContent <String>
-PushNotificationTemplateRequest_RecommenderId <String>
-ADM_SmallImageIconUrl <String>
-Baidu_SmallImageIconUrl <String>
-GCM_SmallImageIconUrl <String>
-ADM_Sound <String>
-APNS_Sound <String>
-Baidu_Sound <String>
-Default_Sound <String>
-GCM_Sound <String>
-PushNotificationTemplateRequest_Tag <Hashtable>
-PushNotificationTemplateRequest_TemplateDescription <String>
-ADM_Title <String>
-APNS_Title <String>
-Baidu_Title <String>
-Default_Title <String>
-GCM_Title <String>
-ADM_Url <String>
-APNS_Url <String>
-Baidu_Url <String>
-Default_Url <String>
-GCM_Url <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointConfig>

Description

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

Parameters

-ADM_Action <Action>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_Action
-ADM_Body <String>
The message body to use in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_Body
-ADM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_ImageIconUrl
-ADM_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_ImageUrl
-ADM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_RawContent
-ADM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_SmallImageIconUrl
-ADM_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/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_Sound
-ADM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_Title
-ADM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_ADM_Url
-APNS_Action <Action>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_Action
-APNS_Body <String>
The message body to use in push notifications that are based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_Body
-APNS_MediaUrl <String>
The URL of an image or video to display in push notifications that are based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_MediaUrl
-APNS_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_RawContent
-APNS_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_Sound
-APNS_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_Title
-APNS_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_APNS_Url
-Baidu_Action <Action>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_Action
-Baidu_Body <String>
The message body to use in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_Body
-Baidu_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_ImageIconUrl
-Baidu_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_ImageUrl
-Baidu_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_RawContent
-Baidu_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_SmallImageIconUrl
-Baidu_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/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_Sound
-Baidu_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_Title
-Baidu_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Baidu_Url
-ClientConfig <AmazonPinpointConfig>
Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Default_Action <Action>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Default_Action
-Default_Body <String>
The message body to use in push notifications that are based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Default_Body
-Default_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Default_Sound
-Default_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Default_Title
-Default_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Default_Url
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GCM_Action <Action>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_Action
-GCM_Body <String>
The message body to use in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_Body
-GCM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_ImageIconUrl
-GCM_ImageUrl <String>
The URL of an image to display in a push notification that's based on the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_ImageUrl
-GCM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_RawContent
-GCM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_SmallImageIconUrl
-GCM_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/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_Sound
-GCM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_Title
-GCM_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_GCM_Url
-PushNotificationTemplateRequest_DefaultSubstitution <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_DefaultSubstitutions
-PushNotificationTemplateRequest_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PushNotificationTemplateRequest_Tag <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPushNotificationTemplateRequest_Tags
-PushNotificationTemplateRequest_TemplateDescription <String>
A custom description of the message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'CreateTemplateMessageBody'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreatePushTemplateResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreatePushTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TemplateName <String>
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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Pinpoint.Model.CreateTemplateMessageBody or Amazon.Pinpoint.Model.CreatePushTemplateResponse
This cmdlet returns an Amazon.Pinpoint.Model.CreateTemplateMessageBody object. The service call response (type Amazon.Pinpoint.Model.CreatePushTemplateResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z