ReleaseAddressCommand

Releases the specified Elastic IP address.

[Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

After you release an Elastic IP address, you might be able to recover it. For more information, see AllocateAddress.

Example Syntax

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

import { EC2Client, ReleaseAddressCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ReleaseAddressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ReleaseAddressRequest
  AllocationId: "STRING_VALUE",
  PublicIp: "STRING_VALUE",
  NetworkBorderGroup: "STRING_VALUE",
  DryRun: true || false,
};
const command = new ReleaseAddressCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

ReleaseAddressCommand Input

See ReleaseAddressCommandInput for more details

Parameter
Type
Description
AllocationId
string | undefined

The allocation ID. This parameter is required.

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.

NetworkBorderGroup
string | undefined

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

PublicIp
string | undefined

Deprecated.

ReleaseAddressCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

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