Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-securityhub

@aws-sdk/client-securityhub

Description

AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the Security Hub User Guide .

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, run the same command for each Region in which you want to apply the change.

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the administrator account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.

The following throttling limits apply to using Security Hub API operations.

  • BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 request per second.

  • GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.

  • BatchImportFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

  • BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

  • UpdateStandardsControl - RateLimit of 1 request per second. BurstLimit of 5 requests per second.

  • All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

Installing

To install the this package, simply type add or install @aws-sdk/client-securityhub using your favorite package manager:

  • npm install @aws-sdk/client-securityhub
  • yarn add @aws-sdk/client-securityhub
  • pnpm add @aws-sdk/client-securityhub

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the SecurityHubClient and the commands you need, for example AcceptAdministratorInvitationCommand:

// ES5 example
const { SecurityHubClient, AcceptAdministratorInvitationCommand } = require("@aws-sdk/client-securityhub");
// ES6+ example
import { SecurityHubClient, AcceptAdministratorInvitationCommand } from "@aws-sdk/client-securityhub";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new SecurityHubClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new AcceptAdministratorInvitationCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-securityhub";
const client = new AWS.SecurityHub({ region: "REGION" });

// async/await.
try {
const data = await client.acceptAdministratorInvitation(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.acceptAdministratorInvitation(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.acceptAdministratorInvitation(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-securityhub package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AcceptAdministratorInvitation

Command API Reference / Input / Output

AcceptInvitation

Command API Reference / Input / Output

BatchDeleteAutomationRules

Command API Reference / Input / Output

BatchDisableStandards

Command API Reference / Input / Output

BatchEnableStandards

Command API Reference / Input / Output

BatchGetAutomationRules

Command API Reference / Input / Output

BatchGetSecurityControls

Command API Reference / Input / Output

BatchGetStandardsControlAssociations

Command API Reference / Input / Output

BatchImportFindings

Command API Reference / Input / Output

BatchUpdateAutomationRules

Command API Reference / Input / Output

BatchUpdateFindings

Command API Reference / Input / Output

BatchUpdateStandardsControlAssociations

Command API Reference / Input / Output

CreateActionTarget

Command API Reference / Input / Output

CreateAutomationRule

Command API Reference / Input / Output

CreateFindingAggregator

Command API Reference / Input / Output

CreateInsight

Command API Reference / Input / Output

CreateMembers

Command API Reference / Input / Output

DeclineInvitations

Command API Reference / Input / Output

DeleteActionTarget

Command API Reference / Input / Output

DeleteFindingAggregator

Command API Reference / Input / Output

DeleteInsight

Command API Reference / Input / Output

DeleteInvitations

Command API Reference / Input / Output

DeleteMembers

Command API Reference / Input / Output

DescribeActionTargets

Command API Reference / Input / Output

DescribeHub

Command API Reference / Input / Output

DescribeOrganizationConfiguration

Command API Reference / Input / Output

DescribeProducts

Command API Reference / Input / Output

DescribeStandards

Command API Reference / Input / Output

DescribeStandardsControls

Command API Reference / Input / Output

DisableImportFindingsForProduct

Command API Reference / Input / Output

DisableOrganizationAdminAccount

Command API Reference / Input / Output

DisableSecurityHub

Command API Reference / Input / Output

DisassociateFromAdministratorAccount

Command API Reference / Input / Output

DisassociateFromMasterAccount

Command API Reference / Input / Output

DisassociateMembers

Command API Reference / Input / Output

EnableImportFindingsForProduct

Command API Reference / Input / Output

EnableOrganizationAdminAccount

Command API Reference / Input / Output

EnableSecurityHub

Command API Reference / Input / Output

GetAdministratorAccount

Command API Reference / Input / Output

GetEnabledStandards

Command API Reference / Input / Output

GetFindingAggregator

Command API Reference / Input / Output

GetFindingHistory

Command API Reference / Input / Output

GetFindings

Command API Reference / Input / Output

GetInsightResults

Command API Reference / Input / Output

GetInsights

Command API Reference / Input / Output

GetInvitationsCount

Command API Reference / Input / Output

GetMasterAccount

Command API Reference / Input / Output

GetMembers

Command API Reference / Input / Output

InviteMembers

Command API Reference / Input / Output

ListAutomationRules

Command API Reference / Input / Output

ListEnabledProductsForImport

Command API Reference / Input / Output

ListFindingAggregators

Command API Reference / Input / Output

ListInvitations

Command API Reference / Input / Output

ListMembers

Command API Reference / Input / Output

ListOrganizationAdminAccounts

Command API Reference / Input / Output

ListSecurityControlDefinitions

Command API Reference / Input / Output

ListStandardsControlAssociations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateActionTarget

Command API Reference / Input / Output

UpdateFindingAggregator

Command API Reference / Input / Output

UpdateFindings

Command API Reference / Input / Output

UpdateInsight

Command API Reference / Input / Output

UpdateOrganizationConfiguration

Command API Reference / Input / Output

UpdateSecurityHubConfiguration

Command API Reference / Input / Output

UpdateStandardsControl

Command API Reference / Input / Output