GetJourneyRunsCommand

Provides information about the runs of a journey.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PinpointClient, GetJourneyRunsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, GetJourneyRunsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // GetJourneyRunsRequest
  ApplicationId: "STRING_VALUE", // required
  JourneyId: "STRING_VALUE", // required
  PageSize: "STRING_VALUE",
  Token: "STRING_VALUE",
};
const command = new GetJourneyRunsCommand(input);
const response = await client.send(command);
// { // GetJourneyRunsResponse
//   JourneyRunsResponse: { // JourneyRunsResponse
//     Item: [ // ListOfJourneyRunResponse // required
//       { // JourneyRunResponse
//         CreationTime: "STRING_VALUE", // required
//         LastUpdateTime: "STRING_VALUE", // required
//         RunId: "STRING_VALUE", // required
//         Status: "SCHEDULED" || "RUNNING" || "COMPLETED" || "CANCELLED", // required
//       },
//     ],
//     NextToken: "STRING_VALUE",
//   },
// };

Example Usage

 There was an error loading the code editor. Retry

GetJourneyRunsCommand Input

See GetJourneyRunsCommandInput for more details

Parameter
Type
Description
ApplicationId
Required
string | undefined

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

JourneyId
Required
string | undefined

The unique identifier for the journey.

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.

GetJourneyRunsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
JourneyRunsResponse
Required
JourneyRunsResponse | undefined

Provides information from all runs of a journey.

Throws

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.