DescribeCapacityBlockExtensionOfferingsCommand

Suggest an Edit

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeCapacityBlockExtensionOfferingsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeCapacityBlockExtensionOfferingsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeCapacityBlockExtensionOfferingsRequest
  DryRun: true || false,
  CapacityBlockExtensionDurationHours: Number("int"), // required
  CapacityReservationId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeCapacityBlockExtensionOfferingsCommand(input);
const response = await client.send(command);
// { // DescribeCapacityBlockExtensionOfferingsResult
//   CapacityBlockExtensionOfferings: [ // CapacityBlockExtensionOfferingSet
//     { // CapacityBlockExtensionOffering
//       CapacityBlockExtensionOfferingId: "STRING_VALUE",
//       InstanceType: "STRING_VALUE",
//       InstanceCount: Number("int"),
//       AvailabilityZone: "STRING_VALUE",
//       AvailabilityZoneId: "STRING_VALUE",
//       StartDate: new Date("TIMESTAMP"),
//       CapacityBlockExtensionStartDate: new Date("TIMESTAMP"),
//       CapacityBlockExtensionEndDate: new Date("TIMESTAMP"),
//       CapacityBlockExtensionDurationHours: Number("int"),
//       UpfrontFee: "STRING_VALUE",
//       CurrencyCode: "STRING_VALUE",
//       Tenancy: "default" || "dedicated",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeCapacityBlockExtensionOfferingsCommand Input

See DescribeCapacityBlockExtensionOfferingsCommandInput for more details

Parameter
Type
Description
CapacityBlockExtensionDurationHours
Required
number | undefined

The duration of the Capacity Block extension offering in hours.

CapacityReservationId
Required
string | undefined

The ID of the Capacity reservation to be extended.

DryRun
boolean | undefined

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.

MaxResults
number | undefined

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

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

DescribeCapacityBlockExtensionOfferingsCommand Output

See DescribeCapacityBlockExtensionOfferingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CapacityBlockExtensionOfferings
CapacityBlockExtensionOffering[] | undefined

The recommended Capacity Block extension offerings for the dates specified.

NextToken
string | undefined

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

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.