[ aws . ec2 ]

cancel-spot-instance-requests

Description

Cancels one or more Spot Instance requests.

Warning

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  cancel-spot-instance-requests
[--dry-run | --no-dry-run]
--spot-instance-request-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 .

--spot-instance-request-ids (list)

One or more Spot Instance request IDs.

(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 Spot Instance requests

This example command cancels a Spot Instance request.

Command:

aws ec2 cancel-spot-instance-requests --spot-instance-request-ids sir-08b93456

Output:

{
    "CancelledSpotInstanceRequests": [
        {
            "State": "cancelled",
            "SpotInstanceRequestId": "sir-08b93456"
        }
    ]
}

Output

CancelledSpotInstanceRequests -> (list)

One or more Spot Instance requests.

(structure)

Describes a request to cancel a Spot Instance.

SpotInstanceRequestId -> (string)

The ID of the Spot Instance request.

State -> (string)

The state of the Spot Instance request.