Request Parameters Response Elements Errors See Also

ModifyIpam

Modify the configurations of an IPAM.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AddOperatingRegion.N

Choose the operating Regions for the IPAM. Operating Regions are Amazon Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

Type: Array of AddIpamOperatingRegion objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Description

The description of the IPAM you want to modify.

Type: String

Required: No

DryRun

A check for 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.

Type: Boolean

Required: No

EnablePrivateGua

Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Type: Boolean

Required: No

IpamId

The ID of the IPAM you want to modify.

Type: String

Required: Yes

MeteredAccount

A metered account is an Amazon account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.

Possible values:

ipam-owner (default): The Amazon account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon account that owns the IP address is charged for the active IP address.

Type: String

Valid Values: ipam-owner | resource-owner

Required: No

RemoveOperatingRegion.N

The operating Regions to remove.

Type: Array of RemoveIpamOperatingRegion objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Tier

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

Type: String

Valid Values: free | advanced

Required: No

Response Elements

The following elements are returned by the service.

ipam

The results of the modification.

Type: Ipam object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.