Journey Runs - Amazon Pinpoint

Journey Runs

A journey is an automated workflow that performs a series of messaging activities for an Amazon Pinpoint application. A journey run represents each scheduled entry of endpoints into the journey. The journey run resource provides information about each journey run, including timing information and status.

Each journey run represents a single evaluation of a segment, so can include endpoints in different timezones. These endpoints may actually enter the journey at different times, depending on their timezones, but each are represented by the same journey run.

URI

/v1/apps/application-id/journeys/journey-id/runs

HTTP methods

GET

Operation ID: GetJourneyRuns

Provides information about the runs of a journey.

Path parameters
NameTypeRequiredDescription
application-idStringTrue

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

journey-idStringTrue

The unique identifier for the journey.

Header parameters
NameTypeRequiredDescription
acceptStringFalse

Indicates which content types, expressed as MIME types, the client understands.

Query parameters
NameTypeRequiredDescription
page-sizeStringFalse

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.

tokenStringFalse

The NextToken string that specifies which page of results to return in a paginated response.

Responses
Status codeResponse modelDescription
200JourneyRunsResponse

The request succeeded.

400MessageBody

The request contains a syntax error (BadRequestException).

403MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404MessageBody

The request failed because the specified resource was not found (NotFoundException).

405MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Journey Run resource.

Path parameters
NameTypeRequiredDescription
journey-idStringTrue

The unique identifier for the journey.

application-idStringTrue

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

Responses
Status codeResponse modelDescription
200None

The request succeeded.

Schemas

Response bodies

{ "NextToken": "string", "Item": [ { "RunId": "string", "CreationTime": "string", "LastUpdateTime": "string", "Status": enum } ] }
{ "RequestID": "string", "Message": "string" }

Properties

JourneyRunResponse

Provides information from a specified run of a journey.

PropertyTypeRequiredDescription
CreationTime

string

True

The time when the journey run was created or scheduled, in ISO 8601 format.

LastUpdateTime

string

True

The last time the journey run was updated, in ISO 8601 format..

RunId

string

True

The unique identifier for the run.

Status

string

Values: SCHEDULED | RUNNING | COMPLETED | CANCELLED

True

The current status of the run.

JourneyRunsResponse

Provides information from all runs of a journey.

PropertyTypeRequiredDescription
Item

Array of type JourneyRunResponse

True

An array of responses, one for each run of the journey

NextToken

string

False

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.

MessageBody

Provides information about an API request or response.

PropertyTypeRequiredDescription
Message

string

False

The message that's returned from the API.

RequestID

string

False

The unique identifier for the request or response.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetJourneyRuns