UpdateSecurityHubConfiguration
Updates configuration options for Security Hub.
Request Syntax
PATCH /accounts HTTP/1.1
Content-type: application/json
{
"AutoEnableControls": boolean
,
"ControlFindingGenerator": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AutoEnableControls
-
Whether to automatically enable new controls when they are added to standards that are enabled.
By default, this is set to
true
, and new controls are enabled automatically. To not automatically enable new controls, set this tofalse
.When you automatically enable new controls, you can interact with the controls in the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of
DISABLED
. It can take up to several days for Security Hub to process the control release and designate the control asENABLED
in your account. During the processing period, you can manually enable or disable a control, and Security Hub will maintain that designation regardless of whether you haveAutoEnableControls
set totrue
.Type: Boolean
Required: No
- ControlFindingGenerator
-
Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to
SECURITY_CONTROL
, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.If the value for this field is set to
STANDARD_CONTROL
, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.For accounts that are part of an organization, this value can only be updated in the administrator account.
Type: String
Valid Values:
STANDARD_CONTROL | SECURITY_CONTROL
Required: No
Response Syntax
HTTP/1.1 200
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.
- AccessDeniedException
-
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- LimitExceededException
-
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: