Skip to content

get_ipam_discovered_resource_cidrs

Operation

get_ipam_discovered_resource_cidrs

get_ipam_discovered_resource_cidrs(request: GetIpamDiscoveredResourceCidrsInput | GetIpamDiscoveredResourceCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredResourceCidrsInputDict]) -> GetIpamDiscoveredResourceCidrsOutput

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

Parameters:

Name Type Description Default
request GetIpamDiscoveredResourceCidrsInput | GetIpamDiscoveredResourceCidrsInputDict | 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[GetIpamDiscoveredResourceCidrsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredResourceCidrsOutput

An instance of GetIpamDiscoveredResourceCidrsOutput.

get_ipam_discovered_resource_cidrs async

get_ipam_discovered_resource_cidrs(request: GetIpamDiscoveredResourceCidrsInput | GetIpamDiscoveredResourceCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredResourceCidrsInputDict]) -> GetIpamDiscoveredResourceCidrsOutput

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

Parameters:

Name Type Description Default
request GetIpamDiscoveredResourceCidrsInput | GetIpamDiscoveredResourceCidrsInputDict | 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[GetIpamDiscoveredResourceCidrsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredResourceCidrsOutput

An instance of GetIpamDiscoveredResourceCidrsOutput.

Input

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

GetIpamDiscoveredResourceCidrsInputDict

Bases: TypedDict

Dictionary form of GetIpamDiscoveredResourceCidrsInput.

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

Filters.

ipam_resource_discovery_id instance-attribute
ipam_resource_discovery_id: Required[str]

A resource discovery ID.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

Specify the pagination token from a previous request to retrieve the next page of results.

resource_region instance-attribute
resource_region: Required[str]

A resource Region.

GetIpamDiscoveredResourceCidrsInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredResourceCidrsInput 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 = ...

Filters.

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

A resource discovery ID.

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

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

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

Specify the pagination token from a previous request to retrieve the next page of results.

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

A resource Region.

Output

GetIpamDiscoveredResourceCidrsOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredResourceCidrsOutput structure.

Attributes

ipam_discovered_resource_cidrs class-attribute instance-attribute
ipam_discovered_resource_cidrs: list[IpamDiscoveredResourceCidr] | None = ...

Discovered resource CIDRs.

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

Specify the pagination token from a previous request to retrieve the next page of results.

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.