Skip to content

get_ipam_discovered_public_addresses

Operation

get_ipam_discovered_public_addresses

get_ipam_discovered_public_addresses(request: GetIpamDiscoveredPublicAddressesInput | GetIpamDiscoveredPublicAddressesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredPublicAddressesInputDict]) -> GetIpamDiscoveredPublicAddressesOutput

Gets the public IP addresses that have been discovered by IPAM.

Parameters:

Name Type Description Default
request GetIpamDiscoveredPublicAddressesInput | GetIpamDiscoveredPublicAddressesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetIpamDiscoveredPublicAddressesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredPublicAddressesOutput

An instance of GetIpamDiscoveredPublicAddressesOutput.

get_ipam_discovered_public_addresses async

get_ipam_discovered_public_addresses(request: GetIpamDiscoveredPublicAddressesInput | GetIpamDiscoveredPublicAddressesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredPublicAddressesInputDict]) -> GetIpamDiscoveredPublicAddressesOutput

Gets the public IP addresses that have been discovered by IPAM.

Parameters:

Name Type Description Default
request GetIpamDiscoveredPublicAddressesInput | GetIpamDiscoveredPublicAddressesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetIpamDiscoveredPublicAddressesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredPublicAddressesOutput

An instance of GetIpamDiscoveredPublicAddressesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetIpamDiscoveredPublicAddressesInputDict

Bases: TypedDict

Dictionary form of GetIpamDiscoveredPublicAddressesInput.

Attributes

address_region instance-attribute
address_region: Required[str]

The Amazon Web Services Region for the IP address.

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

Filters.

ipam_resource_discovery_id instance-attribute
ipam_resource_discovery_id: Required[str]

An IPAM resource discovery ID.

max_results instance-attribute
max_results: int | None

The maximum number of IPAM discovered public addresses to return in one page of results.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

GetIpamDiscoveredPublicAddressesInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredPublicAddressesInput structure.

Attributes

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

The Amazon Web Services Region for the IP address.

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

Filters.

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

An IPAM resource discovery ID.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of IPAM discovered public addresses to return in one page of results.

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

The token for the next page of results.

Output

GetIpamDiscoveredPublicAddressesOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredPublicAddressesOutput structure.

Attributes

ipam_discovered_public_addresses class-attribute instance-attribute
ipam_discovered_public_addresses: list[IpamDiscoveredPublicAddress] | None = ...

IPAM discovered public addresses.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

oldest_sample_time class-attribute instance-attribute
oldest_sample_time: datetime | None = ...

The oldest successful resource discovery time.

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.