Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

describe-capacity-reservation-cancellation-quotes

Description

Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action.

See also: AWS API Documentation

Synopsis

  describe-capacity-reservation-cancellation-quotes
[--capacity-reservation-cancellation-quote-ids <value>]
[--max-results <value>]
[--next-token <value>]
[--dry-run | --no-dry-run]
[--filters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--capacity-reservation-cancellation-quote-ids (list)

The IDs of the cancellation quotes to describe.

(string)

Syntax:

"string" "string" ...

--max-results (integer)

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .

--next-token (string)

The token to use to retrieve the next page of results.

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

--filters (list)

One or more filters. Filter names and values are case-sensitive.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide .

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

CapacityReservationCancellationQuotes -> (list)

Information about the Capacity Reservation cancellation quotes.

(structure)

Describes a Capacity Reservation cancellation quote, which provides the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.

CapacityReservationCancellationQuoteId -> (string)

The ID of the cancellation quote.

CapacityReservationId -> (string)

The ID of the Capacity Reservation associated with the cancellation quote.

CreateTime -> (timestamp)

The date and time at which the cancellation quote was created.

ExpirationTime -> (timestamp)

The date and time at which the cancellation quote expires.

QuoteState -> (string)

The state of the cancellation quote. Possible values include pending , active , and expired .

CurrentConfiguration -> (structure)

The current configuration of the Capacity Reservation.

InstanceCount -> (integer)

The number of instances in the Capacity Reservation.

ReservationState -> (string)

The current state of the Capacity Reservation.

CancellationTerms -> (list)

The cancellation terms associated with the quote, including the fee type and charge details.

(structure)

Describes the cancellation terms for cancelling a future-dated Capacity Reservation during its commitment duration.

CancellationType -> (string)

The type of cancellation charge. Possible values include commitment-wind-down .

ReservationState -> (string)

The state that the Capacity Reservation will transition to after cancellation.

CommittedInstanceCount -> (integer)

The number of instances under commitment after cancellation.

ChargeCommitmentDurationHours -> (long)

The number of hours for which cancellation charges will apply.

ChargeEndDate -> (timestamp)

The date and time at which cancellation charges will stop.

Tags -> (list)

The tags assigned to the cancellation quote.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.