UpdateOrganizationConfiguration
Updates the configuration of your organization in AWS Security Hub. Only the Security Hub administrator account can invoke this operation.
Request Syntax
POST /organization/configuration HTTP/1.1
Content-type: application/json
{
"AutoEnable": boolean
,
"AutoEnableStandards": "string
",
"OrganizationConfiguration": {
"ConfigurationType": "string
",
"Status": "string
",
"StatusMessage": "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AutoEnable
-
Whether to automatically enable Security Hub in new member accounts when they join the organization.
If set to
true
, then Security Hub is automatically enabled in new accounts. If set tofalse
, then Security Hub isn't enabled in new accounts automatically. The default value isfalse
.If the
ConfigurationType
of your organization is set toCENTRAL
, then this field is set tofalse
and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub is enabled and associate the policy with new organization accounts.Type: Boolean
Required: Yes
- AutoEnableStandards
-
Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
The default value of this parameter is equal to
DEFAULT
.If equal to
DEFAULT
, then Security Hub default standards are automatically enabled for new member accounts. If equal toNONE
, then default standards are not automatically enabled for new member accounts.If the
ConfigurationType
of your organization is set toCENTRAL
, then this field is set toNONE
and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.Type: String
Valid Values:
NONE | DEFAULT
Required: No
- OrganizationConfiguration
-
Provides information about the way an organization is configured in AWS Security Hub.
Type: OrganizationConfiguration object
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
- ResourceConflictException
-
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
- 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: