Skip to content

describe_ipam_resource_discoveries

Operation

describe_ipam_resource_discoveries

describe_ipam_resource_discoveries(request: DescribeIpamResourceDiscoveriesInput | DescribeIpamResourceDiscoveriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamResourceDiscoveriesInputDict]) -> DescribeIpamResourceDiscoveriesOutput

Describes IPAM resource discoveries. 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
request DescribeIpamResourceDiscoveriesInput | DescribeIpamResourceDiscoveriesInputDict | 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[DescribeIpamResourceDiscoveriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamResourceDiscoveriesOutput

An instance of DescribeIpamResourceDiscoveriesOutput.

describe_ipam_resource_discoveries async

describe_ipam_resource_discoveries(request: DescribeIpamResourceDiscoveriesInput | DescribeIpamResourceDiscoveriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamResourceDiscoveriesInputDict]) -> DescribeIpamResourceDiscoveriesOutput

Describes IPAM resource discoveries. 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
request DescribeIpamResourceDiscoveriesInput | DescribeIpamResourceDiscoveriesInputDict | 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[DescribeIpamResourceDiscoveriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIpamResourceDiscoveriesOutput

An instance of DescribeIpamResourceDiscoveriesOutput.

Input

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

DescribeIpamResourceDiscoveriesInputDict

Bases: TypedDict

Dictionary form of DescribeIpamResourceDiscoveriesInput.

Attributes

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

The resource discovery filters.

ipam_resource_discovery_ids instance-attribute
ipam_resource_discovery_ids: Sequence[str] | None

The IPAM resource discovery IDs.

max_results instance-attribute
max_results: int | None

The maximum number of resource discoveries to return in one page of results.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

DescribeIpamResourceDiscoveriesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamResourceDiscoveriesInput structure.

Attributes

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 = ...

The resource discovery filters.

ipam_resource_discovery_ids class-attribute instance-attribute
ipam_resource_discovery_ids: list[str] | None = ...

The IPAM resource discovery IDs.

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

The maximum number of resource discoveries 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

DescribeIpamResourceDiscoveriesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamResourceDiscoveriesOutput structure.

Attributes

ipam_resource_discoveries class-attribute instance-attribute
ipam_resource_discoveries: list[IpamResourceDiscovery] | None = ...

The resource discoveries.

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.

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.