Skip to content

get_ipam_discovered_resource_cidrs async

get_ipam_discovered_resource_cidrs(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_resource_discovery_id: Optional[IpamResourceDiscoveryId] = None,
    resource_region: Optional[String] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[IpamMaxResults] = None,
) -> GetIpamDiscoveredResourceCidrsResult

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:

  • 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.

  • ipam_resource_discovery_id (Optional[IpamResourceDiscoveryId], default: None ) –

    A resource discovery ID.

  • resource_region (Optional[String], default: None ) –

    A resource Region.

  • filters (Optional[FilterList], default: None ) –

    Filters.

  • next_token (Optional[NextToken], default: None ) –

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

  • max_results (Optional[IpamMaxResults], default: None ) –

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

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def get_ipam_discovered_resource_cidrs(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_resource_discovery_id: Optional[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ] = None,
    resource_region: Optional["capo_ec2.types.string.String"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
) -> "capo_ec2.types.get_ipam_discovered_resource_cidrs_result.GetIpamDiscoveredResourceCidrsResult":
    """<p>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. </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>
        ipam_resource_discovery_id: <p>A resource discovery ID.</p>
        resource_region: <p>A resource Region.</p>
        filters: <p>Filters.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of discovered resource CIDRs to return in one page of results.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.get_ipam_discovered_resource_cidrs_request.GetIpamDiscoveredResourceCidrsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.get_ipam_discovered_resource_cidrs_result.GetIpamDiscoveredResourceCidrsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_discovered_resource_cidrs

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.get_ipam_discovered_resource_cidrs.async_get_ipam_discovered_resource_cidrs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamDiscoveredResourceCidrs")
    )
    input_: capo_ec2.types.get_ipam_discovered_resource_cidrs_request.GetIpamDiscoveredResourceCidrsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_resource_discovery_id is not None:
        input_["ipam_resource_discovery_id"] = ipam_resource_discovery_id
    if resource_region is not None:
        input_["resource_region"] = resource_region
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output