UnassignIpv6AddressesCommand

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

Example Syntax

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

import { EC2Client, UnassignIpv6AddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, UnassignIpv6AddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // UnassignIpv6AddressesRequest
  Ipv6Prefixes: [ // IpPrefixList
    "STRING_VALUE",
  ],
  NetworkInterfaceId: "STRING_VALUE", // required
  Ipv6Addresses: [ // Ipv6AddressList
    "STRING_VALUE",
  ],
};
const command = new UnassignIpv6AddressesCommand(input);
const response = await client.send(command);
// { // UnassignIpv6AddressesResult
//   NetworkInterfaceId: "STRING_VALUE",
//   UnassignedIpv6Addresses: [ // Ipv6AddressList
//     "STRING_VALUE",
//   ],
//   UnassignedIpv6Prefixes: [ // IpPrefixList
//     "STRING_VALUE",
//   ],
// };

UnassignIpv6AddressesCommand Input

Parameter
Type
Description
NetworkInterfaceId
Required
string | undefined

The ID of the network interface.

Ipv6Addresses
string[] | undefined

The IPv6 addresses to unassign from the network interface.

Ipv6Prefixes
string[] | undefined

The IPv6 prefixes to unassign from the network interface.

UnassignIpv6AddressesCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NetworkInterfaceId
string | undefined

The ID of the network interface.

UnassignedIpv6Addresses
string[] | undefined

The IPv6 addresses that have been unassigned from the network interface.

UnassignedIpv6Prefixes
string[] | undefined

The IPv4 prefixes that have been unassigned from the network interface.

Throws

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