Skip to content

update_vpc_link

update_vpc_link(
    vpc_link_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    name: Optional[StringWithLengthBetween1And128] = None,
) -> UpdateVpcLinkResponse

Updates a VPC link.

Parameters:

Raises:

  • BadRequestException –

    The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • TooManyRequestsException –

    A limit has been exceeded. See the accompanying error message for details.

  • UnknownServiceError –

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

Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py
def update_vpc_link(
    self,
    vpc_link_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    name: Optional[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ] = None,
) -> "capo_apigatewayv2.types.update_vpc_link_response.UpdateVpcLinkResponse":
    """<p>Updates a VPC link.</p>

    Args:
        name: <p>The name of the VPC link.</p>
        vpc_link_id: <p>The ID of the VPC link.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_apigatewayv2.types.update_vpc_link_request.UpdateVpcLinkRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.update_vpc_link_response.UpdateVpcLinkResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_vpc_link

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.update_vpc_link.update_vpc_link(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateVpcLink")
    )
    input_: capo_apigatewayv2.types.update_vpc_link_request.UpdateVpcLinkRequest = {
        "vpc_link_id": vpc_link_id
    }
    if name is not None:
        input_["name"] = name

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