This package has been deprecated

Author message:

The package @aws-sdk/client-securityhub-browser has been renamed to @aws-sdk/client-securityhub. Please install the renamed package.

@aws-sdk/client-securityhub-browser

Description

Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on CIS AWS Foundations compliance checks. 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 invite was sent from.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-securityhub-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(SecurityHubClient) and the commands you need, for example AcceptInvitationCommand:

//JavaScript
const {
  SecurityHubClient
} = require("@aws-sdk/client-securityhub-browser/SecurityHubClient");
const {
  AcceptInvitationCommand
} = require("@aws-sdk/client-securityhub-browser/commands/AcceptInvitationCommand");

//TypeScript
import { SecurityHubClient } from "@aws-sdk/client-securityhub-browser/SecurityHubClient";
import { AcceptInvitationCommand } from "@aws-sdk/client-securityhub-browser/commands/AcceptInvitationCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const securityHub = new SecurityHubClient({ region: "region" });
//clients can be shared by different commands
const params = {};
const acceptInvitationCommand = new AcceptInvitationCommand(params);
securityHub
  .send(acceptInvitationCommand)
  .then(data => {
    // do something
  })
  .catch(error => {
    // error handling
  });

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await securityHub.send(acceptInvitationCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
securityHub.send(acceptInvitationCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-securityhub-browser/SecurityHub";
const securityHub = new AWS.SecurityHub({ region: "region" });
securityHub.acceptInvitation(params, (err, data) => {
  //do something
});

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 securityHub.send(acceptInvitationCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-securityhub-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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