DescribeHubCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SecurityHubClient, DescribeHubCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, DescribeHubCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // DescribeHubRequest
  HubArn: "STRING_VALUE",
};
const command = new DescribeHubCommand(input);
const response = await client.send(command);
// { // DescribeHubResponse
//   HubArn: "STRING_VALUE",
//   SubscribedAt: "STRING_VALUE",
//   AutoEnableControls: true || false,
//   ControlFindingGenerator: "STANDARD_CONTROL" || "SECURITY_CONTROL",
// };

Example Usage

 Loading code editorLoading code editor

DescribeHubCommand Input

See DescribeHubCommandInput for more details

Parameter
Type
Description
HubArn
string | undefined

The ARN of the Hub resource to retrieve.

DescribeHubCommand Output

See DescribeHubCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AutoEnableControls
boolean | undefined

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.

ControlFindingGenerator
ControlFindingGenerator | undefined

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.

HubArn
string | undefined

The ARN of the Hub resource that was retrieved.

SubscribedAt
string | undefined

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

Throws

Name
Fault
Details
InternalException
server

Internal server error.

InvalidAccessException
client

The account doesn't have permission to perform this action.

InvalidInputException
client

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException
client

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException
client

The request was rejected because we can't find the specified resource.

SecurityHubServiceException
Base exception class for all service exceptions from SecurityHub service.