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>
-Dimensions_Attribute <Hashtable>
-TimeframeCap_Cap <Int32>
-JourneyChannelSettings_ConnectCampaignArn <String>
-JourneyChannelSettings_ConnectCampaignExecutionRoleArn <String>
-WriteJourneyRequest_CreationDate <String>
-ClosedDays_CUSTOM <ClosedDaysRule[]>
-OpenHours_CUSTOM <Hashtable>
-Limits_DailyCap <Int32>
-TimeframeCap_Day <Int32>
-StartCondition_Description <String>
-EventType_DimensionType <DimensionType>
-ClosedDays_EMAIL <ClosedDaysRule[]>
-OpenHours_EMAIL <Hashtable>
-QuietTime_End <String>
-Limits_EndpointReentryCap <Int32>
-Limits_EndpointReentryInterval <String>
-Schedule_EndTime <DateTime>
-EventFilter_FilterType <FilterType>
-WriteJourneyRequest_LastModifiedDate <String>
-WriteJourneyRequest_LocalTime <Boolean>
-Limits_MessagesPerSecond <Int32>
-Dimensions_Metric <Hashtable>
-WriteJourneyRequest_Name <String>
-ClosedDays_PUSH <ClosedDaysRule[]>
-OpenHours_PUSH <Hashtable>
-WriteJourneyRequest_RefreshFrequency <String>
-WriteJourneyRequest_RefreshOnSegmentUpdate <Boolean>
-EventStartCondition_SegmentId <String>
-SegmentStartCondition_SegmentId <String>
-WriteJourneyRequest_SendingSchedule <Boolean>
-ClosedDays_SMS <ClosedDaysRule[]>
-OpenHours_SMS <Hashtable>
-QuietTime_Start <String>
-WriteJourneyRequest_StartActivity <String>
-Schedule_StartTime <DateTime>
-WriteJourneyRequest_State <State>
-Schedule_Timezone <String>
-WriteJourneyRequest_TimezoneEstimationMethod <String[]>
-Limits_TotalCap <Int32>
-EventType_Value <String[]>
-ClosedDays_VOICE <ClosedDaysRule[]>
-OpenHours_VOICE <Hashtable>
-WriteJourneyRequest_WaitForQuietTime <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointConfig>

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)
-ClientConfig <AmazonPinpointConfig>
Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClosedDays_CUSTOM <ClosedDaysRule[]>
Rules for the Custom channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_ClosedDays_CUSTOM
-ClosedDays_EMAIL <ClosedDaysRule[]>
Rules for the Email channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_ClosedDays_EMAIL
-ClosedDays_PUSH <ClosedDaysRule[]>
Rules for the Push channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_ClosedDays_PUSH
-ClosedDays_SMS <ClosedDaysRule[]>
Rules for the SMS channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_ClosedDays_SMS
-ClosedDays_VOICE <ClosedDaysRule[]>
Rules for the Voice channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_ClosedDays_VOICE
-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)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_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)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_Dimensions_Metrics
-EventFilter_FilterType <FilterType>
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_FilterType
-EventStartCondition_SegmentId <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_SegmentId
-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)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_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)
AliasesWriteJourneyRequest_StartCondition_EventStartCondition_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)
-JourneyChannelSettings_ConnectCampaignArn <String>
Amazon Resource Name (ARN) of the Connect Campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_JourneyChannelSettings_ConnectCampaignArn
-JourneyChannelSettings_ConnectCampaignExecutionRoleArn <String>
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_JourneyChannelSettings_ConnectCampaignExecutionRoleArn
-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_EndpointReentryInterval <String>
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_EndpointReentryInterval
-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
-Limits_TotalCap <Int32>
The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_TotalCap
-OpenHours_CUSTOM <Hashtable>
Specifies the schedule settings for the custom channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_OpenHours_CUSTOM
-OpenHours_EMAIL <Hashtable>
Specifies the schedule settings for the email channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_OpenHours_EMAIL
-OpenHours_PUSH <Hashtable>
Specifies the schedule settings for the push channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_OpenHours_PUSH
-OpenHours_SMS <Hashtable>
Specifies the schedule settings for the SMS channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_OpenHours_SMS
-OpenHours_VOICE <Hashtable>
Specifies the schedule settings for the voice channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_OpenHours_VOICE
-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
-TimeframeCap_Cap <Int32>
The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_TimeframeCap_Cap
-TimeframeCap_Day <Int32>
The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_Limits_TimeframeCap_Days
-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 100 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_RefreshOnSegmentUpdate <Boolean>
Indicates whether the journey participants should be refreshed when a segment is updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_SendingSchedule <Boolean>
Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_StartActivity <String>
The unique identifier for the first activity in the journey. The identifier for this activity 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.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteJourneyRequest_TimezoneEstimationMethod <String[]>
An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
  • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
  • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWriteJourneyRequest_TimezoneEstimationMethods
-WriteJourneyRequest_WaitForQuietTime <Boolean>
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
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.JourneyResponse or Amazon.Pinpoint.Model.CreateJourneyResponse
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.
AWS Tools for PowerShell User Guide

Supported Version

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