Skip to content

EC2  >  Operations  >  associate_ipam_resource_discovery

associate_ipam_resource_discovery

Operation

associate_ipam_resource_discovery async

associate_ipam_resource_discovery(request: AssociateIpamResourceDiscoveryInput | AssociateIpamResourceDiscoveryInputDict, /, *, plugins: list[Plugin] | None = None) -> AssociateIpamResourceDiscoveryOutput
associate_ipam_resource_discovery(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateIpamResourceDiscoveryInputDict]) -> AssociateIpamResourceDiscoveryOutput

Associates an IPAM resource discovery with an Amazon VPC IPAM. 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
AssociateIpamResourceDiscoveryOutput

An instance of AssociateIpamResourceDiscoveryOutput.

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

AssociateIpamResourceDiscoveryInput dataclass

Bases: _SerdeShape

Dataclass for AssociateIpamResourceDiscoveryInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

A client token.

This field is autopopulated if not provided.

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_id class-attribute instance-attribute
ipam_id: str | None = ...

An IPAM ID.

ipam_resource_discovery_id class-attribute instance-attribute
ipam_resource_discovery_id: str | None = ...

A resource discovery ID.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

Tag specifications.

Dictionaries

AssociateIpamResourceDiscoveryInputDict

Bases: TypedDict

Dictionary form of AssociateIpamResourceDiscoveryInput.

Attributes
client_token instance-attribute
client_token: str | None

A client token.

This field is autopopulated if not provided.

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_id instance-attribute
ipam_id: Required[str]

An IPAM ID.

ipam_resource_discovery_id instance-attribute
ipam_resource_discovery_id: Required[str]

A resource discovery ID.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

Tag specifications.

Output

AssociateIpamResourceDiscoveryOutput dataclass

Bases: _SerdeShape

Dataclass for AssociateIpamResourceDiscoveryOutput structure.

Attributes

ipam_resource_discovery_association class-attribute instance-attribute
ipam_resource_discovery_association: IpamResourceDiscoveryAssociation | None = ...

A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.