get_journey_runs ¶

def get_journey_runs(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    journey_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    page_size: Optional["capo_pinpoint.types.__string.__string"] = None,
    token: Optional["capo_pinpoint.types.__string.__string"] = None,
) -> "capo_pinpoint.types.get_journey_runs_response.GetJourneyRunsResponse":
    """<p>Provides information about the runs of a journey.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
        journey_id: <p>The unique identifier for the journey.</p>
        page_size: <p>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.</p>
        token: <p>The NextToken string that specifies which page of results to return in a paginated response.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get the runs of a journey
        The following example gets the runs of a journey.

        >>> client.get_journey_runs(application_id='11111111112222222222333333333344', journey_id='aaaaaaaaaabbbbbbbbbbccccccccccdd')
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.get_journey_runs_request.GetJourneyRunsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.get_journey_runs_response.GetJourneyRunsResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_journey_runs

        output, http_response = (
            capo_pinpoint._operations.pinpoint.get_journey_runs.get_journey_runs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetJourneyRuns")
    )
    input_: capo_pinpoint.types.get_journey_runs_request.GetJourneyRunsRequest = {
        "application_id": application_id,
        "journey_id": journey_id,
    }
    if page_size is not None:
        input_["page_size"] = page_size
    if token is not None:
        input_["token"] = token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output