- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListJourneysCommand
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PinpointClient, ListJourneysCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, ListJourneysCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // ListJourneysRequest
ApplicationId: "STRING_VALUE", // required
PageSize: "STRING_VALUE",
Token: "STRING_VALUE",
};
const command = new ListJourneysCommand(input);
const response = await client.send(command);
// { // ListJourneysResponse
// JourneysResponse: { // JourneysResponse
// Item: [ // ListOfJourneyResponse // required
// { // JourneyResponse
// Activities: { // MapOfActivity
// "<keys>": { // Activity
// CUSTOM: { // CustomMessageActivity
// DeliveryUri: "STRING_VALUE",
// EndpointTypes: [ // ListOf__EndpointTypesElement
// "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
// ],
// MessageConfig: { // JourneyCustomMessage
// Data: "STRING_VALUE",
// },
// NextActivity: "STRING_VALUE",
// TemplateName: "STRING_VALUE",
// TemplateVersion: "STRING_VALUE",
// },
// ConditionalSplit: { // ConditionalSplitActivity
// Condition: { // Condition
// Conditions: [ // ListOfSimpleCondition
// { // SimpleCondition
// EventCondition: { // EventCondition
// Dimensions: { // EventDimensions
// Attributes: { // MapOfAttributeDimension
// "<keys>": { // AttributeDimension
// AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
// Values: [ // ListOf__string // required
// "STRING_VALUE",
// ],
// },
// },
// EventType: { // SetDimension
// DimensionType: "INCLUSIVE" || "EXCLUSIVE",
// Values: [ // required
// "STRING_VALUE",
// ],
// },
// Metrics: { // MapOfMetricDimension
// "<keys>": { // MetricDimension
// ComparisonOperator: "STRING_VALUE", // required
// Value: Number("double"), // required
// },
// },
// },
// MessageActivity: "STRING_VALUE",
// },
// SegmentCondition: { // SegmentCondition
// SegmentId: "STRING_VALUE", // required
// },
// SegmentDimensions: { // SegmentDimensions
// Attributes: {
// "<keys>": {
// AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
// Values: [ // required
// "STRING_VALUE",
// ],
// },
// },
// Behavior: { // SegmentBehaviors
// Recency: { // RecencyDimension
// Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
// RecencyType: "ACTIVE" || "INACTIVE", // required
// },
// },
// Demographic: { // SegmentDemographics
// AppVersion: {
// DimensionType: "INCLUSIVE" || "EXCLUSIVE",
// Values: [ // required
// "STRING_VALUE",
// ],
// },
// Channel: {
// DimensionType: "INCLUSIVE" || "EXCLUSIVE",
// Values: [ // required
// "STRING_VALUE",
// ],
// },
// DeviceType: {
// DimensionType: "INCLUSIVE" || "EXCLUSIVE",
// Values: "<ListOf__string>", // required
// },
// Make: {
// DimensionType: "INCLUSIVE" || "EXCLUSIVE",
// Values: "<ListOf__string>", // required
// },
// Model: "<SetDimension>",
// Platform: "<SetDimension>",
// },
// Location: { // SegmentLocation
// Country: "<SetDimension>",
// GPSPoint: { // GPSPointDimension
// Coordinates: { // GPSCoordinates
// Latitude: Number("double"), // required
// Longitude: Number("double"), // required
// },
// RangeInKilometers: Number("double"),
// },
// },
// Metrics: {
// "<keys>": {
// ComparisonOperator: "STRING_VALUE", // required
// Value: Number("double"), // required
// },
// },
// UserAttributes: {
// "<keys>": {
// AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
// Values: "<ListOf__string>", // required
// },
// },
// },
// },
// ],
// Operator: "ALL" || "ANY",
// },
// EvaluationWaitTime: { // WaitTime
// WaitFor: "STRING_VALUE",
// WaitUntil: "STRING_VALUE",
// },
// FalseActivity: "STRING_VALUE",
// TrueActivity: "STRING_VALUE",
// },
// Description: "STRING_VALUE",
// EMAIL: { // EmailMessageActivity
// MessageConfig: { // JourneyEmailMessage
// FromAddress: "STRING_VALUE",
// },
// NextActivity: "STRING_VALUE",
// TemplateName: "STRING_VALUE",
// TemplateVersion: "STRING_VALUE",
// },
// Holdout: { // HoldoutActivity
// NextActivity: "STRING_VALUE",
// Percentage: Number("int"), // required
// },
// MultiCondition: { // MultiConditionalSplitActivity
// Branches: [ // ListOfMultiConditionalBranch
// { // MultiConditionalBranch
// Condition: {
// EventCondition: {
// Dimensions: {
// Attributes: {
// "<keys>": {
// AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
// Values: "<ListOf__string>", // required
// },
// },
// EventType: "<SetDimension>",
// Metrics: {
// "<keys>": {
// ComparisonOperator: "STRING_VALUE", // required
// Value: Number("double"), // required
// },
// },
// },
// MessageActivity: "STRING_VALUE",
// },
// SegmentCondition: {
// SegmentId: "STRING_VALUE", // required
// },
// SegmentDimensions: {
// Attributes: {
// "<keys>": {
// AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
// Values: "<ListOf__string>", // required
// },
// },
// Behavior: {
// Recency: {
// Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
// RecencyType: "ACTIVE" || "INACTIVE", // required
// },
// },
// Demographic: {
// AppVersion: "<SetDimension>",
// Channel: "<SetDimension>",
// DeviceType: "<SetDimension>",
// Make: "<SetDimension>",
// Model: "<SetDimension>",
// Platform: "<SetDimension>",
// },
// Location: {
// Country: "<SetDimension>",
// GPSPoint: {
// Coordinates: {
// Latitude: Number("double"), // required
// Longitude: Number("double"), // required
// },
// RangeInKilometers: Number("double"),
// },
// },
// Metrics: {
// "<keys>": {
// ComparisonOperator: "STRING_VALUE", // required
// Value: Number("double"), // required
// },
// },
// UserAttributes: "<MapOfAttributeDimension>",
// },
// },
// NextActivity: "STRING_VALUE",
// },
// ],
// DefaultActivity: "STRING_VALUE",
// EvaluationWaitTime: {
// WaitFor: "STRING_VALUE",
// WaitUntil: "STRING_VALUE",
// },
// },
// PUSH: { // PushMessageActivity
// MessageConfig: { // JourneyPushMessage
// TimeToLive: "STRING_VALUE",
// },
// NextActivity: "STRING_VALUE",
// TemplateName: "STRING_VALUE",
// TemplateVersion: "STRING_VALUE",
// },
// RandomSplit: { // RandomSplitActivity
// Branches: [ // ListOfRandomSplitEntry
// { // RandomSplitEntry
// NextActivity: "STRING_VALUE",
// Percentage: Number("int"),
// },
// ],
// },
// SMS: { // SMSMessageActivity
// MessageConfig: { // JourneySMSMessage
// MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
// OriginationNumber: "STRING_VALUE",
// SenderId: "STRING_VALUE",
// EntityId: "STRING_VALUE",
// TemplateId: "STRING_VALUE",
// },
// NextActivity: "STRING_VALUE",
// TemplateName: "STRING_VALUE",
// TemplateVersion: "STRING_VALUE",
// },
// Wait: { // WaitActivity
// NextActivity: "STRING_VALUE",
// WaitTime: {
// WaitFor: "STRING_VALUE",
// WaitUntil: "STRING_VALUE",
// },
// },
// ContactCenter: { // ContactCenterActivity
// NextActivity: "STRING_VALUE",
// },
// },
// },
// ApplicationId: "STRING_VALUE", // required
// CreationDate: "STRING_VALUE",
// Id: "STRING_VALUE", // required
// LastModifiedDate: "STRING_VALUE",
// Limits: { // JourneyLimits
// DailyCap: Number("int"),
// EndpointReentryCap: Number("int"),
// MessagesPerSecond: Number("int"),
// EndpointReentryInterval: "STRING_VALUE",
// TimeframeCap: { // JourneyTimeframeCap
// Cap: Number("int"),
// Days: Number("int"),
// },
// TotalCap: Number("int"),
// },
// LocalTime: true || false,
// Name: "STRING_VALUE", // required
// QuietTime: { // QuietTime
// End: "STRING_VALUE",
// Start: "STRING_VALUE",
// },
// RefreshFrequency: "STRING_VALUE",
// Schedule: { // JourneySchedule
// EndTime: new Date("TIMESTAMP"),
// StartTime: new Date("TIMESTAMP"),
// Timezone: "STRING_VALUE",
// },
// StartActivity: "STRING_VALUE",
// StartCondition: { // StartCondition
// Description: "STRING_VALUE",
// EventStartCondition: { // EventStartCondition
// EventFilter: { // EventFilter
// Dimensions: {
// Attributes: "<MapOfAttributeDimension>",
// EventType: "<SetDimension>",
// Metrics: "<MapOfMetricDimension>",
// },
// FilterType: "SYSTEM" || "ENDPOINT", // required
// },
// SegmentId: "STRING_VALUE",
// },
// SegmentStartCondition: {
// SegmentId: "STRING_VALUE", // required
// },
// },
// State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED",
// tags: { // MapOf__string
// "<keys>": "STRING_VALUE",
// },
// WaitForQuietTime: true || false,
// RefreshOnSegmentUpdate: true || false,
// JourneyChannelSettings: { // JourneyChannelSettings
// ConnectCampaignArn: "STRING_VALUE",
// ConnectCampaignExecutionRoleArn: "STRING_VALUE",
// },
// SendingSchedule: true || false,
// OpenHours: { // OpenHours
// EMAIL: { // MapOfListOfOpenHoursRules
// "<keys>": [ // ListOfOpenHoursRules
// { // OpenHoursRule
// StartTime: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// },
// ],
// },
// SMS: {
// "<keys>": [
// {
// StartTime: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// },
// ],
// },
// PUSH: {
// "<keys>": [
// {
// StartTime: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// },
// ],
// },
// VOICE: {
// "<keys>": [
// {
// StartTime: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// },
// ],
// },
// CUSTOM: {
// "<keys>": [
// {
// StartTime: "STRING_VALUE",
// EndTime: "STRING_VALUE",
// },
// ],
// },
// },
// ClosedDays: { // ClosedDays
// EMAIL: [ // ListOfClosedDaysRules
// { // ClosedDaysRule
// Name: "STRING_VALUE",
// StartDateTime: "STRING_VALUE",
// EndDateTime: "STRING_VALUE",
// },
// ],
// SMS: [
// {
// Name: "STRING_VALUE",
// StartDateTime: "STRING_VALUE",
// EndDateTime: "STRING_VALUE",
// },
// ],
// PUSH: [
// {
// Name: "STRING_VALUE",
// StartDateTime: "STRING_VALUE",
// EndDateTime: "STRING_VALUE",
// },
// ],
// VOICE: [
// {
// Name: "STRING_VALUE",
// StartDateTime: "STRING_VALUE",
// EndDateTime: "STRING_VALUE",
// },
// ],
// CUSTOM: [
// {
// Name: "STRING_VALUE",
// StartDateTime: "STRING_VALUE",
// EndDateTime: "STRING_VALUE",
// },
// ],
// },
// TimezoneEstimationMethods: [ // ListOf__TimezoneEstimationMethodsElement
// "PHONE_NUMBER" || "POSTAL_CODE",
// ],
// },
// ],
// NextToken: "STRING_VALUE",
// },
// };
ListJourneysCommand Input
See ListJourneysCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ApplicationIdRequired | string | undefined | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
PageSize | string | undefined | 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 | undefined | The NextToken string that specifies which page of results to return in a paginated response. |
ListJourneysCommand Output
See ListJourneysCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
JourneysResponseRequired | JourneysResponse | undefined | Provides information about the status, configuration, and other settings for all the journeys that are associated with an application. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | Provides information about an API request or response. |
| ForbiddenException | client | Provides information about an API request or response. |
| InternalServerErrorException | server | Provides information about an API request or response. |
| MethodNotAllowedException | client | Provides information about an API request or response. |
| NotFoundException | client | Provides information about an API request or response. |
| PayloadTooLargeException | client | Provides information about an API request or response. |
| TooManyRequestsException | client | Provides information about an API request or response. |
| PinpointServiceException | Base exception class for all service exceptions from Pinpoint service. |