list_vpc_endpoints ¶

def list_vpc_endpoints(
    self,
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
    vpc_endpoint_filters: Optional[
        "capo_opensearchserverless.types.vpc_endpoint_filters.VpcEndpointFilters"
    ] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_opensearchserverless.types.list_vpc_endpoints_response.ListVpcEndpointsResponse":
    """<p>Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>

    Args:
        vpc_endpoint_filters: <p>Filter the results according to the current status of the VPC endpoint. Possible statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p>
        next_token: <p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page. </p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>

    Raises:
        capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
        capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
        capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_opensearchserverless._operations.open_search_serverless.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_opensearchserverless.types.list_vpc_endpoints_request.ListVpcEndpointsRequest = {}
    if vpc_endpoint_filters is not None:
        input_["vpc_endpoint_filters"] = vpc_endpoint_filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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