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

Syntax

New-PINJourney
-ApplicationId <String>
-WriteJourneyRequest_Activity <Hashtable>
-WriteJourneyRequest_CreationDate <String>
-Limits_DailyCap <Int32>
-StartCondition_Description <String>
-QuietTime_End <String>
-Limits_EndpointReentryCap <Int32>
-Schedule_EndTime <DateTime>
-WriteJourneyRequest_LastModifiedDate <String>
-WriteJourneyRequest_LocalTime <Boolean>
-Limits_MessagesPerSecond <Int32>
-WriteJourneyRequest_Name <String>
-WriteJourneyRequest_RefreshFrequency <String>
-SegmentStartCondition_SegmentId <String>
-QuietTime_Start <String>
-WriteJourneyRequest_StartActivity <String>
-Schedule_StartTime <DateTime>
-WriteJourneyRequest_State <State>
-Schedule_Timezone <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a journey for an application.

Parameters

-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)
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)
-Limits_DailyCap <Int32>
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_DailyCap
-Limits_EndpointReentryCap <Int32>
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_EndpointReentryCap
-Limits_MessagesPerSecond <Int32>
The maximum number of messages that the journey can send each second.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_MessagesPerSecond
-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)
-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)
AliasesWriteJourneyRequest_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)
AliasesWriteJourneyRequest_QuietTime_Start
-Schedule_EndTime <DateTime>
The scheduled time, in ISO 8601 format, when the journey ended or will end.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Schedule_EndTime
-Schedule_StartTime <DateTime>
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Schedule_StartTime
-Schedule_Timezone <String>
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Schedule_Timezone
-SegmentStartCondition_SegmentId <String>
The unique identifier for the segment to associate with the activity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_StartCondition_SegmentStartCondition_SegmentId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JourneyResponse'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.CreateJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.CreateJourneyResponse 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)
-StartCondition_Description <String>
The custom description of the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_StartCondition_Description
-WriteJourneyRequest_Activity <Hashtable>
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Activities
-WriteJourneyRequest_CreationDate <String>
The date, in ISO 8601 format, when the journey was created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_LastModifiedDate <String>
The date, in ISO 8601 format, when the journey was last modified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_LocalTime <Boolean>
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_Name <String>
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_RefreshFrequency <String>
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_StartActivity <String>
The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_State <State>
The status of the journey. Valid values are:
  • DRAFT - Saves the journey and doesn't publish it.
  • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.
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

This cmdlet returns an Amazon.Pinpoint.Model.JourneyResponse object. The service call response (type Amazon.Pinpoint.Model.CreateJourneyResponse) 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