Skip to content

cancel_capacity_reservation

cancel_capacity_reservation(
    name: CapacityReservationName,
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
) -> CancelCapacityReservationOutput

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

Parameters:

Raises:

  • InternalServerException –

    Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException –

    Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • UnknownServiceError –

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

Source code in docs_src/capo_athena/_services/athena.py
def cancel_capacity_reservation(
    self,
    name: "capo_athena.types.capacity_reservation_name.CapacityReservationName",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
) -> "capo_athena.types.cancel_capacity_reservation_output.CancelCapacityReservationOutput":
    """<p>Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference. </p>

    Args:
        name: <p>The name of the capacity reservation to cancel.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.cancel_capacity_reservation_input.CancelCapacityReservationInput]",
    ) -> OperationResponse[
        "capo_athena.types.cancel_capacity_reservation_output.CancelCapacityReservationOutput"
    ]:
        import capo_athena._operations.amazon_athena.cancel_capacity_reservation

        output, http_response = (
            capo_athena._operations.amazon_athena.cancel_capacity_reservation.cancel_capacity_reservation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelCapacityReservation")
    )
    input_: capo_athena.types.cancel_capacity_reservation_input.CancelCapacityReservationInput = {
        "name": name
    }

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