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

Syntax

New-PINCampaign
-ApplicationId <String>
-ADMMessage_Action <Action>
-APNSMessage_Action <Action>
-BaiduMessage_Action <Action>
-DefaultMessage_Action <Action>
-GCMMessage_Action <Action>
-WriteCampaignRequest_AdditionalTreatment <WriteTreatmentResource[]>
-Dimensions_Attribute <Hashtable>
-ADMMessage_Body <String>
-APNSMessage_Body <String>
-BaiduMessage_Body <String>
-DefaultMessage_Body <String>
-EmailMessage_Body <String>
-GCMMessage_Body <String>
-InAppMessage_Body <String>
-SMSMessage_Body <String>
-InAppMessage_Content <InAppMessageContent[]>
-InAppMessage_CustomConfig <Hashtable>
-Limits_Daily <Int32>
-CustomMessage_Data <String>
-CustomDeliveryConfiguration_DeliveryUri <String>
-WriteCampaignRequest_Description <String>
-EventType_DimensionType <DimensionType>
-QuietTime_End <String>
-CustomDeliveryConfiguration_EndpointType <String[]>
-Schedule_EndTime <String>
-SMSMessage_EntityId <String>
-EventFilter_FilterType <FilterType>
-Schedule_Frequency <Frequency>
-EmailMessage_FromAddress <String>
-WriteCampaignRequest_HoldoutPercent <Int32>
-EmailMessage_HtmlBody <String>
-ADMMessage_ImageIconUrl <String>
-APNSMessage_ImageIconUrl <String>
-BaiduMessage_ImageIconUrl <String>
-DefaultMessage_ImageIconUrl <String>
-GCMMessage_ImageIconUrl <String>
-ADMMessage_ImageSmallIconUrl <String>
-APNSMessage_ImageSmallIconUrl <String>
-BaiduMessage_ImageSmallIconUrl <String>
-DefaultMessage_ImageSmallIconUrl <String>
-GCMMessage_ImageSmallIconUrl <String>
-ADMMessage_ImageUrl <String>
-APNSMessage_ImageUrl <String>
-BaiduMessage_ImageUrl <String>
-DefaultMessage_ImageUrl <String>
-GCMMessage_ImageUrl <String>
-Schedule_IsLocalTime <Boolean>
-WriteCampaignRequest_IsPaused <Boolean>
-ADMMessage_JsonBody <String>
-APNSMessage_JsonBody <String>
-BaiduMessage_JsonBody <String>
-DefaultMessage_JsonBody <String>
-GCMMessage_JsonBody <String>
-Hook_LambdaFunctionName <String>
-InAppMessage_Layout <Layout>
-Limits_MaximumDuration <Int32>
-ADMMessage_MediaUrl <String>
-APNSMessage_MediaUrl <String>
-BaiduMessage_MediaUrl <String>
-DefaultMessage_MediaUrl <String>
-GCMMessage_MediaUrl <String>
-Limits_MessagesPerSecond <Int32>
-SMSMessage_MessageType <MessageType>
-Dimensions_Metric <Hashtable>
-Hook_Mode <Mode>
-WriteCampaignRequest_Name <String>
-EmailTemplate_Name <String>
-InAppTemplate_Name <String>
-PushTemplate_Name <String>
-SMSTemplate_Name <String>
-VoiceTemplate_Name <String>
-SMSMessage_OriginationNumber <String>
-WriteCampaignRequest_Priority <Int32>
-ADMMessage_RawContent <String>
-APNSMessage_RawContent <String>
-BaiduMessage_RawContent <String>
-DefaultMessage_RawContent <String>
-GCMMessage_RawContent <String>
-WriteCampaignRequest_SegmentId <String>
-WriteCampaignRequest_SegmentVersion <Int32>
-SMSMessage_SenderId <String>
-Limits_Session <Int32>
-ADMMessage_SilentPush <Boolean>
-APNSMessage_SilentPush <Boolean>
-BaiduMessage_SilentPush <Boolean>
-DefaultMessage_SilentPush <Boolean>
-GCMMessage_SilentPush <Boolean>
-QuietTime_Start <String>
-Schedule_StartTime <String>
-WriteCampaignRequest_Tag <Hashtable>
-SMSMessage_TemplateId <String>
-ADMMessage_TimeToLive <Int32>
-APNSMessage_TimeToLive <Int32>
-BaiduMessage_TimeToLive <Int32>
-DefaultMessage_TimeToLive <Int32>
-GCMMessage_TimeToLive <Int32>
-Schedule_Timezone <String>
-ADMMessage_Title <String>
-APNSMessage_Title <String>
-BaiduMessage_Title <String>
-DefaultMessage_Title <String>
-EmailMessage_Title <String>
-GCMMessage_Title <String>
-Limits_Total <Int32>
-WriteCampaignRequest_TreatmentDescription <String>
-WriteCampaignRequest_TreatmentName <String>
-ADMMessage_Url <String>
-APNSMessage_Url <String>
-BaiduMessage_Url <String>
-DefaultMessage_Url <String>
-GCMMessage_Url <String>
-EventType_Value <String[]>
-EmailTemplate_Version <String>
-InAppTemplate_Version <String>
-PushTemplate_Version <String>
-SMSTemplate_Version <String>
-VoiceTemplate_Version <String>
-Hook_WebUrl <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointConfig>

Description

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Parameters

-ADMMessage_Action <Action>
The 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 iOS and Android.
  • 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)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_Action
-ADMMessage_Body <String>
The body of the notification message. The maximum number of characters is 200.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_Body
-ADMMessage_ImageIconUrl <String>
The URL of the image to display as the push-notification icon, such as the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_ImageIconUrl
-ADMMessage_ImageSmallIconUrl <String>
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_ImageSmallIconUrl
-ADMMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_ImageUrl
-ADMMessage_JsonBody <String>
The JSON payload to use for a silent push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_JsonBody
-ADMMessage_MediaUrl <String>
The URL of the image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_MediaUrl
-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)
AliasesWriteCampaignRequest_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, displaying messages in an in-app message center, or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_SilentPush
-ADMMessage_TimeToLive <Int32>
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_TimeToLive
-ADMMessage_Title <String>
The title to display above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_Title
-ADMMessage_Url <String>
The 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)
AliasesWriteCampaignRequest_MessageConfiguration_ADMMessage_Url
-APNSMessage_Action <Action>
The 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 iOS and Android.
  • 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)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_Action
-APNSMessage_Body <String>
The body of the notification message. The maximum number of characters is 200.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_Body
-APNSMessage_ImageIconUrl <String>
The URL of the image to display as the push-notification icon, such as the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_ImageIconUrl
-APNSMessage_ImageSmallIconUrl <String>
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_ImageSmallIconUrl
-APNSMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_ImageUrl
-APNSMessage_JsonBody <String>
The JSON payload to use for a silent push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_JsonBody
-APNSMessage_MediaUrl <String>
The URL of the image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_MediaUrl
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_RawContent
-APNSMessage_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, displaying messages in an in-app message center, or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_SilentPush
-APNSMessage_TimeToLive <Int32>
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_TimeToLive
-APNSMessage_Title <String>
The title to display above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_APNSMessage_Title
-APNSMessage_Url <String>
The 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)
AliasesWriteCampaignRequest_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 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 iOS and Android.
  • 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)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_Action
-BaiduMessage_Body <String>
The body of the notification message. The maximum number of characters is 200.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_Body
-BaiduMessage_ImageIconUrl <String>
The URL of the image to display as the push-notification icon, such as the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_ImageIconUrl
-BaiduMessage_ImageSmallIconUrl <String>
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_ImageSmallIconUrl
-BaiduMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_ImageUrl
-BaiduMessage_JsonBody <String>
The JSON payload to use for a silent push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_JsonBody
-BaiduMessage_MediaUrl <String>
The URL of the image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_MediaUrl
-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)
AliasesWriteCampaignRequest_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, displaying messages in an in-app message center, or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_SilentPush
-BaiduMessage_TimeToLive <Int32>
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_TimeToLive
-BaiduMessage_Title <String>
The title to display above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_Title
-BaiduMessage_Url <String>
The 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)
AliasesWriteCampaignRequest_MessageConfiguration_BaiduMessage_Url
-ClientConfig <AmazonPinpointConfig>
Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomDeliveryConfiguration_DeliveryUri <String>
The destination to send the campaign or treatment to. This value can be one of the following:
  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_CustomDeliveryConfiguration_DeliveryUri
-CustomDeliveryConfiguration_EndpointType <String[]>
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_CustomDeliveryConfiguration_EndpointTypes
-CustomMessage_Data <String>
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_CustomMessage_Data
-DefaultMessage_Action <Action>
The 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 iOS and Android.
  • 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)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_Action
-DefaultMessage_Body <String>
The body of the notification message. The maximum number of characters is 200.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_Body
-DefaultMessage_ImageIconUrl <String>
The URL of the image to display as the push-notification icon, such as the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_ImageIconUrl
-DefaultMessage_ImageSmallIconUrl <String>
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_ImageSmallIconUrl
-DefaultMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_ImageUrl
-DefaultMessage_JsonBody <String>
The JSON payload to use for a silent push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_JsonBody
-DefaultMessage_MediaUrl <String>
The URL of the image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_MediaUrl
-DefaultMessage_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)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_RawContent
-DefaultMessage_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, displaying messages in an in-app message center, or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_SilentPush
-DefaultMessage_TimeToLive <Int32>
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_TimeToLive
-DefaultMessage_Title <String>
The title to display above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_Title
-DefaultMessage_Url <String>
The 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)
AliasesWriteCampaignRequest_MessageConfiguration_DefaultMessage_Url
-Dimensions_Attribute <Hashtable>
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EventFilter_Dimensions_Attributes
-Dimensions_Metric <Hashtable>
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EventFilter_Dimensions_Metrics
-EmailMessage_Body <String>
The body of the email for recipients whose email clients don't render HTML content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_EmailMessage_Body
-EmailMessage_FromAddress <String>
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_EmailMessage_FromAddress
-EmailMessage_HtmlBody <String>
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_EmailMessage_HtmlBody
-EmailMessage_Title <String>
The subject line, or title, of the email.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_EmailMessage_Title
-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)
AliasesWriteCampaignRequest_TemplateConfiguration_EmailTemplate_Name
-EmailTemplate_Version <String>
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_TemplateConfiguration_EmailTemplate_Version
-EventFilter_FilterType <FilterType>
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EventFilter_FilterType
-EventType_DimensionType <DimensionType>
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EventFilter_Dimensions_EventType_DimensionType
-EventType_Value <String[]>
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EventFilter_Dimensions_EventType_Values
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GCMMessage_Action <Action>
The 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 iOS and Android.
  • 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)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_Action
-GCMMessage_Body <String>
The body of the notification message. The maximum number of characters is 200.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_Body
-GCMMessage_ImageIconUrl <String>
The URL of the image to display as the push-notification icon, such as the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_ImageIconUrl
-GCMMessage_ImageSmallIconUrl <String>
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_ImageSmallIconUrl
-GCMMessage_ImageUrl <String>
The URL of an image to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_ImageUrl
-GCMMessage_JsonBody <String>
The JSON payload to use for a silent push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_JsonBody
-GCMMessage_MediaUrl <String>
The URL of the image or video to display in the push notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_MediaUrl
-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)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_RawContent
-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, displaying messages in an in-app message center, or supporting phone home functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_SilentPush
-GCMMessage_TimeToLive <Int32>
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_TimeToLive
-GCMMessage_Title <String>
The title to display above the notification message on a recipient's device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_Title
-GCMMessage_Url <String>
The 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)
AliasesWriteCampaignRequest_MessageConfiguration_GCMMessage_Url
-Hook_LambdaFunctionName <String>
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Hook_LambdaFunctionName
-Hook_Mode <Mode>
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
  • FILTER - Invoke the function to customize the segment that's used by a campaign.
  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Hook_Mode
-Hook_WebUrl <String>
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Hook_WebUrl
-InAppMessage_Body <String>
The message body of the notification, the email body or the text message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_InAppMessage_Body
-InAppMessage_Content <InAppMessageContent[]>
In-app message content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_InAppMessage_Content
-InAppMessage_CustomConfig <Hashtable>
Custom config to be sent to client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_InAppMessage_CustomConfig
-InAppMessage_Layout <Layout>
In-app message layout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_InAppMessage_Layout
-InAppTemplate_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)
AliasesWriteCampaignRequest_TemplateConfiguration_InAppTemplate_Name
-InAppTemplate_Version <String>
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_TemplateConfiguration_InAppTemplate_Version
-Limits_Daily <Int32>
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Limits_Daily
-Limits_MaximumDuration <Int32>
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Limits_MaximumDuration
-Limits_MessagesPerSecond <Int32>
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Limits_MessagesPerSecond
-Limits_Session <Int32>
The maximum total number of messages that the campaign can send per user session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Limits_Session
-Limits_Total <Int32>
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Limits_Total
-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)
AliasesWriteCampaignRequest_TemplateConfiguration_PushTemplate_Name
-PushTemplate_Version <String>
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_TemplateConfiguration_PushTemplate_Version
-QuietTime_End <String>
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_QuietTime_End
-QuietTime_Start <String>
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_QuietTime_Start
-Schedule_EndTime <String>
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_EndTime
-Schedule_Frequency <Frequency>
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_Frequency
-Schedule_IsLocalTime <Boolean>
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_IsLocalTime
-Schedule_StartTime <String>
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_StartTime
-Schedule_Timezone <String>
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Schedule_Timezone
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'CampaignResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateCampaignResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateCampaignResponse 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)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_Body
-SMSMessage_EntityId <String>
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_EntityId
-SMSMessage_MessageType <MessageType>
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_MessageType
-SMSMessage_OriginationNumber <String>
The long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_OriginationNumber
-SMSMessage_SenderId <String>
The sender ID to display on recipients' devices when they receive the SMS message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_SenderId
-SMSMessage_TemplateId <String>
The template ID received from the regulatory body for sending SMS in your country.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_MessageConfiguration_SMSMessage_TemplateId
-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)
AliasesWriteCampaignRequest_TemplateConfiguration_SMSTemplate_Name
-SMSTemplate_Version <String>
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_TemplateConfiguration_SMSTemplate_Version
-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)
AliasesWriteCampaignRequest_TemplateConfiguration_VoiceTemplate_Name
-VoiceTemplate_Version <String>
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_TemplateConfiguration_VoiceTemplate_Version
-WriteCampaignRequest_AdditionalTreatment <WriteTreatmentResource[]>
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_AdditionalTreatments
-WriteCampaignRequest_Description <String>
A custom description of the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_HoldoutPercent <Int32>
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_IsPaused <Boolean>
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_Name <String>
A custom name for the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_Priority <Int32>
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_SegmentId <String>
The unique identifier for the segment to associate with the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_SegmentVersion <Int32>
The version of the segment to associate with the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_Tag <Hashtable>
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteCampaignRequest_Tags
-WriteCampaignRequest_TreatmentDescription <String>
A custom description of the default treatment for the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCampaignRequest_TreatmentName <String>
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

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

Outputs

Amazon.Pinpoint.Model.CampaignResponse or Amazon.Pinpoint.Model.CreateCampaignResponse
This cmdlet returns an Amazon.Pinpoint.Model.CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.CreateCampaignResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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