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

Syntax

Send-PINMessage
-ApplicationId <String>
-ADMMessage_Action <Action>
-APNSMessage_Action <Action>
-BaiduMessage_Action <Action>
-DefaultPushNotificationMessage_Action <Action>
-GCMMessage_Action <Action>
-MessageRequest_Address <Hashtable>
-APNSMessage_Badge <Int32>
-ADMMessage_Body <String>
-APNSMessage_Body <String>
-BaiduMessage_Body <String>
-DefaultMessage_Body <String>
-DefaultPushNotificationMessage_Body <String>
-EmailMessage_Body <String>
-GCMMessage_Body <String>
-SMSMessage_Body <String>
-VoiceMessage_Body <String>
-APNSMessage_Category <String>
-HtmlPart_Charset <String>
-Subject_Charset <String>
-TextPart_Charset <String>
-APNSMessage_CollapseId <String>
-GCMMessage_CollapseKey <String>
-ADMMessage_ConsolidationKey <String>
-MessageRequest_Context <Hashtable>
-ADMMessage_Data <Hashtable>
-APNSMessage_Data <Hashtable>
-BaiduMessage_Data <Hashtable>
-DefaultPushNotificationMessage_Data <Hashtable>
-RawEmail_Data <Byte[]>
-HtmlPart_Data <String>
-Subject_Data <String>
-TextPart_Data <String>
-GCMMessage_Data <Hashtable>
-MessageRequest_Endpoint <Hashtable>
-ADMMessage_ExpiresAfter <String>
-EmailMessage_FeedbackForwardingAddress <String>
-EmailMessage_FromAddress <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>
-SMSMessage_Keyword <String>
-VoiceMessage_LanguageCode <String>
-ADMMessage_MD5 <String>
-APNSMessage_MediaUrl <String>
-SMSMessage_MessageType <MessageType>
-SMSMessage_OriginationNumber <String>
-VoiceMessage_OriginationNumber <String>
-APNSMessage_PreferredAuthenticationMethod <String>
-APNSMessage_Priority <String>
-GCMMessage_Priority <String>
-ADMMessage_RawContent <String>
-APNSMessage_RawContent <String>
-BaiduMessage_RawContent <String>
-GCMMessage_RawContent <String>
-EmailMessage_ReplyToAddress <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>
-EmailMessage_Substitution <Hashtable>
-GCMMessage_Substitution <Hashtable>
-SMSMessage_Substitution <Hashtable>
-VoiceMessage_Substitution <Hashtable>
-APNSMessage_ThreadId <String>
-APNSMessage_TimeToLive <Int32>
-BaiduMessage_TimeToLive <Int32>
-GCMMessage_TimeToLive <Int32>
-ADMMessage_Title <String>
-APNSMessage_Title <String>
-BaiduMessage_Title <String>
-DefaultPushNotificationMessage_Title <String>
-GCMMessage_Title <String>
-MessageRequest_TraceId <String>
-ADMMessage_Url <String>
-APNSMessage_Url <String>
-BaiduMessage_Url <String>
-DefaultPushNotificationMessage_Url <String>
-GCMMessage_Url <String>
-VoiceMessage_VoiceId <String>
-Force <SwitchParameter>

Description

Used to send a direct message.

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
AliasesMessageRequest_MessageConfiguration_ADMMessage_Action
-ADMMessage_Body <String>
The message body of the notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_ADMMessage_Body
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_ConsolidationKey
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_Data
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_ExpiresAfter
-ADMMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_ADMMessage_IconReference
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_ImageIconUrl
-ADMMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_ADMMessage_ImageUrl
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_MD5
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_RawContent
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_SilentPush
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_SmallImageIconUrl
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_Sound
-ADMMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_ADMMessage_Substitutions
-ADMMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_ADMMessage_Title
-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
AliasesMessageRequest_MessageConfiguration_ADMMessage_Url
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Action
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Badge
-APNSMessage_Body <String>
The message body of the notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_Body
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Category
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_CollapseId
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Data
-APNSMessage_MediaUrl <String>
A URL that refers to the location of an image or video that you want to display in the push notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_MediaUrl
-APNSMessage_PreferredAuthenticationMethod <String>
The preferred authentication method, either "CERTIFICATE" or "TOKEN"
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_PreferredAuthenticationMethod
-APNSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_Priority
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_RawContent
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_SilentPush
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Sound
-APNSMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_Substitutions
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_ThreadId
-APNSMessage_TimeToLive <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_TimeToLive
-APNSMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_APNSMessage_Title
-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
AliasesMessageRequest_MessageConfiguration_APNSMessage_Url
-ApplicationId <String>
The unique ID of your Amazon Pinpoint application.
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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Action
-BaiduMessage_Body <String>
The message body of the notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Body
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Data
-BaiduMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_IconReference
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_ImageIconUrl
-BaiduMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_ImageUrl
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_RawContent
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_SilentPush
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_SmallImageIconUrl
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Sound
-BaiduMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Substitutions
-BaiduMessage_TimeToLive <Int32>
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)
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_TimeToLive
-BaiduMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Title
-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
AliasesMessageRequest_MessageConfiguration_BaiduMessage_Url
-DefaultMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultMessage_Body
-DefaultMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultMessage_Substitutions
-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
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Action
-DefaultPushNotificationMessage_Body <String>
The message body of the notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Body
-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
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Data
-DefaultPushNotificationMessage_SilentPush <Boolean>
Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_SilentPush
-DefaultPushNotificationMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Substitutions
-DefaultPushNotificationMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Title
-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
AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Url
-EmailMessage_Body <String>
The body of the email message.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_Body
-EmailMessage_FeedbackForwardingAddress <String>
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_FeedbackForwardingAddress
-EmailMessage_FromAddress <String>
The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_FromAddress
-EmailMessage_ReplyToAddress <String[]>
The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_ReplyToAddresses
-EmailMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_Substitutions
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_Action
-GCMMessage_Body <String>
The message body of the notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_Body
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_CollapseKey
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_Data
-GCMMessage_IconReference <String>
The icon image name of the asset saved in your application.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_IconReference
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_ImageIconUrl
-GCMMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_ImageUrl
-GCMMessage_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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_Priority
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_RawContent
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_RestrictedPackageName
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_SilentPush
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_SmallImageIconUrl
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_Sound
-GCMMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_Substitutions
-GCMMessage_TimeToLive <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_TimeToLive
-GCMMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_GCMMessage_Title
-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
AliasesMessageRequest_MessageConfiguration_GCMMessage_Url
-HtmlPart_Charset <String>
The character set of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_HtmlPart_Charset
-HtmlPart_Data <String>
The textual data of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_HtmlPart_Data
-MessageRequest_Address <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_Addresses
-MessageRequest_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
-MessageRequest_Endpoint <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_Endpoints
-MessageRequest_TraceId <String>
A unique ID that you can use to trace a message. This ID is visible to recipients.
Required?False
Position?Named
Accept pipeline input?False
-RawEmail_Data <Byte[]>
The raw email message itself. Then entire message must be base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_RawEmail_Data
-SMSMessage_Body <String>
The body of the SMS message.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_Body
-SMSMessage_Keyword <String>
The SMS program name that you provided to AWS Support when you requested your dedicated number.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_Keyword
-SMSMessage_MessageType <MessageType>
Is this a transaction priority message or lower priority.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_MessageType
-SMSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_OriginationNumber
-SMSMessage_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.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_SenderId
-SMSMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_SMSMessage_Substitutions
-Subject_Charset <String>
The character set of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_Subject_Charset
-Subject_Data <String>
The textual data of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_Subject_Data
-TextPart_Charset <String>
The character set of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_TextPart_Charset
-TextPart_Data <String>
The textual data of the content.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_TextPart_Data
-VoiceMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_VoiceMessage_Body
-VoiceMessage_LanguageCode <String>
Language of sent message
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_VoiceMessage_LanguageCode
-VoiceMessage_OriginationNumber <String>
Is the number from the pool or messaging service to send from.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_VoiceMessage_OriginationNumber
-VoiceMessage_Substitution <Hashtable>
Default message substitutions. Can be overridden by individual address substitutions.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_VoiceMessage_Substitutions
-VoiceMessage_VoiceId <String>
Voice ID of sent message.
Required?False
Position?Named
Accept pipeline input?False
AliasesMessageRequest_MessageConfiguration_VoiceMessage_VoiceId

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 MessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendMessagesResponse) 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