Skip to content

get_ipam_discovered_accounts

get_ipam_discovered_accounts(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_resource_discovery_id: Optional[IpamResourceDiscoveryId] = None,
    discovery_region: Optional[String] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[IpamMaxResults] = None,
) -> GetIpamDiscoveredAccountsResult

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

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.

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

    The Amazon Web Services Region that the account information is returned from.

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

    Discovered account 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 accounts to return in one page of results.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_ipam_discovered_accounts(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_resource_discovery_id: Optional[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ] = None,
    discovery_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_accounts_result.GetIpamDiscoveredAccountsResult":
    """<p>Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.</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>
        discovery_region: <p>The Amazon Web Services Region that the account information is returned from.</p>
        filters: <p>Discovered account 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 accounts to return in one page of results.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_ipam_discovered_accounts_request.GetIpamDiscoveredAccountsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_discovered_accounts_result.GetIpamDiscoveredAccountsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_discovered_accounts

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamDiscoveredAccounts")
    )
    input_: capo_ec2.types.get_ipam_discovered_accounts_request.GetIpamDiscoveredAccountsRequest = {}
    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 discovery_region is not None:
        input_["discovery_region"] = discovery_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output