@aws-sdk/client-securitylake

@aws-sdk/client-securitylake

Description

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

Amazon Security Lake is in preview release. Your use of the Amazon Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms("Betas and Previews").

Amazon Security Lake is a fully-managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your account. Security Lake helps you analyze security data, so you can get a more complete understanding of your security posture across the entire organization and improve the protection of your workloads, applications, and data.

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.

Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services. and third-party services and manages the lifecycle of data with customizable retention and replication settings. Security Lake also converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).

Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.

Installing

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

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

Getting Started

Import

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

// ES5 example
const { SecurityLakeClient, CreateAwsLogSourceCommand } = require("@aws-sdk/client-securitylake");

// ES6+ example
import { SecurityLakeClient, CreateAwsLogSourceCommand } from "@aws-sdk/client-securitylake";

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 SecurityLakeClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new CreateAwsLogSourceCommand(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-securitylake";
const client = new AWS.SecurityLake({ region: "REGION" });

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

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

// callbacks.
client.createAwsLogSource(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.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

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-securitylake 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.

Changelog

3.226.0 (2022-12-07)

Bug Fixes

• codegen: remove unused import (#4260) (d65ca1b)
• types: add missing tslib dependency to types (#4128) (5dab646)

Features

• client-cloudfront: Introducing UpdateDistributionWithStagingConfig that can be used to promote the staging configuration to the production. (ce728a2)
• client-cost-explorer: This release adds the LinkedAccountName field to the GetAnomalies API response under RootCause (cef502f)
• client-eks: Adds support for EKS add-ons configurationValues fields and DescribeAddonConfiguration function (47f65dd)
• clients: update client endpoints as of 2022-12-07 (eea62b4)