Skip to content

get_ipam_prefix_list_resolver_rules

Operation

get_ipam_prefix_list_resolver_rules

get_ipam_prefix_list_resolver_rules(request: GetIpamPrefixListResolverRulesInput | GetIpamPrefixListResolverRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPrefixListResolverRulesInputDict]) -> GetIpamPrefixListResolverRulesOutput

Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.

Parameters:

Name Type Description Default
request GetIpamPrefixListResolverRulesInput | GetIpamPrefixListResolverRulesInputDict | 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[GetIpamPrefixListResolverRulesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamPrefixListResolverRulesOutput

An instance of GetIpamPrefixListResolverRulesOutput.

get_ipam_prefix_list_resolver_rules async

get_ipam_prefix_list_resolver_rules(request: GetIpamPrefixListResolverRulesInput | GetIpamPrefixListResolverRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPrefixListResolverRulesInputDict]) -> GetIpamPrefixListResolverRulesOutput

Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.

Parameters:

Name Type Description Default
request GetIpamPrefixListResolverRulesInput | GetIpamPrefixListResolverRulesInputDict | 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[GetIpamPrefixListResolverRulesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamPrefixListResolverRulesOutput

An instance of GetIpamPrefixListResolverRulesOutput.

Input

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

GetIpamPrefixListResolverRulesInputDict

Bases: TypedDict

Dictionary form of GetIpamPrefixListResolverRulesInput.

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 to limit the results.

ipam_prefix_list_resolver_id instance-attribute
ipam_prefix_list_resolver_id: Required[str]

The ID of the IPAM prefix list resolver whose rules you want to retrieve.

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.

GetIpamPrefixListResolverRulesInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamPrefixListResolverRulesInput 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 to limit the results.

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

The ID of the IPAM prefix list resolver whose rules you want to retrieve.

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.

Output

GetIpamPrefixListResolverRulesOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamPrefixListResolverRulesOutput structure.

Attributes

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.

rules class-attribute instance-attribute
rules: list[IpamPrefixListResolverRule] | None = ...

The CIDR selection rules for the IPAM prefix list resolver.