FMS / Client / list_admin_accounts_for_organization

list_admin_accounts_for_organization#

FMS.Client.list_admin_accounts_for_organization(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_admin_accounts_for_organization(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • MaxResults (integer) – The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Return type:

dict

Returns:

Response Syntax

{
    'AdminAccounts': [
        {
            'AdminAccount': 'string',
            'DefaultAdmin': True|False,
            'Status': 'ONBOARDING'|'ONBOARDING_COMPLETE'|'OFFBOARDING'|'OFFBOARDING_COMPLETE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AdminAccounts (list) –

      A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

      • (dict) –

        Contains high level information about the Firewall Manager administrator account.

        • AdminAccount (string) –

          The Amazon Web Services account ID of the Firewall Manager administrator’s account.

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

    • NextToken (string) –

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Exceptions

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.ResourceNotFoundException

  • FMS.Client.exceptions.InternalErrorException

  • FMS.Client.exceptions.LimitExceededException