DeleteSubnetCidrReservationCommand

Suggest an Edit

Deletes a subnet CIDR reservation.

Example Syntax

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

import { EC2Client, DeleteSubnetCidrReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteSubnetCidrReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteSubnetCidrReservationRequest
  SubnetCidrReservationId: "STRING_VALUE", // required
  DryRun: true || false,
};
const command = new DeleteSubnetCidrReservationCommand(input);
const response = await client.send(command);
// { // DeleteSubnetCidrReservationResult
//   DeletedSubnetCidrReservation: { // SubnetCidrReservation
//     SubnetCidrReservationId: "STRING_VALUE",
//     SubnetId: "STRING_VALUE",
//     Cidr: "STRING_VALUE",
//     ReservationType: "prefix" || "explicit",
//     OwnerId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//   },
// };

DeleteSubnetCidrReservationCommand Input

See DeleteSubnetCidrReservationCommandInput for more details

Parameter
Type
Description
SubnetCidrReservationId
Required
string | undefined

The ID of the subnet CIDR reservation.

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.

DeleteSubnetCidrReservationCommand Output

See DeleteSubnetCidrReservationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeletedSubnetCidrReservation
SubnetCidrReservation | undefined

Information about the deleted subnet CIDR reservation.

Throws

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