list-journeys¶
Description¶
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
See also: AWS API Documentation
Synopsis¶
list-journeys
--application-id <value>
[--page-size <value>]
[--token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--application-id (string)
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
--page-size (string)
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.
--token (string)
The NextToken string that specifies which page of results to return in a paginated response.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
JourneysResponse -> (structure)
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Item -> (list)
An array of responses, one for each journey that’s associated with the application.
(structure)
Provides information about the status, configuration, and other settings for a journey.
Activities -> (map)
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.
key -> (string)
value -> (structure)
Specifies the configuration and other settings for an activity in a journey.
CUSTOM -> (structure)
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri -> (string)
The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
EndpointTypes -> (list)
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
(string)
MessageConfig -> (structure)
Specifies the message data included in a custom channel message that’s sent to participants in a journey.
Data -> (string)
The message content that’s passed to an AWS Lambda function or to a web hook.
NextActivity -> (string)
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName -> (string)
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion -> (string)
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.
ConditionalSplit -> (structure)
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition -> (structure)
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions -> (list)
The conditions to evaluate for the activity.
(structure)
Specifies a condition to evaluate for an activity in a journey.
EventCondition -> (structure)
The dimension settings for the event that’s associated with the activity.
Dimensions -> (structure)
The dimensions for the event filter to use for the activity.
Attributes -> (map)
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.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
EventType -> (structure)
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 .
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Metrics -> (map)
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.
key -> (string)
value -> (structure)
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator -> (string)
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value -> (double)
The value to compare.
MessageActivity -> (string)
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition -> (structure)
The segment that’s associated with the activity.
SegmentId -> (string)
The unique identifier for the segment to associate with the activity.
SegmentDimensions -> (structure)
The dimension settings for the segment that’s associated with the activity.
Attributes -> (map)
One or more custom attributes to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
Behavior -> (structure)
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency -> (structure)
The dimension settings that are based on how recently an endpoint was active.
Duration -> (string)
The duration to use when determining whether an endpoint is active or inactive.
RecencyType -> (string)
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.
Demographic -> (structure)
The demographic-based criteria, such as device platform, for the segment.
AppVersion -> (structure)
The app version criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Channel -> (structure)
The channel criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
DeviceType -> (structure)
The device type criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Make -> (structure)
The device make criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Model -> (structure)
The device model criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Platform -> (structure)
The device platform criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Location -> (structure)
The location-based criteria, such as region or GPS coordinates, for the segment.
Country -> (structure)
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
GPSPoint -> (structure)
The GPS location and range for the segment.
Coordinates -> (structure)
The GPS coordinates to measure distance from.
Latitude -> (double)
The latitude coordinate of the location.
Longitude -> (double)
The longitude coordinate of the location.
RangeInKilometers -> (double)
The range, in kilometers, from the GPS coordinates.
Metrics -> (map)
One or more custom metrics to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator -> (string)
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value -> (double)
The value to compare.
UserAttributes -> (map)
One or more custom user attributes to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
Operator -> (string)
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime -> (structure)
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor -> (string)
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.
WaitUntil -> (string)
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity’s conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity -> (string)
The unique identifier for the activity to perform if the conditions aren’t met.
TrueActivity -> (string)
The unique identifier for the activity to perform if the conditions are met.
Description -> (string)
The custom description of the activity.
EMAIL -> (structure)
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig -> (structure)
Specifies the sender address for an email message that’s sent to participants in the journey.
FromAddress -> (string)
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity -> (string)
The unique identifier for the next activity to perform, after the message is sent.
TemplateName -> (string)
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion -> (string)
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.
Holdout -> (structure)
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity -> (string)
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage -> (integer)
The percentage of participants who shouldn’t continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition -> (structure)
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches -> (list)
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(structure)
Specifies a condition to evaluate for an activity path in a journey.
Condition -> (structure)
The condition to evaluate for the activity path.
EventCondition -> (structure)
The dimension settings for the event that’s associated with the activity.
Dimensions -> (structure)
The dimensions for the event filter to use for the activity.
Attributes -> (map)
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.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
EventType -> (structure)
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 .
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Metrics -> (map)
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.
key -> (string)
value -> (structure)
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator -> (string)
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value -> (double)
The value to compare.
MessageActivity -> (string)
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition -> (structure)
The segment that’s associated with the activity.
SegmentId -> (string)
The unique identifier for the segment to associate with the activity.
SegmentDimensions -> (structure)
The dimension settings for the segment that’s associated with the activity.
Attributes -> (map)
One or more custom attributes to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
Behavior -> (structure)
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency -> (structure)
The dimension settings that are based on how recently an endpoint was active.
Duration -> (string)
The duration to use when determining whether an endpoint is active or inactive.
RecencyType -> (string)
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.
Demographic -> (structure)
The demographic-based criteria, such as device platform, for the segment.
AppVersion -> (structure)
The app version criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Channel -> (structure)
The channel criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
DeviceType -> (structure)
The device type criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Make -> (structure)
The device make criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Model -> (structure)
The device model criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Platform -> (structure)
The device platform criteria for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Location -> (structure)
The location-based criteria, such as region or GPS coordinates, for the segment.
Country -> (structure)
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
GPSPoint -> (structure)
The GPS location and range for the segment.
Coordinates -> (structure)
The GPS coordinates to measure distance from.
Latitude -> (double)
The latitude coordinate of the location.
Longitude -> (double)
The longitude coordinate of the location.
RangeInKilometers -> (double)
The range, in kilometers, from the GPS coordinates.
Metrics -> (map)
One or more custom metrics to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator -> (string)
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value -> (double)
The value to compare.
UserAttributes -> (map)
One or more custom user attributes to use as criteria for the segment.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
NextActivity -> (string)
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity -> (string)
The unique identifier for the activity to perform for participants who don’t meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime -> (structure)
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor -> (string)
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.
WaitUntil -> (string)
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity’s conditions have been met or the activity moves participants to the next activity in the journey.
PUSH -> (structure)
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig -> (structure)
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive -> (string)
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it’s sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn’t store or try to deliver the notification again.
This value doesn’t apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity -> (string)
The unique identifier for the next activity to perform, after the message is sent.
TemplateName -> (string)
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion -> (string)
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.
RandomSplit -> (structure)
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches -> (list)
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(structure)
Specifies the settings for a path in a random split activity in a journey.
NextActivity -> (string)
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage -> (integer)
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS -> (structure)
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig -> (structure)
Specifies the sender ID and message type for an SMS message that’s sent to participants in a journey.
MessageType -> (string)
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren’t critical or time-sensitive, such as marketing messages).
OriginationNumber -> (string)
The long code to send the SMS message from. This value should be one of the dedicated long codes that’s assigned to your AWS account. Although it isn’t required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId -> (string)
The sender ID to display as the sender of the message on a recipient’s device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId -> (string)
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId -> (string)
The template ID received from the regulatory body for sending SMS in your country.
NextActivity -> (string)
The unique identifier for the next activity to perform, after the message is sent.
TemplateName -> (string)
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion -> (string)
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.
Wait -> (structure)
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity -> (string)
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime -> (structure)
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor -> (string)
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.
WaitUntil -> (string)
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity’s conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter -> (structure)
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity -> (string)
The unique identifier for the next activity to perform after the this activity.
ApplicationId -> (string)
The unique identifier for the application that the journey applies to.
CreationDate -> (string)
The date, in ISO 8601 format, when the journey was created.
Id -> (string)
The unique identifier for the journey.
LastModifiedDate -> (string)
The date, in ISO 8601 format, when the journey was last modified.
Limits -> (structure)
The messaging and entry limits for the journey.
DailyCap -> (integer)
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap -> (integer)
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.
MessagesPerSecond -> (integer)
The maximum number of messages that the journey can send each second.
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.
LocalTime -> (boolean)
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.
Name -> (string)
The name of the journey.
QuietTime -> (structure)
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.
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.
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.
RefreshFrequency -> (string)
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule -> (structure)
The schedule settings for the journey.
EndTime -> (timestamp)
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime -> (timestamp)
The scheduled time, in ISO 8601 format, when the journey began or will begin.
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.
StartActivity -> (string)
The unique identifier for the first activity in the journey.
StartCondition -> (structure)
The segment that defines which users are participants in the journey.
Description -> (string)
The custom description of the condition.
EventStartCondition -> (structure)
Specifies the settings for an event that causes a journey activity to start.
EventFilter -> (structure)
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions -> (structure)
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes -> (map)
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.
key -> (string)
value -> (structure)
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType -> (string)
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
Values -> (list)
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
(string)
EventType -> (structure)
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 .
DimensionType -> (string)
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.
Values -> (list)
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.
(string)
Metrics -> (map)
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.
key -> (string)
value -> (structure)
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator -> (string)
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value -> (double)
The value to compare.
FilterType -> (string)
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.
SegmentId -> (string)
SegmentStartCondition -> (structure)
The segment that’s associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId -> (string)
The unique identifier for the segment to associate with the activity.
State -> (string)
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.
tags -> (map)
This object is not used or supported.
key -> (string)
value -> (string)
WaitForQuietTime -> (boolean)
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate -> (boolean)
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings -> (structure)
The channel-specific configurations for the journey.
ConnectCampaignArn -> (string)
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn -> (string)
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule -> (boolean)
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours -> (structure)
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL -> (map)
Rules for Email Channel.
key -> (string)
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
value -> (list)
Open Hour Rules.
(structure)
Open Hour Rule Details.
StartTime -> (string)
Local start time in ISO 8601 format.
EndTime -> (string)
Local start time in ISO 8601 format.
SMS -> (map)
Rules for SMS Channel.
key -> (string)
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
value -> (list)
Open Hour Rules.
(structure)
Open Hour Rule Details.
StartTime -> (string)
Local start time in ISO 8601 format.
EndTime -> (string)
Local start time in ISO 8601 format.
PUSH -> (map)
Rules for Push Channel.
key -> (string)
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
value -> (list)
Open Hour Rules.
(structure)
Open Hour Rule Details.
StartTime -> (string)
Local start time in ISO 8601 format.
EndTime -> (string)
Local start time in ISO 8601 format.
VOICE -> (map)
Rules for Voice Channel.
key -> (string)
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
value -> (list)
Open Hour Rules.
(structure)
Open Hour Rule Details.
StartTime -> (string)
Local start time in ISO 8601 format.
EndTime -> (string)
Local start time in ISO 8601 format.
CUSTOM -> (map)
Rules for Custom Channel.
key -> (string)
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
value -> (list)
Open Hour Rules.
(structure)
Open Hour Rule Details.
StartTime -> (string)
Local start time in ISO 8601 format.
EndTime -> (string)
Local start time in ISO 8601 format.
ClosedDays -> (structure)
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL -> (list)
Rules for Email Channel.
(structure)
ClosedDays rule details.
Name -> (string)
Name of the rule.
StartDateTime -> (string)
Start Datetime in ISO 8601 format.
EndDateTime -> (string)
End Datetime in ISO 8601 format.
SMS -> (list)
Rules for SMS Channel.
(structure)
ClosedDays rule details.
Name -> (string)
Name of the rule.
StartDateTime -> (string)
Start Datetime in ISO 8601 format.
EndDateTime -> (string)
End Datetime in ISO 8601 format.
PUSH -> (list)
Rules for Push Channel.
(structure)
ClosedDays rule details.
Name -> (string)
Name of the rule.
StartDateTime -> (string)
Start Datetime in ISO 8601 format.
EndDateTime -> (string)
End Datetime in ISO 8601 format.
VOICE -> (list)
Rules for Voice Channel.
(structure)
ClosedDays rule details.
Name -> (string)
Name of the rule.
StartDateTime -> (string)
Start Datetime in ISO 8601 format.
EndDateTime -> (string)
End Datetime in ISO 8601 format.
CUSTOM -> (list)
Rules for Custom Channel.
(structure)
ClosedDays rule details.
Name -> (string)
Name of the rule.
StartDateTime -> (string)
Start Datetime in ISO 8601 format.
EndDateTime -> (string)
End Datetime in ISO 8601 format.
NextToken -> (string)
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.