ModifyIpamScope
Modify an IPAM scope.
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 description of the scope 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 isUnauthorizedOperation.Type: Boolean
Required: No
- ExternalAuthorityConfiguration
-
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges.
Type: ExternalAuthorityConfiguration object
Required: No
- IpamScopeId
-
The ID of the scope you want to modify.
Type: String
Required: Yes
- RemoveExternalAuthorityConfiguration
-
Remove the external authority configuration.
trueto remove.Type: Boolean
Required: No
Response Elements
The following elements are returned by the service.
- ipamScope
-
The results of the modification.
Type: IpamScope 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:
