organization_admin_accounts

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

Overview

Name	organization_admin_accounts
Type	Resource
Id	aws.securityhub.organization_admin_accounts

Fields

The following fields are returned by SELECT queries:

list_organization_admin_accounts

Name	Datatype	Description
account_id	string	The Amazon Web Services account identifier of the Security Hub CSPM administrator account. (pattern: <code>.\S.</code>)
status	string	The current status of the Security Hub CSPM administrator account. Indicates whether the account is currently enabled as a Security Hub CSPM 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, Feature	Lists the Security Hub CSPM administrator accounts. Can only be called by the organization management account.

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)
Feature	string	The feature where the delegated administrator account is listed. Defaults to Security Hub CSPM if not specified.
MaxResults	integer	The maximum number of items to return in the response.
NextToken	string	The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

SELECT examples

list_organization_admin_accounts

Lists the Security Hub CSPM administrator accounts. Can only be called by the organization management account.

SELECT
account_id,
status
FROM aws.securityhub.organization_admin_accounts
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Feature = '{{ Feature }}'
;