get_ipam_pool_cidrs¶
Operation¶
get_ipam_pool_cidrs
¶
get_ipam_pool_cidrs(request: GetIpamPoolCidrsInput | GetIpamPoolCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPoolCidrsInputDict]) -> GetIpamPoolCidrsOutput
Get the CIDRs provisioned to an IPAM pool.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamPoolCidrsInput | GetIpamPoolCidrsInputDict | 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[GetIpamPoolCidrsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamPoolCidrsOutput
|
An instance of |
get_ipam_pool_cidrs
async
¶
get_ipam_pool_cidrs(request: GetIpamPoolCidrsInput | GetIpamPoolCidrsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPoolCidrsInputDict]) -> GetIpamPoolCidrsOutput
Get the CIDRs provisioned to an IPAM pool.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIpamPoolCidrsInput | GetIpamPoolCidrsInputDict | 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[GetIpamPoolCidrsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIpamPoolCidrsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetIpamPoolCidrsInputDict
¶
Bases: TypedDict
Dictionary form of GetIpamPoolCidrsInput.
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
¶
The ID of the IPAM pool you want the CIDR for.
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.
GetIpamPoolCidrsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPoolCidrsInput 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
¶
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 you want the CIDR for.
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.
Output¶
GetIpamPoolCidrsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIpamPoolCidrsOutput structure.
Attributes¶
ipam_pool_cidrs
class-attribute
instance-attribute
¶
ipam_pool_cidrs: list[IpamPoolCidr] | None = ...
Information about the CIDRs provisioned to an IPAM pool.
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
¶
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.