Skip to content

describe_vpc_endpoints

describe_vpc_endpoints(
    vpc_endpoint_ids: VpcEndpointIdList,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
) -> DescribeVpcEndpointsResponse

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Parameters:

  • vpc_endpoint_ids (VpcEndpointIdList) –

    The unique identifiers of the endpoints to get information about.

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.

  • ValidationException –

    An exception for missing / invalid input fields. Gives http status code of 400.

  • 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 describe_vpc_endpoints(
    self,
    vpc_endpoint_ids: "capo_elasticsearch_service.types.vpc_endpoint_id_list.VpcEndpointIdList",
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
) -> "capo_elasticsearch_service.types.describe_vpc_endpoints_response.DescribeVpcEndpointsResponse":
    """<p>Describes one or more Amazon OpenSearch Service-managed VPC endpoints.</p>

    Args:
        vpc_endpoint_ids: <p>The unique identifiers of the endpoints to get information about.</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.validation_exception.ValidationException: <p>An exception for missing / invalid input fields. Gives http status code of 400.</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.describe_vpc_endpoints_request.DescribeVpcEndpointsRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.describe_vpc_endpoints_response.DescribeVpcEndpointsResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_vpc_endpoints

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVpcEndpoints")
    )
    input_: capo_elasticsearch_service.types.describe_vpc_endpoints_request.DescribeVpcEndpointsRequest = {
        "vpc_endpoint_ids": vpc_endpoint_ids
    }

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