Skip to content

update_vpc_endpoint

update_vpc_endpoint(
    vpc_endpoint_id: VpcEndpointId,
    vpc_options: VPCOptions,
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> UpdateVpcEndpointResponse

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameters:

  • vpc_endpoint_id (VpcEndpointId) –

    The unique identifier of the endpoint.

  • vpc_options (VPCOptions) –

    The security groups and/or subnets to add, remove, or modify.

Raises:

  • BaseException –

    An error occurred while processing the request.

  • ConflictException –

    An error occurred because the client attempts to remove a resource that is currently in use.

  • DisabledOperationException –

    An error occured because the client wanted to access an unsupported operation.

  • InternalException –

    Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException –

    An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException –

    An exception for accessing or deleting a resource that doesn't exist.

  • UnknownServiceError –

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

Source code in docs_src/capo_opensearch/_services/open_search.py
def update_vpc_endpoint(
    self,
    vpc_endpoint_id: "capo_opensearch.types.vpc_endpoint_id.VpcEndpointId",
    vpc_options: "capo_opensearch.types.vpc_options.VPCOptions",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> "capo_opensearch.types.update_vpc_endpoint_response.UpdateVpcEndpointResponse":
    """<p>Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.</p>

    Args:
        vpc_endpoint_id: <p>The unique identifier of the endpoint.</p>
        vpc_options: <p>The security groups and/or subnets to add, remove, or modify.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.conflict_exception.ConflictException: <p>An error occurred because the client attempts to remove a resource that is currently in use.</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.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</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.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.update_vpc_endpoint_request.UpdateVpcEndpointRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.update_vpc_endpoint_response.UpdateVpcEndpointResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.update_vpc_endpoint

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.update_vpc_endpoint.update_vpc_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateVpcEndpoint")
    )
    input_: capo_opensearch.types.update_vpc_endpoint_request.UpdateVpcEndpointRequest = {
        "vpc_endpoint_id": vpc_endpoint_id,
        "vpc_options": vpc_options,
    }

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