Skip to content

get_ipam_discovered_public_addresses async

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

Gets the public IP addresses that have been discovered by IPAM.

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 ) –

    An IPAM resource discovery ID.

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

    The Amazon Web Services Region for the IP address.

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

    Filters.

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

    The token for the next page of results.

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

    The maximum number of IPAM discovered public addresses to return in one page of results.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def get_ipam_discovered_public_addresses(
    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,
    address_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_public_addresses_result.GetIpamDiscoveredPublicAddressesResult":
    """<p>Gets the public IP addresses that have been discovered by IPAM.</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>An IPAM resource discovery ID.</p>
        address_region: <p>The Amazon Web Services Region for the IP address.</p>
        filters: <p>Filters.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of IPAM discovered public addresses 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_public_addresses_request.GetIpamDiscoveredPublicAddressesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.get_ipam_discovered_public_addresses_result.GetIpamDiscoveredPublicAddressesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_discovered_public_addresses

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamDiscoveredPublicAddresses")
    )
    input_: capo_ec2.types.get_ipam_discovered_public_addresses_request.GetIpamDiscoveredPublicAddressesRequest = {}
    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 address_region is not None:
        input_["address_region"] = address_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