Get Journey Runs

pinpoint_get_journey_runs

R Documentation

Provides information about the runs of a journey¶

Description¶

Provides information about the runs of a journey.

Usage¶

pinpoint_get_journey_runs(ApplicationId, JourneyId, PageSize, Token)

Arguments¶

ApplicationId: [required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
JourneyId: [required] The unique identifier for the journey.
PageSize: 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: The NextToken string that specifies which page of results to return in a paginated response.

Value¶

A list with the following syntax:

list(
  JourneyRunsResponse = list(
    Item = list(
      list(
        CreationTime = "string",
        LastUpdateTime = "string",
        RunId = "string",
        Status = "SCHEDULED"|"RUNNING"|"COMPLETED"|"CANCELLED"
      )
    ),
    NextToken = "string"
  )
)

Request syntax¶

svc$get_journey_runs(
  ApplicationId = "string",
  JourneyId = "string",
  PageSize = "string",
  Token = "string"
)

Examples¶

## Not run: 
# The following example gets the runs of a journey.
svc$get_journey_runs(
  ApplicationId = "11111111112222222222333333333344",
  JourneyId = "aaaaaaaaaabbbbbbbbbbccccccccccdd"
)

## End(Not run)