cancel_capacity_reservation_fleets¶
Operation¶
cancel_capacity_reservation_fleets
async
¶
cancel_capacity_reservation_fleets(request: CancelCapacityReservationFleetsInput | CancelCapacityReservationFleetsInputDict, /, *, plugins: list[Plugin] | None = None) -> CancelCapacityReservationFleetsOutput
cancel_capacity_reservation_fleets(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelCapacityReservationFleetsInputDict]) -> CancelCapacityReservationFleetsOutput
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
-
The Capacity Reservation Fleet's status changes to
cancelled. -
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
-
The Fleet stops creating new Capacity Reservations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CancelCapacityReservationFleetsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CancelCapacityReservationFleetsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelCapacityReservationFleetsInput structure.
Attributes¶
capacity_reservation_fleet_ids
class-attribute
instance-attribute
¶
The IDs of the Capacity Reservation Fleets to cancel.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | 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.
Dictionaries¶
CancelCapacityReservationFleetsInputDict
¶
Bases: TypedDict
Dictionary form of CancelCapacityReservationFleetsInput.
Attributes¶
capacity_reservation_fleet_ids
instance-attribute
¶
The IDs of the Capacity Reservation Fleets to cancel.
dry_run
instance-attribute
¶
dry_run: bool | 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.
Output¶
CancelCapacityReservationFleetsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelCapacityReservationFleetsOutput structure.
Attributes¶
failed_fleet_cancellations
class-attribute
instance-attribute
¶
failed_fleet_cancellations: list[FailedCapacityReservationFleetCancellationResult] | None = ...
Information about the Capacity Reservation Fleets that could not be cancelled.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
successful_fleet_cancellations
class-attribute
instance-attribute
¶
successful_fleet_cancellations: list[CapacityReservationFleetCancellationState] | None = ...
Information about the Capacity Reservation Fleets that were successfully cancelled.