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 SendUsersMessages API operation.

Syntax

Send-PINUserMessageBatch
-ApplicationId <String>
-ADMMessage_Action <Action>
-APNSMessage_Action <Action>
-BaiduMessage_Action <Action>
-DefaultPushNotificationMessage_Action <Action>
-GCMMessage_Action <Action>
-APNSMessage_Badge <Int32>
-ADMMessage_Body <String>
-APNSMessage_Body <String>
-BaiduMessage_Body <String>
-DefaultMessage_Body <String>
-DefaultPushNotificationMessage_Body <String>
-GCMMessage_Body <String>
-SMSMessage_Body <String>
-APNSMessage_Category <String>
-APNSMessage_CollapseId <String>
-GCMMessage_CollapseKey <String>
-ADMMessage_ConsolidationKey <String>
-SendUsersMessageRequest_Context <Hashtable>
-ADMMessage_Data <Hashtable>
-APNSMessage_Data <Hashtable>
-BaiduMessage_Data <Hashtable>
-DefaultPushNotificationMessage_Data <Hashtable>
-GCMMessage_Data <Hashtable>
-ADMMessage_ExpiresAfter <String>
-ADMMessage_IconReference <String>
-BaiduMessage_IconReference <String>
-GCMMessage_IconReference <String>
-ADMMessage_ImageIconUrl <String>
-BaiduMessage_ImageIconUrl <String>
-GCMMessage_ImageIconUrl <String>
-ADMMessage_ImageUrl <String>
-BaiduMessage_ImageUrl <String>
-GCMMessage_ImageUrl <String>
-ADMMessage_MD5 <String>
-APNSMessage_MediaUrl <String>
-SMSMessage_MessageType <MessageType>
-APNSMessage_PreferredAuthenticationMethod <String>
-APNSMessage_Priority <String>
-GCMMessage_Priority <String>
-ADMMessage_RawContent <String>
-APNSMessage_RawContent <String>
-BaiduMessage_RawContent <String>
-GCMMessage_RawContent <String>
-GCMMessage_RestrictedPackageName <String>
-SMSMessage_SenderId <String>
-ADMMessage_SilentPush <Boolean>
-APNSMessage_SilentPush <Boolean>
-BaiduMessage_SilentPush <Boolean>
-DefaultPushNotificationMessage_SilentPush <Boolean>
-GCMMessage_SilentPush <Boolean>
-ADMMessage_SmallImageIconUrl <String>
-BaiduMessage_SmallImageIconUrl <String>
-GCMMessage_SmallImageIconUrl <String>
-ADMMessage_Sound <String>
-APNSMessage_Sound <String>
-BaiduMessage_Sound <String>
-GCMMessage_Sound <String>
-ADMMessage_Substitution <Hashtable>
-APNSMessage_Substitution <Hashtable>
-BaiduMessage_Substitution <Hashtable>
-DefaultMessage_Substitution <Hashtable>
-DefaultPushNotificationMessage_Substitution <Hashtable>
-GCMMessage_Substitution <Hashtable>
-SMSMessage_Substitution <Hashtable>
-APNSMessage_ThreadId <String>
-APNSMessage_TimeToLive <Int32>
-GCMMessage_TimeToLive <Int32>
-ADMMessage_Title <String>
-APNSMessage_Title <String>
-BaiduMessage_Title <String>
-DefaultPushNotificationMessage_Title <String>
-GCMMessage_Title <String>
-ADMMessage_Url <String>
-APNSMessage_Url <String>
-BaiduMessage_Url <String>
-DefaultPushNotificationMessage_Url <String>
-GCMMessage_Url <String>
-SendUsersMessageRequest_User <Hashtable>
-Force <SwitchParameter>

Description

Send a batch of messages to users

Parameters

-ADMMessage_Action <Action>
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
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_Data <Hashtable>
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_ExpiresAfter <String>
Optional. Number of seconds ADM should retain the message if the device is offline
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_ImageIconUrl <String>
The URL that points to an image used as the large icon to the notification content view.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_MD5 <String>
Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_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
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_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/
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-ADMMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Action <Action>
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
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Badge <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_CollapseId <String>
Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Data <Hashtable>
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_MediaUrl <String>
The URL that points to a video used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_PreferredAuthenticationMethod <String>
The preferred authentication method, either "CERTIFICATE" or "TOKEN"
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Priority <String>
Is this a transaction priority message or lower priority.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_TimeToLive <Int32>
This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS 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 APNS
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-ApplicationId <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-BaiduMessage_Action <Action>
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
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_Data <Hashtable>
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_ImageIconUrl <String>
The URL that points to an image used as the large icon to the notification content view.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_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
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_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/
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-BaiduMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Action <Action>
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
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Data <Hashtable>
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-DefaultPushNotificationMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-GCMMessage_Action <Action>
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
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Data <Hashtable>
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_ImageIconUrl <String>
The URL that points to an image used as the large icon to the notification content view.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Priority <String>
Is this a transaction priority message or lower priority.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_RestrictedPackageName <String>
This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_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.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_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
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_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/
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_TimeToLive <Int32>
This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-SendUsersMessageRequest_Context <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?False
-SendUsersMessageRequest_User <Hashtable>
A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_MessageType <MessageType>
Is this a transaction priority message or lower priority.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_SenderId <String>
Sender ID of sent message.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the ApplicationId parameter.

Outputs

This cmdlet returns a SendUsersMessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendUsersMessagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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