paws.compute (version 0.1.12)

ec2_cancel_capacity_reservation: 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.

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)

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

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.

Request syntax

svc$cancel_capacity_reservation(
  CapacityReservationId = "string",
  DryRun = TRUE|FALSE
)