ModifyIpamResourceDiscoveryCommand

Suggest an Edit

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.

Example Syntax

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

import { EC2Client, ModifyIpamResourceDiscoveryCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ModifyIpamResourceDiscoveryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ModifyIpamResourceDiscoveryRequest
  DryRun: true || false,
  IpamResourceDiscoveryId: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  AddOperatingRegions: [ // AddIpamOperatingRegionSet
    { // AddIpamOperatingRegion
      RegionName: "STRING_VALUE",
    },
  ],
  RemoveOperatingRegions: [ // RemoveIpamOperatingRegionSet
    { // RemoveIpamOperatingRegion
      RegionName: "STRING_VALUE",
    },
  ],
  AddOrganizationalUnitExclusions: [ // AddIpamOrganizationalUnitExclusionSet
    { // AddIpamOrganizationalUnitExclusion
      OrganizationsEntityPath: "STRING_VALUE",
    },
  ],
  RemoveOrganizationalUnitExclusions: [ // RemoveIpamOrganizationalUnitExclusionSet
    { // RemoveIpamOrganizationalUnitExclusion
      OrganizationsEntityPath: "STRING_VALUE",
    },
  ],
};
const command = new ModifyIpamResourceDiscoveryCommand(input);
const response = await client.send(command);
// { // ModifyIpamResourceDiscoveryResult
//   IpamResourceDiscovery: { // IpamResourceDiscovery
//     OwnerId: "STRING_VALUE",
//     IpamResourceDiscoveryId: "STRING_VALUE",
//     IpamResourceDiscoveryArn: "STRING_VALUE",
//     IpamResourceDiscoveryRegion: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     OperatingRegions: [ // IpamOperatingRegionSet
//       { // IpamOperatingRegion
//         RegionName: "STRING_VALUE",
//       },
//     ],
//     IsDefault: true || false,
//     State: "create-in-progress" || "create-complete" || "create-failed" || "modify-in-progress" || "modify-complete" || "modify-failed" || "delete-in-progress" || "delete-complete" || "delete-failed" || "isolate-in-progress" || "isolate-complete" || "restore-in-progress",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     OrganizationalUnitExclusions: [ // IpamOrganizationalUnitExclusionSet
//       { // IpamOrganizationalUnitExclusion
//         OrganizationsEntityPath: "STRING_VALUE",
//       },
//     ],
//   },
// };

ModifyIpamResourceDiscoveryCommand Input

See ModifyIpamResourceDiscoveryCommandInput for more details

Parameter
Type
Description
IpamResourceDiscoveryId
Required
string | undefined

A resource discovery ID.

AddOperatingRegions
AddIpamOperatingRegion[] | undefined

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

AddOrganizationalUnitExclusions
AddIpamOrganizationalUnitExclusion[] | undefined

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services 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.

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 Amazon Web Services CLI request process in Add or remove OU exclusions   in the Amazon VPC User Guide.

Description
string | undefined

A resource discovery description.

DryRun
boolean | undefined

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.

RemoveOperatingRegions
RemoveIpamOperatingRegion[] | undefined

Remove operating Regions.

RemoveOrganizationalUnitExclusions
RemoveIpamOrganizationalUnitExclusion[] | undefined

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services 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.

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 Amazon Web Services CLI request process in Add or remove OU exclusions   in the Amazon VPC User Guide.

ModifyIpamResourceDiscoveryCommand Output

See ModifyIpamResourceDiscoveryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
IpamResourceDiscovery
IpamResourceDiscovery | undefined

A resource discovery.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.