FMS / Client / get_admin_scope

get_admin_scope

FMS.Client.get_admin_scope(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_admin_scope(
    AdminAccount='string'
)

Parameters:

AdminAccount (string) –

[REQUIRED]

The administator account that you want to get the details for.

Return type:

dict

Returns:

Response Syntax

{
    'AdminScope': {
        'AccountScope': {
            'Accounts': [
                'string',
            ],
            'AllAccountsEnabled': True|False,
            'ExcludeSpecifiedAccounts': True|False
        },
        'OrganizationalUnitScope': {
            'OrganizationalUnits': [
                'string',
            ],
            'AllOrganizationalUnitsEnabled': True|False,
            'ExcludeSpecifiedOrganizationalUnits': True|False
        },
        'RegionScope': {
            'Regions': [
                'string',
            ],
            'AllRegionsEnabled': True|False
        },
        'PolicyTypeScope': {
            'PolicyTypes': [
                'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL'|'THIRD_PARTY_FIREWALL'|'IMPORT_NETWORK_FIREWALL',
            ],
            'AllPolicyTypesEnabled': True|False
        }
    },
    'Status': 'ONBOARDING'|'ONBOARDING_COMPLETE'|'OFFBOARDING'|'OFFBOARDING_COMPLETE'
}

Response Structure

• (dict) –

  • AdminScope (dict) –

    Contains details about the administrative scope of the requested account.

    • AccountScope (dict) –

      Defines the accounts that the specified Firewall Manager administrator can apply policies to.

      • Accounts (list) –

        The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

        • (string) –

      • AllAccountsEnabled (boolean) –

        A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

      • ExcludeSpecifiedAccounts (boolean) –

        A boolean value that excludes the accounts in AccountScope$Accounts from the administrator’s scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

    • OrganizationalUnitScope (dict) –

      Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.

      • OrganizationalUnits (list) –

        The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false, then the Firewall Manager administrator can only apply policies to the OUs in this list.

        • (string) –

      • AllOrganizationalUnitsEnabled (boolean) –

        A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.

      • ExcludeSpecifiedOrganizationalUnits (boolean) –

        A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the administrator’s scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot specify both.

    • RegionScope (dict) –

      Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

      • Regions (list) –

        The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.

        • (string) –

      • AllRegionsEnabled (boolean) –

        Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.

    • PolicyTypeScope (dict) –

      Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.

      • PolicyTypes (list) –

        The list of policy types that the specified Firewall Manager administrator can manage.

        • (string) –

      • AllPolicyTypesEnabled (boolean) –

        Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.

  • Status (string) –

    The current status of the request to onboard a member account as an Firewall Manager administator.

    • 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.

Exceptions

• FMS.Client.exceptions.InvalidOperationException

• FMS.Client.exceptions.InvalidInputException

• FMS.Client.exceptions.ResourceNotFoundException

• FMS.Client.exceptions.InternalErrorException