The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
VARCHAR
page_sizeInput Column
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
VARCHAR
tokenInput Column
The NextToken string that specifies which page of results to return in a paginated response.
VARCHAR
_aws_profileInput Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.
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.
journeys_response.item[].application_id
The unique identifier for the application that the journey applies to.
journeys_response.item[].closed_days
The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
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.
The maximum number of messages that the journey can send each second.
journeys_response.item[].limits.timeframe_cap
The number of messages that an endpoint can receive during the specified timeframe.
Show child fields
journeys_response.item[].limits.timeframe_cap.cap
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.
The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.
journeys_response.item[].limits.total_cap
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.
journeys_response.item[].local_time
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
journeys_response.item[].name
The name of the journey.
journeys_response.item[].open_hours
The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.
Show child fields
journeys_response.item[].open_hours.custom
Specifies the schedule settings for the custom channel.
journeys_response.item[].open_hours.email
Specifies the schedule settings for the email channel.
journeys_response.item[].open_hours.push
Specifies the schedule settings for the push channel.
journeys_response.item[].open_hours.sms
Specifies the schedule settings for the SMS channel.
journeys_response.item[].open_hours.voice
Specifies the schedule settings for the voice channel.
journeys_response.item[].quiet_time
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
Show child fields
journeys_response.item[].quiet_time.end
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.
journeys_response.item[].quiet_time.start
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.
journeys_response.item[].refresh_frequency
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
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.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
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.
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.
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.
The unique identifier for the segment to associate with the activity.
journeys_response.item[].state
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.
journeys_response.next_token
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.