Skip to content

describe_ipam_prefix_list_resolvers

describe_ipam_prefix_list_resolvers(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[IpamMaxResults] = None,
    next_token: Optional[NextToken] = None,
    ipam_prefix_list_resolver_ids: Optional[ValueStringList] = None,
) -> DescribeIpamPrefixListResolversResult

Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.

Parameters:

  • dry_run (Optional[Boolean], default: 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 (Optional[FilterList], default: None ) –

    One or more filters to limit the results.

  • max_results (Optional[IpamMaxResults], default: 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 (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • ipam_prefix_list_resolver_ids (Optional[ValueStringList], default: None ) –

    The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_ipam_prefix_list_resolvers(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    ipam_prefix_list_resolver_ids: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
) -> "capo_ec2.types.describe_ipam_prefix_list_resolvers_result.DescribeIpamPrefixListResolversResult":
    """<p>Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        filters: <p>One or more filters to limit the results.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token for the next page of results.</p>
        ipam_prefix_list_resolver_ids: <p>The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_ipam_prefix_list_resolvers_request.DescribeIpamPrefixListResolversRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_ipam_prefix_list_resolvers_result.DescribeIpamPrefixListResolversResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipam_prefix_list_resolvers

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_ipam_prefix_list_resolvers.describe_ipam_prefix_list_resolvers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpamPrefixListResolvers")
    )
    input_: capo_ec2.types.describe_ipam_prefix_list_resolvers_request.DescribeIpamPrefixListResolversRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if ipam_prefix_list_resolver_ids is not None:
        input_["ipam_prefix_list_resolver_ids"] = ipam_prefix_list_resolver_ids

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output