organization_admin_accounts

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

Overview

Name	organization_admin_accounts
Type	Resource
Id	aws.guardduty.organization_admin_accounts

Fields

The following fields are returned by SELECT queries:

list_organization_admin_accounts

Name	Datatype	Description
admin_account_id	string	The Amazon Web Services account ID for the account.
admin_status	string	Indicates whether the account is enabled as the delegated administrator. (ENABLED, DISABLE_IN_PROGRESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_organization_admin_accounts	select	region	maxResults, nextToken	Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.

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
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response.
nextToken	string	A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

SELECT examples

list_organization_admin_accounts

Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.

SELECT
admin_account_id,
admin_status
FROM aws.guardduty.organization_admin_accounts
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;