Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
Parameters:
-
application_id
(__string)
–
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
-
page_size
(Optional[__string], default:
None
)
–
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
(Optional[__string], default:
None
)
–
The NextToken string that specifies which page of results to return in a paginated response.
Raises:
Source code in docs_src/capo_pinpoint/_services/pinpoint.py
| def list_journeys(
self,
application_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.list_journeys_response.ListJourneysResponse":
"""<p>Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.</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>
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.
"""
def _handler(
req: "OperationRequest[capo_pinpoint.types.list_journeys_request.ListJourneysRequest]",
) -> OperationResponse[
"capo_pinpoint.types.list_journeys_response.ListJourneysResponse"
]:
import capo_pinpoint._operations.pinpoint.list_journeys
output, http_response = (
capo_pinpoint._operations.pinpoint.list_journeys.list_journeys(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListJourneys")
)
input_: capo_pinpoint.types.list_journeys_request.ListJourneysRequest = {
"application_id": application_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
|