create_ipam_resource_discovery¶
Operation¶
create_ipam_resource_discovery
async
¶
create_ipam_resource_discovery(request: CreateIpamResourceDiscoveryInput | CreateIpamResourceDiscoveryInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateIpamResourceDiscoveryOutput
create_ipam_resource_discovery(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateIpamResourceDiscoveryInputDict]) -> CreateIpamResourceDiscoveryOutput
Creates an IPAM 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 |
|---|---|
CreateIpamResourceDiscoveryOutput
|
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¶
CreateIpamResourceDiscoveryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamResourceDiscoveryInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A client token for the IPAM resource discovery.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the IPAM resource discovery.
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.
operating_regions
class-attribute
instance-attribute
¶
operating_regions: list[AddIpamOperatingRegion] | None = ...
Operating Regions for the IPAM 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.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
Tag specifications for the IPAM resource discovery.
Dictionaries¶
CreateIpamResourceDiscoveryInputDict
¶
Bases: TypedDict
Dictionary form of CreateIpamResourceDiscoveryInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A client token for the IPAM resource discovery.
This field is autopopulated if not provided.
description
instance-attribute
¶
description: str | None
A description for the IPAM resource discovery.
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.
operating_regions
instance-attribute
¶
operating_regions: Sequence[AddIpamOperatingRegion | AddIpamOperatingRegionDict] | None
Operating Regions for the IPAM 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.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
Tag specifications for the IPAM resource discovery.
Output¶
CreateIpamResourceDiscoveryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamResourceDiscoveryOutput structure.
Attributes¶
ipam_resource_discovery
class-attribute
instance-attribute
¶
ipam_resource_discovery: IpamResourceDiscovery | None = ...
An IPAM 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.