capacity_block_extension_histories

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

Overview

Name	capacity_block_extension_histories
Type	Resource
Id	aws.ec2.capacity_block_extension_histories

Fields

The following fields are returned by SELECT queries:

describe_capacity_block_extension_history

Name	Datatype	Description
availability_zone	string	The Availability Zone of the Capacity Block extension.
availability_zone_id	string	The Availability Zone ID of the Capacity Block extension.
capacity_block_extension_duration_hours	integer	The duration of the Capacity Block extension in hours.
capacity_block_extension_end_date	string	The end date of the Capacity Block extension.
capacity_block_extension_offering_id	string	The ID of the Capacity Block extension offering.
capacity_block_extension_purchase_date	string	The date when the Capacity Block extension was purchased.
capacity_block_extension_start_date	string	The start date of the Capacity Block extension.
capacity_block_extension_status	string	The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses: payment-pending - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed. payment-failed - Payment for the Capacity Block extension request was not successful. payment-succeeded - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID.
capacity_reservation_id	string	The reservation ID of the Capacity Block extension.
currency_code	string	The currency of the payment for the Capacity Block extension.
instance_count	integer	The number of instances in the Capacity Block extension.
instance_type	string	The instance type of the Capacity Block extension.
upfront_fee	string	The total price to be paid up front.
zone_type	string	The type of zone where the Capacity Block extension is located.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_capacity_block_extension_history	select	region	CapacityReservationId, NextToken, MaxResults, Filter, DryRun	Describes the events for the specified Capacity Block extension during the specified time.

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
region	string	AWS region (default: us-east-1)
CapacityReservationId	array	The IDs of Capacity Block reservations that you want to display the history for.
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 availability-zone - The Availability Zone of the extension. availability-zone-id - The Availability Zone ID of the extension. capacity-block-extension-offering-id - The ID of the extension offering. capacity-block-extension-status - The status of the extension (payment-pending | payment-failed | payment-succeeded). capacity-reservation-id - The reservation ID of the extension. instance-type - The instance type of the extension.
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.

SELECT examples

describe_capacity_block_extension_history

Describes the events for the specified Capacity Block extension during the specified time.

SELECT
availability_zone,
availability_zone_id,
capacity_block_extension_duration_hours,
capacity_block_extension_end_date,
capacity_block_extension_offering_id,
capacity_block_extension_purchase_date,
capacity_block_extension_start_date,
capacity_block_extension_status,
capacity_reservation_id,
currency_code,
instance_count,
instance_type,
upfront_fee,
zone_type
FROM aws.ec2.capacity_block_extension_histories
WHERE region = '{{ region }}' -- required
AND CapacityReservationId = '{{ CapacityReservationId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;