ModifyIpamResourceDiscovery
Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
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
-
Add operating Regions to the resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
Type: Array of AddIpamOperatingRegion objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- AddOrganizationalUnitExclusion.N
-
Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
Note
The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the AWS CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
Type: Array of AddIpamOrganizationalUnitExclusion objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- Description
-
A resource discovery description.
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
- IpamResourceDiscoveryId
-
A resource discovery ID.
Type: String
Required: Yes
- RemoveOperatingRegion.N
-
Remove operating Regions.
Type: Array of RemoveIpamOperatingRegion objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- RemoveOrganizationalUnitExclusion.N
-
Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
Note
The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the AWS CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
Type: Array of RemoveIpamOrganizationalUnitExclusion objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
Response Elements
The following elements are returned by the service.
- ipamResourceDiscovery
-
A resource discovery.
Type: IpamResourceDiscovery 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:
