ipam_discovered_accounts

Creates, updates, deletes, gets or lists an ipam_discovered_accounts resource.

Overview

Name	ipam_discovered_accounts
Type	Resource
Id	aws.ec2.ipam_discovered_accounts

Fields

The following fields are returned by SELECT queries:

get_ipam_discovered_accounts

Name	Datatype	Description
account_id	string	The account ID.
discovery_region	string	The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region.
failure_reason	string	The resource discovery failure reason.
last_attempted_discovery_time	string	The last attempted resource discovery time.
last_successful_discovery_time	string	The last successful resource discovery time.
organizational_unit_id	string	The ID of an Organizational Unit in Amazon Web Services Organizations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_discovered_accounts	select	IpamResourceDiscoveryId, DiscoveryRegion, region	DryRun, Filter, NextToken, MaxResults	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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DiscoveryRegion	string	The Amazon Web Services Region that the account information is returned from.
IpamResourceDiscoveryId	string	A resource discovery ID.
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
Filter	array	Discovered account filters.
MaxResults	integer	The maximum number of discovered accounts to return in one page of results.
NextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_ipam_discovered_accounts

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.

SELECT
account_id,
discovery_region,
failure_reason,
last_attempted_discovery_time,
last_successful_discovery_time,
organizational_unit_id
FROM aws.ec2.ipam_discovered_accounts
WHERE IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' -- required
AND DiscoveryRegion = '{{ DiscoveryRegion }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;