admin_scopes

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

Overview

Name	admin_scopes
Type	Resource
Id	aws.fms.admin_scopes

Fields

The following fields are returned by SELECT queries:

get_admin_scope

Name	Datatype	Description
admin_scope	object	Contains details about the administrative scope of the requested account.
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
get_admin_scope	select	region		Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

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

get_admin_scope

Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

SELECT
admin_scope,
status
FROM aws.fms.admin_scopes
WHERE region = '{{ region }}' -- required
;