Skip to content

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

Description

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
  • scheduled — requires a cancellation quote. Use create_capacity_reservation_cancellation_quote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The cancellation charge depends on how close the reservation is to its start date.
  • active and there is no commitment duration or the commitment duration has elapsed.
  • active during the commitment duration — requires a cancellation quote. Use create_capacity_reservation_cancellation_quote to generate a quote, then pass the quote ID with ApplyCancellationCharges set to commitment-wind-down. The Capacity Reservation transitions to cancelling while charges are applied.
  • delayed — the commitment duration is waived, so no cancellation charge applies.

You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML.

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.

Usage

ec2_cancel_capacity_reservation(CapacityReservationId, DryRun,
  ApplyCancellationCharges, QuoteId)

Arguments

  • CapacityReservationId

    [required] The ID of the Capacity Reservation to be cancelled.

  • DryRun

    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.

  • ApplyCancellationCharges

    Specifies the cancellation charge type to apply when cancelling a future-dated Capacity Reservation during its commitment duration. Possible values include commitment-wind-down, which continues billing for the remaining commitment duration without delivering capacity.

  • QuoteId

    The ID of the cancellation quote to use for the cancellation. You can generate a cancellation quote by using the create_capacity_reservation_cancellation_quote action. The cancellation quote must be in an active state.

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax

svc$cancel_capacity_reservation(
  CapacityReservationId = "string",
  DryRun = TRUE|FALSE,
  ApplyCancellationCharges = "commitment-wind-down",
  QuoteId = "string"
)