Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DisassociateResolverEndpointIpAddressCommandProtected

Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

Example

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

import { Route53ResolverClient, DisassociateResolverEndpointIpAddressCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import
// const { Route53ResolverClient, DisassociateResolverEndpointIpAddressCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import
const client = new Route53ResolverClient(config);
const input = { // DisassociateResolverEndpointIpAddressRequest
ResolverEndpointId: "STRING_VALUE", // required
IpAddress: { // IpAddressUpdate
IpId: "STRING_VALUE",
SubnetId: "STRING_VALUE",
Ip: "STRING_VALUE",
Ipv6: "STRING_VALUE",
},
};
const command = new DisassociateResolverEndpointIpAddressCommand(input);
const response = await client.send(command);
// { // DisassociateResolverEndpointIpAddressResponse
// ResolverEndpoint: { // ResolverEndpoint
// Id: "STRING_VALUE",
// CreatorRequestId: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Name: "STRING_VALUE",
// SecurityGroupIds: [ // SecurityGroupIds
// "STRING_VALUE",
// ],
// Direction: "INBOUND" || "OUTBOUND",
// IpAddressCount: Number("int"),
// HostVPCId: "STRING_VALUE",
// Status: "CREATING" || "OPERATIONAL" || "UPDATING" || "AUTO_RECOVERING" || "ACTION_NEEDED" || "DELETING",
// StatusMessage: "STRING_VALUE",
// CreationTime: "STRING_VALUE",
// ModificationTime: "STRING_VALUE",
// ResolverEndpointType: "IPV6" || "IPV4" || "DUALSTACK",
// },
// };

Param

DisassociateResolverEndpointIpAddressCommandInput

Returns

DisassociateResolverEndpointIpAddressCommandOutput

See

Throws

InternalServiceErrorException (client fault)

We encountered an unknown error. Try again in a few minutes.

Throws

InvalidParameterException (client fault)

One or more parameters in this request are not valid.

Throws

InvalidRequestException (client fault)

The request is invalid.

Throws

ResourceExistsException (client fault)

The resource that you tried to create already exists.

Throws

ResourceNotFoundException (client fault)

The specified resource doesn't exist.

Throws

ThrottlingException (client fault)

The request was throttled. Try again in a few minutes.

Throws

Route53ResolverServiceException

Base exception class for all service exceptions from Route53Resolver service.

Hierarchy

Constructors

Properties

Methods