@aws-sdk/client-securityhub
Advanced tools
AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native
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 AWS 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 AWS 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 AWS Security Hub User Guide .
When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS 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, execute the same command for each Region to apply the change to.
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 master 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.
UpdateFindings
- RateLimit of 1 request per
second. BurstLimit of 5 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.
To install the this package, simply type add or install @aws-sdk/client-securityhub using your favorite package manager:
npm install @aws-sdk/client-securityhubyarn add @aws-sdk/client-securityhubpnpm add @aws-sdk/client-securityhubThe 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 AcceptInvitationCommand:
// ES5 example
const { SecurityHubClient, AcceptInvitationCommand } = require("@aws-sdk/client-securityhub");
// ES6+ example
import { SecurityHubClient, AcceptInvitationCommand } from "@aws-sdk/client-securityhub";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by difference commands.
const client = new SecurityHubClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new AcceptInvitationCommand(params);
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.
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.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// proccess err and data.
});
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 = client.acceptInvitation(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.acceptInvitation(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.acceptInvitation(params, (err, data) => {
// proccess err and data.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.3.0 (2021-01-14)
FAQs
AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-securityhub receives a total of 48,299 weekly downloads. As such, @aws-sdk/client-securityhub popularity was classified as popular.
We found that @aws-sdk/client-securityhub demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.