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) |
Amazon.PowerShell.Cmdlets.PIN.AmazonPinpointClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Rules for the Custom channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_ClosedDays_CUSTOM |
Rules for the Email channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_ClosedDays_EMAIL |
Rules for the Push channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_ClosedDays_PUSH |
Rules for the SMS channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_ClosedDays_SMS |
Rules for the Voice channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_ClosedDays_VOICE |
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) |
Aliases | WriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_Dimensions_Attributes |
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) |
Aliases | WriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_Dimensions_Metrics |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_StartCondition_EventStartCondition_SegmentId |
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) |
Aliases | WriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_Dimensions_EventType_DimensionType |
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) |
Aliases | WriteJourneyRequest_StartCondition_EventStartCondition_EventFilter_Dimensions_EventType_Values |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_JourneyChannelSettings_ConnectCampaignExecutionRoleArn |
The unique identifier for the journey.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_Limits_MessagesPerSecond |
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) |
Aliases | WriteJourneyRequest_Limits_TotalCap |
Specifies the schedule settings for the custom channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_OpenHours_CUSTOM |
Specifies the schedule settings for the email channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_OpenHours_EMAIL |
Specifies the schedule settings for the push channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_OpenHours_PUSH |
Specifies the schedule settings for the SMS channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_OpenHours_SMS |
Specifies the schedule settings for the voice channel.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteJourneyRequest_OpenHours_VOICE |
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) |
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) |
Aliases | WriteJourneyRequest_QuietTime_End |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_Schedule_StartTime |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_StartCondition_SegmentStartCondition_SegmentId |
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.UpdateJourneyResponse). Specifying the name of a property of type Amazon.Pinpoint.Model.UpdateJourneyResponse 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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_Limits_TimeframeCap_Days |
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) |
Aliases | WriteJourneyRequest_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) |
Aliases | WriteJourneyRequest_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) |