# DescribeCapacityBlocks
<a name="API_DescribeCapacityBlocks"></a>

Describes details about Capacity Blocks in the Amazon Region that you're currently using.

## Request Parameters
<a name="API_DescribeCapacityBlocks_RequestParameters"></a>

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CapacityBlockId.N**   
The IDs of the Capacity Blocks.  
Type: Array of strings  
Required: No

 **DryRun**   
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`.  
Type: Boolean  
Required: No

 **Filter.N**   
 One or more filters.   
+  `capacity-block-id` - The ID of the Capacity Block.
+  `ultraserver-type` - The Capacity Block type. The type can be `instances` or `ultraservers`.
+  `availability-zone` - The Availability Zone of the Capacity Block.
+  `start-date` - The date and time at which the Capacity Block was started.
+  `end-date` - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.
+  `create-date` - The date and time at which the Capacity Block was created.
+  `state` - The state of the Capacity Block (`active` \$1 `expired` \$1 `unavailable` \$1 `cancelled` \$1 `failed` \$1 `scheduled` \$1 `payment-pending` \$1 `payment-failed`).
+  `tags` - The tags assigned to the Capacity Block.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 **MaxResults**   
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](https://docs.amazonaws.cn/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 **NextToken**   
The token to use to retrieve the next page of results.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeCapacityBlocks_ResponseElements"></a>

The following elements are returned by the service.

 **capacityBlockSet**   
The Capacity Blocks.  
Type: Array of [CapacityBlock](API_CapacityBlock.md) objects

 **nextToken**   
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors
<a name="API_DescribeCapacityBlocks_Errors"></a>

For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also
<a name="API_DescribeCapacityBlocks_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/ec2-2016-11-15/DescribeCapacityBlocks) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlocks)