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_APNSPushType <String>
-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>
-EmailTemplate_Name <String>
-PushTemplate_Name <String>
-SMSTemplate_Name <String>
-VoiceTemplate_Name <String>
-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>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates and sends a direct message.

Parameters

-ADMMessage_Action <Action>
The action to occur if the recipient taps the push notification. 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)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Action
-ADMMessage_Body <String>
The body of the notification message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Body
-ADMMessage_ConsolidationKey <String>
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_ConsolidationKey
-ADMMessage_Data <Hashtable>
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Data
-ADMMessage_ExpiresAfter <String>
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_ExpiresAfter
-ADMMessage_IconReference <String>
The icon image name of the asset saved in your app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_IconReference
-ADMMessage_ImageIconUrl <String>
The URL of the large icon image to display in the content view of the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_ImageIconUrl
-ADMMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_ImageUrl
-ADMMessage_MD5 <String>
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_MD5
-ADMMessage_RawContent <String>
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_RawContent
-ADMMessage_SilentPush <Boolean>
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_SilentPush
-ADMMessage_SmallImageIconUrl <String>
The URL of the small icon image to display in the status bar and the content view of the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_SmallImageIconUrl
-ADMMessage_Sound <String>
The sound to play when the recipient receives the push notification. 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)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Sound
-ADMMessage_Substitution <Hashtable>
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Substitutions
-ADMMessage_Title <String>
The title to display above the notification message on the recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Title
-ADMMessage_Url <String>
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_ADMMessage_Url
-APNSMessage_Action <Action>
The action to occur if the recipient taps the push notification. 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)
AliasesMessageRequest_MessageConfiguration_APNSMessage_Action
-APNSMessage_APNSPushType <String>
The type of push notification to send. Valid values are:
  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
  • complication - For a notification that contains update information for an app’s complication timeline.
  • fileprovider - For a notification that signals changes to a File Provider extension.
  • mdm - For a notification that tells managed devices to contact the MDM server.
  • voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_APNSPushType
-APNSMessage_Badge <Int32>
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_Badge
-APNSMessage_Body <String>
The body of the notification message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_Body
-APNSMessage_Category <String>
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_Category
-APNSMessage_CollapseId <String>
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_CollapseId
-APNSMessage_Data <Hashtable>
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_Data
-APNSMessage_MediaUrl <String>
The URL of an image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_MediaUrl
-APNSMessage_PreferredAuthenticationMethod <String>
The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessageRequest_MessageConfiguration_APNSMessage_PreferredAuthenticationMethod
-APNSMessage_Priority <String>
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. /listitem>
  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.
  • /para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_Priority
    -APNSMessage_RawContent <String>
    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_RawContent
    -APNSMessage_SilentPush <Boolean>
    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_SilentPush
    -APNSMessage_Sound <String>
    The key for the sound to play when the recipient receives the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_Sound
    -APNSMessage_Substitution <Hashtable>
    The default message variables to use in the notification message. You can override these default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_Substitutions
    -APNSMessage_ThreadId <String>
    The key that represents your 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?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_ThreadId
    -APNSMessage_TimeToLive <Int32>
    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_TimeToLive
    -APNSMessage_Title <String>
    The title to display above the notification message on the recipient's device.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_Title
    -APNSMessage_Url <String>
    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_APNSMessage_Url
    -ApplicationId <String>
    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
    Required?True
    Position?1
    Accept pipeline input?True (ByValue, ByPropertyName)
    -BaiduMessage_Action <Action>
    The action to occur if the recipient taps the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Action
    -BaiduMessage_Body <String>
    The body of the notification message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Body
    -BaiduMessage_Data <Hashtable>
    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Data
    -BaiduMessage_IconReference <String>
    The icon image name of the asset saved in your app.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_IconReference
    -BaiduMessage_ImageIconUrl <String>
    The URL of the large icon image to display in the content view of the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_ImageIconUrl
    -BaiduMessage_ImageUrl <String>
    The URL of an image to display in the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_ImageUrl
    -BaiduMessage_RawContent <String>
    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_RawContent
    -BaiduMessage_SilentPush <Boolean>
    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_SilentPush
    -BaiduMessage_SmallImageIconUrl <String>
    The URL of the small icon image to display in the status bar and the content view of the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_SmallImageIconUrl
    -BaiduMessage_Sound <String>
    The sound to play when the recipient receives the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Sound
    -BaiduMessage_Substitution <Hashtable>
    The default message variables to use in the notification message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Substitutions
    -BaiduMessage_TimeToLive <Int32>
    The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_TimeToLive
    -BaiduMessage_Title <String>
    The title to display above the notification message on the recipient's device.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Title
    -BaiduMessage_Url <String>
    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_BaiduMessage_Url
    -DefaultMessage_Body <String>
    The default body of the message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultMessage_Body
    -DefaultMessage_Substitution <Hashtable>
    The default message variables to use in the message. You can override these default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultMessage_Substitutions
    -DefaultPushNotificationMessage_Action <Action>
    The default action to occur if a recipient taps the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Action
    -DefaultPushNotificationMessage_Body <String>
    The default body of the notification message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Body
    -DefaultPushNotificationMessage_Data <Hashtable>
    The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Data
    -DefaultPushNotificationMessage_SilentPush <Boolean>
    Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_SilentPush
    -DefaultPushNotificationMessage_Substitution <Hashtable>
    The default message variables to use in the notification message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Substitutions
    -DefaultPushNotificationMessage_Title <String>
    The default title to display above the notification message on a recipient's device.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Title
    -DefaultPushNotificationMessage_Url <String>
    The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_DefaultPushNotificationMessage_Url
    -EmailMessage_Body <String>
    The body of the email message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_Body
    -EmailMessage_FeedbackForwardingAddress <String>
    The email address to forward bounces and complaints to, if feedback forwarding is enabled.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_FeedbackForwardingAddress
    -EmailMessage_FromAddress <String>
    The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_FromAddress
    -EmailMessage_ReplyToAddress <String[]>
    The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_ReplyToAddresses
    -EmailMessage_Substitution <Hashtable>
    The default message variables to use in the email message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_Substitutions
    -EmailTemplate_Name <String>
    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_TemplateConfiguration_EmailTemplate_Name
    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)
    -GCMMessage_Action <Action>
    The action to occur if the recipient taps the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Action
    -GCMMessage_Body <String>
    The body of the notification message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Body
    -GCMMessage_CollapseKey <String>
    An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_CollapseKey
    -GCMMessage_Data <Hashtable>
    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Data
    -GCMMessage_IconReference <String>
    The icon image name of the asset saved in your app.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_IconReference
    -GCMMessage_ImageIconUrl <String>
    The URL of the large icon image to display in the content view of the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_ImageIconUrl
    -GCMMessage_ImageUrl <String>
    The URL of an image to display in the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_ImageUrl
    -GCMMessage_Priority <String>
    para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required. /listitem>
  • high - The notification is sent immediately and might wake a sleeping device.
  • /para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Priority
    -GCMMessage_RawContent <String>
    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_RawContent
    -GCMMessage_RestrictedPackageName <String>
    The package name of the application where registration tokens must match in order for the recipient to receive the message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_RestrictedPackageName
    -GCMMessage_SilentPush <Boolean>
    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_SilentPush
    -GCMMessage_SmallImageIconUrl <String>
    The URL of the small icon image to display in the status bar and the content view of the push notification.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_SmallImageIconUrl
    -GCMMessage_Sound <String>
    The sound to play when the recipient receives the push notification. 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)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Sound
    -GCMMessage_Substitution <Hashtable>
    The default message variables to use in the notification message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Substitutions
    -GCMMessage_TimeToLive <Int32>
    The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_TimeToLive
    -GCMMessage_Title <String>
    The title to display above the notification message on the recipient's device.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Title
    -GCMMessage_Url <String>
    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_GCMMessage_Url
    -HtmlPart_Charset <String>
    The applicable character set for the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_HtmlPart_Charset
    -HtmlPart_Data <String>
    The textual data of the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    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. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_Addresses
    -MessageRequest_Context <Hashtable>
    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    -MessageRequest_Endpoint <Hashtable>
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_Endpoints
    -MessageRequest_TraceId <String>
    The unique identifier for tracing the message. This identifier is visible to message recipients.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    -PassThru <SwitchParameter>
    Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    -PushTemplate_Name <String>
    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_TemplateConfiguration_PushTemplate_Name
    -RawEmail_Data <Byte[]>
    The email message, represented as a raw MIME message. The entire message must be base64 encoded.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_RawEmail_Data
    -Select <String>
    Use the -Select parameter to control the cmdlet output. The default value is 'MessageResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.SendMessagesResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.SendMessagesResponse 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)
    -SMSMessage_Body <String>
    The body of the SMS message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    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?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_SMSMessage_Keyword
    -SMSMessage_MessageType <MessageType>
    The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_SMSMessage_MessageType
    -SMSMessage_OriginationNumber <String>
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_SMSMessage_OriginationNumber
    -SMSMessage_SenderId <String>
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_SMSMessage_SenderId
    -SMSMessage_Substitution <Hashtable>
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_SMSMessage_Substitutions
    -SMSTemplate_Name <String>
    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_TemplateConfiguration_SMSTemplate_Name
    -Subject_Charset <String>
    The applicable character set for the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_Subject_Charset
    -Subject_Data <String>
    The textual data of the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_Subject_Data
    -TextPart_Charset <String>
    The applicable character set for the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_TextPart_Charset
    -TextPart_Data <String>
    The textual data of the message content.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_EmailMessage_SimpleEmail_TextPart_Data
    -VoiceMessage_Body <String>
    The text of the script to use for the voice message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_VoiceMessage_Body
    -VoiceMessage_LanguageCode <String>
    The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_VoiceMessage_LanguageCode
    -VoiceMessage_OriginationNumber <String>
    The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_VoiceMessage_OriginationNumber
    -VoiceMessage_Substitution <Hashtable>
    The default message variables to use in the voice message. You can override the default variables with individual address variables.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_VoiceMessage_Substitutions
    -VoiceMessage_VoiceId <String>
    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_MessageConfiguration_VoiceMessage_VoiceId
    -VoiceTemplate_Name <String>
    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
    Required?False
    Position?Named
    Accept pipeline input?True (ByPropertyName)
    AliasesMessageRequest_TemplateConfiguration_VoiceTemplate_Name

    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)
    Aliases AK
    -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 (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. 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? True (ByPropertyName)
    Aliases AWSProfilesLocation, 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)
    Aliases AWSProfileName, StoredCredentials
    -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 (ByPropertyName)
    -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)
    Aliases SecretAccessKey, SK
    -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)
    Aliases ST
    -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? True (ByPropertyName)
    Aliases RegionToCall
    -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)

    Inputs

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

    Outputs

    This cmdlet returns an Amazon.Pinpoint.Model.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