modify_ipam_resource_discovery¶
Operation¶
modify_ipam_resource_discovery
async
¶
modify_ipam_resource_discovery(request: ModifyIpamResourceDiscoveryInput | ModifyIpamResourceDiscoveryInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyIpamResourceDiscoveryOutput
modify_ipam_resource_discovery(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamResourceDiscoveryInputDict]) -> ModifyIpamResourceDiscoveryOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyIpamResourceDiscoveryOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ModifyIpamResourceDiscoveryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamResourceDiscoveryInput structure.
Attributes¶
add_operating_regions
class-attribute
instance-attribute
¶
add_operating_regions: list[AddIpamOperatingRegion] | None = ...
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.
add_organizational_unit_exclusions
class-attribute
instance-attribute
¶
add_organizational_unit_exclusions: list[AddIpamOrganizationalUnitExclusion] | None = ...
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.
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 Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A resource discovery description.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
ipam_resource_discovery_id
class-attribute
instance-attribute
¶
ipam_resource_discovery_id: str | None = ...
A resource discovery ID.
remove_operating_regions
class-attribute
instance-attribute
¶
remove_operating_regions: list[RemoveIpamOperatingRegion] | None = ...
Remove operating Regions.
remove_organizational_unit_exclusions
class-attribute
instance-attribute
¶
remove_organizational_unit_exclusions: list[RemoveIpamOrganizationalUnitExclusion] | None = ...
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.
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 Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
Dictionaries¶
ModifyIpamResourceDiscoveryInputDict
¶
Bases: TypedDict
Dictionary form of ModifyIpamResourceDiscoveryInput.
Attributes¶
add_operating_regions
instance-attribute
¶
add_operating_regions: Sequence[AddIpamOperatingRegion | AddIpamOperatingRegionDict] | None
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.
add_organizational_unit_exclusions
instance-attribute
¶
add_organizational_unit_exclusions: Sequence[AddIpamOrganizationalUnitExclusion | AddIpamOrganizationalUnitExclusionDict] | None
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.
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 Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
ipam_resource_discovery_id
instance-attribute
¶
A resource discovery ID.
remove_operating_regions
instance-attribute
¶
remove_operating_regions: Sequence[RemoveIpamOperatingRegion | RemoveIpamOperatingRegionDict] | None
Remove operating Regions.
remove_organizational_unit_exclusions
instance-attribute
¶
remove_organizational_unit_exclusions: Sequence[RemoveIpamOrganizationalUnitExclusion | RemoveIpamOrganizationalUnitExclusionDict] | None
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.
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 Amazon Web Services CLI request process in Add or remove OU exclusions in the Amazon VPC User Guide.
Output¶
ModifyIpamResourceDiscoveryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamResourceDiscoveryOutput structure.
Attributes¶
ipam_resource_discovery
class-attribute
instance-attribute
¶
ipam_resource_discovery: IpamResourceDiscovery | None = ...
A resource discovery.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.