EC2 / Client / cancel_capacity_reservation

cancel_capacity_reservation#

EC2.Client.cancel_capacity_reservation(**kwargs)#

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation’s state to cancelled.

You can cancel a Capacity Reservation that is in the following states:

  • assessing

  • active and there is no commitment duration or the commitment duration has elapsed. You can’t cancel a future-dated Capacity Reservation during the commitment duration.

If a future-dated Capacity Reservation enters the delayed state, the commitment duration is waived, and you can cancel it as soon as it enters the active state.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

See also: AWS API Documentation

Request Syntax

response = client.cancel_capacity_reservation(
    CapacityReservationId='string',
    DryRun=True|False
)
Parameters:

  • CapacityReservationId (string) –

    [REQUIRED]

    The ID of the Capacity Reservation to be cancelled.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

      Returns true if the request succeeds; otherwise, it returns an error.