Skip to content

delete_subnet_cidr_reservation

delete_subnet_cidr_reservation(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    subnet_cidr_reservation_id: Optional[SubnetCidrReservationId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteSubnetCidrReservationResult

Deletes a subnet CIDR reservation.

Parameters:

  • subnet_cidr_reservation_id (Optional[SubnetCidrReservationId], default: None ) –

    The ID of the subnet CIDR reservation.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def delete_subnet_cidr_reservation(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    subnet_cidr_reservation_id: Optional[
        "capo_ec2.types.subnet_cidr_reservation_id.SubnetCidrReservationId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_subnet_cidr_reservation_result.DeleteSubnetCidrReservationResult":
    """<p>Deletes a subnet CIDR reservation.</p>

    Args:
        subnet_cidr_reservation_id: <p>The ID of the subnet CIDR reservation.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_subnet_cidr_reservation_request.DeleteSubnetCidrReservationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_subnet_cidr_reservation_result.DeleteSubnetCidrReservationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_subnet_cidr_reservation

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_subnet_cidr_reservation.delete_subnet_cidr_reservation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSubnetCidrReservation")
    )
    input_: capo_ec2.types.delete_subnet_cidr_reservation_request.DeleteSubnetCidrReservationRequest = {}
    if subnet_cidr_reservation_id is not None:
        input_["subnet_cidr_reservation_id"] = subnet_cidr_reservation_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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