Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAdminScope

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

Request Syntax


{
   "AdminAccount": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdminAccount

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[0-9]+$

Required: Yes

Response Syntax


{
   "AdminScope": { 
      "AccountScope": { 
         "Accounts": [ "string" ],
         "AllAccountsEnabled": boolean,
         "ExcludeSpecifiedAccounts": boolean
      },
      "OrganizationalUnitScope": { 
         "AllOrganizationalUnitsEnabled": boolean,
         "ExcludeSpecifiedOrganizationalUnits": boolean,
         "OrganizationalUnits": [ "string" ]
      },
      "PolicyTypeScope": { 
         "AllPolicyTypesEnabled": boolean,
         "PolicyTypes": [ "string" ]
      },
      "RegionScope": { 
         "AllRegionsEnabled": boolean,
         "Regions": [ "string" ]
      }
   },
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AdminScope

Contains details about the administrative scope of the requested account.

Type: AdminScope object

Status

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.

Type: String

Valid Values: ONBOARDING | ONBOARDING_COMPLETE | OFFBOARDING | OFFBOARDING_COMPLETE

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

The operation failed because of a system problem, even though the request was valid. Retry your request.

HTTP Status Code: 400

InvalidInputException

The parameters of the request were invalid.

HTTP Status Code: 400

InvalidOperationException

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for AWS Organizations before you can access it.

HTTP Status Code: 400

LimitExceededException

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400