Skip to content

list_multi_region_endpoints

list_multi_region_endpoints(
    *,
    config_overrides: Optional[SESv2ClientConfig] = None,
    next_token: Optional[NextTokenV2] = None,
    page_size: Optional[PageSizeV2] = None,
) -> ListMultiRegionEndpointsResponse

List the multi-region endpoints (global-endpoints).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.

Parameters:

  • next_token (Optional[NextTokenV2], default: None ) –

    A token returned from a previous call to ListMultiRegionEndpoints to indicate the position in the list of multi-region endpoints (global-endpoints).

  • page_size (Optional[PageSizeV2], default: None ) –

    The number of results to show in a single call to ListMultiRegionEndpoints. If the number of results is larger than the number you specified in this parameter, the response includes a NextToken element that you can use to retrieve the next page of results.

Raises:

Source code in docs_src/capo_sesv2/_services/se_sv2.py
def list_multi_region_endpoints(
    self,
    *,
    config_overrides: Optional[SESv2ClientConfig] = None,
    next_token: Optional["capo_sesv2.types.next_token_v2.NextTokenV2"] = None,
    page_size: Optional["capo_sesv2.types.page_size_v2.PageSizeV2"] = None,
) -> "capo_sesv2.types.list_multi_region_endpoints_response.ListMultiRegionEndpointsResponse":
    """<p>List the multi-region endpoints (global-endpoints).</p> <p>Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.</p>

    Args:
        next_token: <p>A token returned from a previous call to <code>ListMultiRegionEndpoints</code> to indicate the position in the list of multi-region endpoints (global-endpoints).</p>
        page_size: <p>The number of results to show in a single call to <code>ListMultiRegionEndpoints</code>. If the number of results is larger than the number you specified in this parameter, the response includes a <code>NextToken</code> element that you can use to retrieve the next page of results. </p>

    Raises:
        capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sesv2.types.list_multi_region_endpoints_request.ListMultiRegionEndpointsRequest]",
    ) -> OperationResponse[
        "capo_sesv2.types.list_multi_region_endpoints_response.ListMultiRegionEndpointsResponse"
    ]:
        import capo_sesv2._operations.simple_email_service_v2.list_multi_region_endpoints

        output, http_response = (
            capo_sesv2._operations.simple_email_service_v2.list_multi_region_endpoints.list_multi_region_endpoints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMultiRegionEndpoints")
    )
    input_: capo_sesv2.types.list_multi_region_endpoints_request.ListMultiRegionEndpointsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

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