PutAdminAccount
Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Amazon Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Accounts in Your Organization.
Request Syntax
{
"AdminAccount": "string
",
"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
" ]
}
}
}
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 Amazon account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Amazon Organizations, see Managing the Amazon Accounts in Your Organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[0-9]+$
Required: Yes
- AdminScope
-
Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.
Type: AdminScope object
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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 Amazon 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 Amazon 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 Amazon account. For more information, see Firewall Manager Limits in the Amazon WAF Developer Guide.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: