DescribeHub - AWS Security Hub

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, "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.

Type: Boolean

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

There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not 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: