capacity_block_status

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

Overview

Name	capacity_block_status
Type	Resource
Id	aws.ec2.capacity_block_status

Fields

The following fields are returned by SELECT queries:

describe_capacity_block_status

Name	Datatype	Description
capacity_block_id	string	The ID of the Capacity Block.
capacity_reservation_statuses	string	The availability of capacity for the Capacity Block reservations.
interconnect_status	string	The status of the high-bandwidth accelerator interconnect. Possible states include: ok the accelerator interconnect is healthy. impaired - accelerator interconnect communication is impaired. insufficient-data - insufficient data to determine accelerator interconnect status.
total_available_capacity	integer	The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.
total_capacity	integer	The combined amount of Available and Unavailable capacity in the Capacity Block.
total_unavailable_capacity	integer	The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_capacity_block_status	select	region	CapacityBlockId, NextToken, MaxResults, Filter, DryRun	Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.

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)
CapacityBlockId	array	The ID of the Capacity Block.
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. interconnect-status - The status of the interconnect for the Capacity Block (ok | impaired | insufficient-data).
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_status

Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.

SELECT
capacity_block_id,
capacity_reservation_statuses,
interconnect_status,
total_available_capacity,
total_capacity,
total_unavailable_capacity
FROM aws.ec2.capacity_block_status
WHERE region = '{{ region }}' -- required
AND CapacityBlockId = '{{ CapacityBlockId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;