Skip to content

list_vpc_endpoints

list_vpc_endpoints(
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    next_token: Optional[NextToken] = None,
) -> ListVpcEndpointsResponse

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

Parameters:

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

    Identifier to allow retrieval of paginated results.

Raises:

  • BaseException –

    An error occurred while processing the request.

  • DisabledOperationException –

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • InternalException –

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_elasticsearch_service/_services/elasticsearch_service.py
def list_vpc_endpoints(
    self,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
    next_token: Optional[
        "capo_elasticsearch_service.types.next_token.NextToken"
    ] = None,
) -> "capo_elasticsearch_service.types.list_vpc_endpoints_response.ListVpcEndpointsResponse":
    """<p>Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.</p>

    Args:
        next_token: <p>Identifier to allow retrieval of paginated results.</p>

    Raises:
        capo_elasticsearch_service.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_elasticsearch_service.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>
        capo_elasticsearch_service.errors.internal_exception.InternalException: <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
        capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticsearch_service.types.list_vpc_endpoints_request.ListVpcEndpointsRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.list_vpc_endpoints_response.ListVpcEndpointsResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_vpc_endpoints

        output, http_response = (
            capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.list_vpc_endpoints.list_vpc_endpoints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVpcEndpoints")
    )
    input_: capo_elasticsearch_service.types.list_vpc_endpoints_request.ListVpcEndpointsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token

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