[ aws . ec2 ]

cancel-capacity-reservation-fleets

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  cancel-capacity-reservation-fleets
[--dry-run | --no-dry-run]
--capacity-reservation-fleet-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dry-run | --no-dry-run (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 .

--capacity-reservation-fleet-ids (list)

The IDs of the Capacity Reservation Fleets to cancel.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To cancel a Capacity Reservation Fleet

The following cancel-capacity-reservation-fleets example cancels the specified Capacity Reservation Fleet and the capacity it reserves. When you cancel a Fleet, its status changes to cancelled, and it can no longer create new Capacity Reservations. Additionally, all of the individual Capacity Reservations in the Fleet are cancelled, and the instances that were previously running in the reserved capacity continue to run normally in shared capacity.

aws ec2 cancel-capacity-reservation-fleets \
    --capacity-reservation-fleet-ids crf-abcdef01234567890

Output:

{
    "SuccessfulFleetCancellations": [
        {
            "CurrentFleetState": "cancelling",
            "PreviousFleetState": "active",
            "CapacityReservationFleetId": "crf-abcdef01234567890"
        }
    ],
    "FailedFleetCancellations": []
}

For more information about Capacity Reservation Fleets, see Capacity Reservation Fleets in the Amazon EC2 User Guide.

Output

SuccessfulFleetCancellations -> (list)

Information about the Capacity Reservation Fleets that were successfully cancelled.

(structure)

Describes a Capacity Reservation Fleet that was successfully cancelled.

CurrentFleetState -> (string)

The current state of the Capacity Reservation Fleet.

PreviousFleetState -> (string)

The previous state of the Capacity Reservation Fleet.

CapacityReservationFleetId -> (string)

The ID of the Capacity Reservation Fleet that was successfully cancelled.

FailedFleetCancellations -> (list)

Information about the Capacity Reservation Fleets that could not be cancelled.

(structure)

Describes a Capacity Reservation Fleet that could not be cancelled.

CapacityReservationFleetId -> (string)

The ID of the Capacity Reservation Fleet that could not be cancelled.

CancelCapacityReservationFleetError -> (structure)

Information about the Capacity Reservation Fleet cancellation error.

Code -> (string)

The error code.

Message -> (string)

The error message.