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

Invokes the CreateCampaign operation against Amazon Pinpoint.

Syntax

New-PINCampaign
-ApplicationId <String>
-APNSMessage_Action <Action>
-DefaultMessage_Action <Action>
-GCMMessage_Action <Action>
-WriteCampaignRequest_AdditionalTreatment <WriteTreatmentResource[]>
-APNSMessage_Body <String>
-DefaultMessage_Body <String>
-EmailMessage_Body <String>
-GCMMessage_Body <String>
-SMSMessage_Body <String>
-Limits_Daily <Int32>
-WriteCampaignRequest_Description <String>
-QuietTime_End <String>
-Schedule_EndTime <String>
-Schedule_Frequency <Frequency>
-EmailMessage_FromAddress <String>
-WriteCampaignRequest_HoldoutPercent <Int32>
-EmailMessage_HtmlBody <String>
-APNSMessage_ImageIconUrl <String>
-DefaultMessage_ImageIconUrl <String>
-GCMMessage_ImageIconUrl <String>
-APNSMessage_ImageSmallIconUrl <String>
-DefaultMessage_ImageSmallIconUrl <String>
-GCMMessage_ImageSmallIconUrl <String>
-APNSMessage_ImageUrl <String>
-DefaultMessage_ImageUrl <String>
-GCMMessage_ImageUrl <String>
-Schedule_IsLocalTime <Boolean>
-WriteCampaignRequest_IsPaused <Boolean>
-APNSMessage_JsonBody <String>
-DefaultMessage_JsonBody <String>
-GCMMessage_JsonBody <String>
-APNSMessage_MediaUrl <String>
-DefaultMessage_MediaUrl <String>
-GCMMessage_MediaUrl <String>
-SMSMessage_MessageType <MessageType>
-WriteCampaignRequest_Name <String>
-APNSMessage_RawContent <String>
-DefaultMessage_RawContent <String>
-GCMMessage_RawContent <String>
-WriteCampaignRequest_SegmentId <String>
-WriteCampaignRequest_SegmentVersion <Int32>
-SMSMessage_SenderId <String>
-APNSMessage_SilentPush <Boolean>
-DefaultMessage_SilentPush <Boolean>
-GCMMessage_SilentPush <Boolean>
-QuietTime_Start <String>
-Schedule_StartTime <String>
-Schedule_Timezone <String>
-APNSMessage_Title <String>
-DefaultMessage_Title <String>
-EmailMessage_Title <String>
-GCMMessage_Title <String>
-Limits_Total <Int32>
-WriteCampaignRequest_TreatmentDescription <String>
-WriteCampaignRequest_TreatmentName <String>
-APNSMessage_Url <String>
-DefaultMessage_Url <String>
-GCMMessage_Url <String>
-Force <SwitchParameter>

Description

Creates or updates a campaign.

Parameters

-APNSMessage_Action <Action>
The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Body <String>
The message body. Can include up to 140 characters.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_ImageIconUrl <String>
The URL that points to the icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_ImageSmallIconUrl <String>
The URL that points to the small icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_JsonBody <String>
The JSON payload used for a silent push.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_MediaUrl <String>
The URL that points to the media resource, for example a .mp4 or .gif file.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_SilentPush <Boolean>
Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-APNSMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-ApplicationId <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DefaultMessage_Action <Action>
The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_Body <String>
The message body. Can include up to 140 characters.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_ImageIconUrl <String>
The URL that points to the icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_ImageSmallIconUrl <String>
The URL that points to the small icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_JsonBody <String>
The JSON payload used for a silent push.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_MediaUrl <String>
The URL that points to the media resource, for example a .mp4 or .gif file.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_SilentPush <Boolean>
Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-DefaultMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-EmailMessage_Body <String>
The email text body.
Required?False
Position?Named
Accept pipeline input?False
-EmailMessage_FromAddress <String>
The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
Required?False
Position?Named
Accept pipeline input?False
-EmailMessage_HtmlBody <String>
The email html body.
Required?False
Position?Named
Accept pipeline input?False
-EmailMessage_Title <String>
The email title (Or subject).
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Action <Action>
The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Body <String>
The message body. Can include up to 140 characters.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_ImageIconUrl <String>
The URL that points to the icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_ImageSmallIconUrl <String>
The URL that points to the small icon image for the push notification icon, for example, the app icon.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_ImageUrl <String>
The URL that points to an image used in the push notification.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_JsonBody <String>
The JSON payload used for a silent push.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_MediaUrl <String>
The URL that points to the media resource, for example a .mp4 or .gif file.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_RawContent <String>
The Raw JSON formatted string to be used as the payload. This value overrides the message.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_SilentPush <Boolean>
Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Title <String>
The message title that displays above the message on the user's device.
Required?False
Position?Named
Accept pipeline input?False
-GCMMessage_Url <String>
The URL to open in the user's mobile browser. Used if the value for Action is URL.
Required?False
Position?Named
Accept pipeline input?False
-Limits_Daily <Int32>
The maximum number of messages that the campaign can send daily.
Required?False
Position?Named
Accept pipeline input?False
-Limits_Total <Int32>
The maximum total number of messages that the campaign can send.
Required?False
Position?Named
Accept pipeline input?False
-QuietTime_End <String>
The default end time for quiet time in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?False
-QuietTime_Start <String>
The default start time for quiet time in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?False
-Schedule_EndTime <String>
The scheduled time that the campaign ends in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?False
-Schedule_Frequency <Frequency>
How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
Required?False
Position?Named
Accept pipeline input?False
-Schedule_IsLocalTime <Boolean>
Indicates whether the campaign schedule takes effect according to each user's local time.
Required?False
Position?Named
Accept pipeline input?False
-Schedule_StartTime <String>
The scheduled time that the campaign begins in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?False
-Schedule_Timezone <String>
The starting UTC offset for the schedule if the value for isLocalTime is trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_Body <String>
The SMS text body.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_MessageType <MessageType>
Is this is a transactional SMS message, otherwise a promotional message.
Required?False
Position?Named
Accept pipeline input?False
-SMSMessage_SenderId <String>
Sender ID of sent message.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_AdditionalTreatment <WriteTreatmentResource[]>
Treatments that are defined in addition to the default treatment.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_Description <String>
A description of the campaign.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_HoldoutPercent <Int32>
The allocated percentage of end users who will not receive messages from this campaign.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_IsPaused <Boolean>
Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_Name <String>
The custom name of the campaign.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_SegmentId <String>
The ID of the segment to which the campaign sends messages.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_SegmentVersion <Int32>
The version of the segment to which the campaign sends messages.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_TreatmentDescription <String>
A custom description for the treatment.
Required?False
Position?Named
Accept pipeline input?False
-WriteCampaignRequest_TreatmentName <String>
The custom name of a variation of the campaign used for A/B testing.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

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

Outputs

This cmdlet returns a 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.

Supported Version

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