Skip to content

EC2  >  Operations  >  get_ipam_resource_cidrs

get_ipam_resource_cidrs

Operation

get_ipam_resource_cidrs async

get_ipam_resource_cidrs(request: GetIpamResourceCidrsInput | GetIpamResourceCidrsInputDict, /, *, plugins: list[Plugin] | None = None) -> GetIpamResourceCidrsOutput
get_ipam_resource_cidrs(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamResourceCidrsInputDict]) -> GetIpamResourceCidrsOutput

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. 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
GetIpamResourceCidrsOutput

An instance of GetIpamResourceCidrsOutput.

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

GetIpamResourceCidrsInput dataclass

Bases: _SerdeShape

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

One or more filters for the request. For more information about filtering, see Filtering CLI output.

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

The ID of the IPAM pool that the resource is in.

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

The ID of the scope that the resource is in.

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

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token for the next page of results.

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

The ID of the resource.

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

The ID of the Amazon Web Services account that owns the resource.

resource_tag class-attribute instance-attribute
resource_tag: RequestIpamResourceTag | None = ...

The resource tag.

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

The resource type.

Dictionaries

GetIpamResourceCidrsInputDict

Bases: TypedDict

Dictionary form of GetIpamResourceCidrsInput.

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

One or more filters for the request. For more information about filtering, see Filtering CLI output.

ipam_pool_id instance-attribute
ipam_pool_id: str | None

The ID of the IPAM pool that the resource is in.

ipam_scope_id instance-attribute
ipam_scope_id: Required[str]

The ID of the scope that the resource is in.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

resource_id instance-attribute
resource_id: str | None

The ID of the resource.

resource_owner instance-attribute
resource_owner: str | None

The ID of the Amazon Web Services account that owns the resource.

resource_tag instance-attribute

The resource tag.

resource_type instance-attribute
resource_type: str | None

The resource type.

Output

GetIpamResourceCidrsOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamResourceCidrsOutput structure.

Attributes

ipam_resource_cidrs class-attribute instance-attribute
ipam_resource_cidrs: list[IpamResourceCidr] | None = ...

The resource CIDRs.

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.