Skip to content

describe_vpc_endpoints async

describe_vpc_endpoints(
    vpc_endpoint_ids: VpcEndpointIdList,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = 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:

Source code in docs_src/capo_opensearch/_services/async_open_search.py
async def describe_vpc_endpoints(
    self,
    vpc_endpoint_ids: "capo_opensearch.types.vpc_endpoint_id_list.VpcEndpointIdList",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> "capo_opensearch.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_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.describe_vpc_endpoints_request.DescribeVpcEndpointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.describe_vpc_endpoints_response.DescribeVpcEndpointsResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.describe_vpc_endpoints

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.describe_vpc_endpoints.async_describe_vpc_endpoints(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output