@aws-sdk/client-securitylake

Description

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

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 Amazon Web Services account. Amazon Web Services Organizations
is an account management service that lets you consolidate multiple Amazon Web Services
accounts into an organization that you create and centrally manage. With Organizations, you
can create member accounts and invite existing accounts to join your organization.
Security Lake helps you analyze security data for a more complete understanding of your
security posture across the entire organization. It can also help you 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.

Amazon Security Lake integrates with CloudTrail, a service that provides a record of
actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls
from the Security Lake console and code calls to the Security Lake API operations. If you create a
trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still
view the most recent events in the CloudTrail console in Event history. Using the
information collected by CloudTrail you can determine the request that was made to
Security Lake, the IP address from which the request was made, who made the request, when it
was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

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

Other Amazon Web Services 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 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

$3

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 ListDataLakesCommand:

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

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

$3

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.

`js
// a client can be shared by different commands.
const client = new SecurityLakeClient({ region: "REGION" });

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

#### Async/await

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

`js
// 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.

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

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

`js
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.

`js
// 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

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

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

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

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

$3

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

`js
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.

Client Commands (Operations List)

CreateAwsLogSource

Command API Reference / Input / Output

CreateCustomLogSource

Command API Reference / Input / Output

CreateDataLake

Command API Reference / Input / Output

CreateDataLakeExceptionSubscription

Command API Reference / Input / Output

CreateDataLakeOrganizationConfiguration

Command API Reference / Input / Output

CreateSubscriber

Command API Reference / Input / Output

CreateSubscriberNotification

Command API Reference / Input / Output

DeleteAwsLogSource

Command API Reference / Input / Output

DeleteCustomLogSource

Command API Reference / Input / Output

DeleteDataLake

Command API Reference / Input / Output

DeleteDataLakeExceptionSubscription

Command API Reference / Input / Output

DeleteDataLakeOrganizationConfiguration

Command API Reference / Input / Output

DeleteSubscriber

Command API Reference / Input / Output

DeleteSubscriberNotification

Command API Reference / Input / Output

DeregisterDataLakeDelegatedAdministrator

Command API Reference / Input / Output

GetDataLakeExceptionSubscription

Command API Reference / Input / Output

GetDataLakeOrganizationConfiguration

Command API Reference / Input / Output

GetDataLakeSources

Command API Reference / Input / Output

GetSubscriber

Command API Reference / Input / Output

ListDataLakeExceptions

Command API Reference / Input / Output

ListDataLakes

Command API Reference / Input / Output

ListLogSources

Command API Reference / Input / Output

ListSubscribers

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RegisterDataLakeDelegatedAdministrator

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateDataLake

Command API Reference / Input / Output

UpdateDataLakeExceptionSubscription

Command API Reference / Input / Output

UpdateSubscriber

Command API Reference / Input / Output

UpdateSubscriberNotification

Command API Reference / Input / Output