capacity_reservation_cancellation_quotes

Creates, updates, deletes, gets or lists a capacity_reservation_cancellation_quotes resource.

Overview

Name	capacity_reservation_cancellation_quotes
Type	Resource
Id	aws.ec2.capacity_reservation_cancellation_quotes

Fields

The following fields are returned by SELECT queries:

describe_capacity_reservation_cancellation_quotes

Name	Datatype	Description
cancellation_terms	string	The cancellation terms associated with the quote, including the fee type and charge details.
capacity_reservation_cancellation_quote_id	string	The ID of the cancellation quote.
capacity_reservation_id	string	The ID of the Capacity Reservation associated with the cancellation quote.
create_time	string	The date and time at which the cancellation quote was created.
current_configuration	string	The current configuration of the Capacity Reservation.
expiration_time	string	The date and time at which the cancellation quote expires.
quote_state	string	The state of the cancellation quote. Possible values include pending, active, and expired.
tags	string	The tags assigned to the cancellation quote.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_capacity_reservation_cancellation_quotes	select	region	CapacityReservationCancellationQuoteId, MaxResults, NextToken, DryRun, Filter	Describes one or more Capacity Reservation cancellation quotes. The results describe only the quotes that you have previously generated by using the CreateCapacityReservationCancellationQuote action.
create_capacity_reservation_cancellation_quote	insert	CapacityReservationId, region	ClientToken, TagSpecification, DryRun	Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CapacityReservationId	string	The ID of the Capacity Reservation.
region	string	AWS region (default: us-east-1)
CapacityReservationCancellationQuoteId	array	The IDs of the cancellation quotes to describe.
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
DryRun	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.
Filter	array	One or more filters. Filter names and values are case-sensitive.
MaxResults	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.
NextToken	string	The token to use to retrieve the next page of results.
TagSpecification	array	The tags to apply to the cancellation quote.

SELECT examples

describe_capacity_reservation_cancellation_quotes

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

SELECT
cancellation_terms,
capacity_reservation_cancellation_quote_id,
capacity_reservation_id,
create_time,
current_configuration,
expiration_time,
quote_state,
tags
FROM aws.ec2.capacity_reservation_cancellation_quotes
WHERE region = '{{ region }}' -- required
AND CapacityReservationCancellationQuoteId = '{{ CapacityReservationCancellationQuoteId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
;

INSERT examples

create_capacity_reservation_cancellation_quote

Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours.

INSERT INTO aws.ec2.capacity_reservation_cancellation_quotes (
CapacityReservationId,
region,
ClientToken,
TagSpecification,
DryRun
)
SELECT 
'{{ CapacityReservationId }}',
'{{ region }}',
'{{ ClientToken }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
cancellation_terms,
capacity_reservation_cancellation_quote_id,
capacity_reservation_id,
create_time,
current_configuration,
expiration_time,
quote_state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: capacity_reservation_cancellation_quotes
props:
  - name: CapacityReservationId
    value: "{{ CapacityReservationId }}"
    description: Required parameter for the capacity_reservation_cancellation_quotes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the capacity_reservation_cancellation_quotes resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the cancellation quote.
    description: The tags to apply to the cancellation quote.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.