admin_accounts_for_organizations

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

Overview

Name	admin_accounts_for_organizations
Type	Resource
Id	aws.fms.admin_accounts_for_organizations

Fields

The following fields are returned by SELECT queries:

list_admin_accounts_for_organization

Name	Datatype	Description
admin_account	string	The Amazon Web Services account ID of the Firewall Manager administrator's account. (pattern: <code>^[0-9]+$</code>)
default_admin	boolean	A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.
status	string	The current status of the request to onboard a member account as an Firewall Manager administrator. ONBOARDING - The account is onboarding to Firewall Manager as an administrator. ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope. OFFBOARDING - The account is being removed as an Firewall Manager administrator. OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator. (ONBOARDING, ONBOARDING_COMPLETE, OFFBOARDING, OFFBOARDING_COMPLETE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_admin_accounts_for_organization	select	region		Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. This operation can be called only from the organization's 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)

SELECT examples

list_admin_accounts_for_organization

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. This operation can be called only from the organization's management account.

SELECT
admin_account,
default_admin,
status
FROM aws.fms.admin_accounts_for_organizations
WHERE region = '{{ region }}' -- required
;