Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeHub

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Request Syntax


GET /accounts?HubArn=HubArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

HubArn

The ARN of the Hub resource to retrieve.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AutoEnableControls": boolean,
   "ControlFindingGenerator": "string",
   "HubArn": "string",
   "SubscribedAt": "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.

AutoEnableControls

Whether to automatically enable new controls when they are added to standards that are enabled.

If set to true, then new controls for enabled standards are enabled automatically. If set to false, then new controls are not enabled.

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 as ENABLED 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 have AutoEnableControls set to true.

Type: Boolean

ControlFindingGenerator

Specifies 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.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 23, 2023.

Type: String

Valid Values: STANDARD_CONTROL | SECURITY_CONTROL

HubArn

The ARN of the Hub resource that was retrieved.

Type: String

Pattern: .*\S.*

SubscribedAt

The date and time when Security Hub was enabled in the account.

Type: String

Pattern: .*\S.*

Errors

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

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