ModifyIpamPoolAllocation
Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.
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.
- Description
-
The new description for the IPAM pool allocation. If you submit a
nullvalue, the description is removed from the allocation.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 isUnauthorizedOperation.Type: Boolean
Required: No
- IpamPoolAllocationId
-
The ID of the IPAM pool allocation you want to modify.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- ipamPoolAllocation
-
The modified IPAM pool allocation.
Type: IpamPoolAllocation 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.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
