@aws-sdk/client-securitylake - npm Package Compare versions

Comparing version 3.670.0 to 3.671.0

dist-types/commands/CreateAwsLogSourceCommand.d.ts

@@ -30,7 +30,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables
+ * <p>Adds a natively supported Amazon Web Services service as an Amazon Security Lake source. Enables
  *          source types for member accounts in required Amazon Web Services Regions, based on the
  *          parameters you specify. You can choose any source type in any Region for either accounts
- *          that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it.</p>
- *          <p>You can use this API only to enable natively supported Amazon Web Services as a
+ *          that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Services service as a source, Security Lake starts collecting logs and events from it.</p>
+ *          <p>You can use this API only to enable natively supported Amazon Web Services services as a
  *          source. Use <code>CreateCustomLogSource</code> to enable data collection from a custom
@@ -37,0 +37,0 @@ *          source.</p>

dist-types/commands/CreateDataLakeCommand.d.ts

@@ -39,3 +39,3 @@ import { Command as $Command } from "@smithy/smithy-client";
  *          <p>When you enable Security Lake, it starts ingesting security data after the
- *             <code>CreateAwsLogSource</code> call. This includes ingesting security data from
+ *             <code>CreateAwsLogSource</code> call and after you create subscribers using the <code>CreateSubscriber</code> API. This includes ingesting security data from
  *          sources, storing data, and making data accessible to subscribers. Security Lake also enables
@@ -42,0 +42,0 @@ *          all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For

dist-types/commands/CreateDataLakeExceptionSubscriptionCommand.d.ts

@@ -31,3 +31,3 @@ import { Command as $Command } from "@smithy/smithy-client";
  * <p>Creates the specified notification subscription in Amazon Security Lake for the organization
- *          you specify.</p>
+ *          you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.</p>
  * @example
@@ -34,0 +34,0 @@ * Use a bare-bones client and the command you need to make an API call.

dist-types/commands/CreateSubscriberCommand.d.ts

@@ -30,4 +30,4 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Creates a subscription permission for accounts that are already enabled in
- *          Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.</p>
+ * <p>Creates a subscriber for accounts that are already enabled in Amazon Security Lake. You can
+ *          create a subscriber with access to data in the current Amazon Web Services Region.</p>
  * @example
@@ -34,0 +34,0 @@ * Use a bare-bones client and the command you need to make an API call.

dist-types/commands/DeleteAwsLogSourceCommand.d.ts

@@ -30,3 +30,3 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You
+ * <p>Removes a natively supported Amazon Web Services service as an Amazon Security Lake source. You
  *          can remove a source for one or more Regions. When you remove the source, Security Lake stops
@@ -33,0 +33,0 @@ *          collecting data from that source in the specified Regions and accounts, and subscribers can

dist-types/commands/DeleteSubscriberNotificationCommand.d.ts

@@ -30,3 +30,3 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Deletes the specified notification subscription in Amazon Security Lake for the organization
+ * <p>Deletes the specified subscription notification in Amazon Security Lake for the organization
  *          you specify.</p>
@@ -33,0 +33,0 @@ * @example

dist-types/commands/GetDataLakeExceptionSubscriptionCommand.d.ts

@@ -30,3 +30,3 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Retrieves the details of exception notifications for the account in Amazon Security Lake.</p>
+ * <p>Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.</p>
  * @example
@@ -33,0 +33,0 @@ * Use a bare-bones client and the command you need to make an API call.

dist-types/commands/ListLogSourcesCommand.d.ts

@@ -30,3 +30,3 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Retrieves the log sources in the current Amazon Web Services Region.</p>
+ * <p>Retrieves the log sources.</p>
  * @example
@@ -33,0 +33,0 @@ * Use a bare-bones client and the command you need to make an API call.

dist-types/commands/ListSubscribersCommand.d.ts

@@ -30,3 +30,3 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list
+ * <p>Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list
  *          of subscriptions associated with a specific organization or Amazon Web Services account.</p>
@@ -33,0 +33,0 @@ * @example

dist-types/commands/UpdateDataLakeCommand.d.ts

@@ -30,4 +30,13 @@ import { Command as $Command } from "@smithy/smithy-client";
 /**
- * <p>Specifies where to store your security data and for how long. You can add a rollup
- *          Region to consolidate data from multiple Amazon Web Services Regions.</p>
+ * <p>You can use <code>UpdateDataLake</code> to specify where to store your security data, how it should
+ *          be encrypted at rest and for how long. You can add a <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/manage-regions.html#add-rollup-region">Rollup
+ *             Region</a> to consolidate data from multiple Amazon Web Services Regions, replace
+ *          default encryption (SSE-S3) with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">Customer Manged Key</a>,
+ *          or specify transition and expiration actions through storage <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/lifecycle-management.html">Lifecycle management</a>. The <code>UpdateDataLake</code> API works as an "upsert" operation that performs an insert if the specified item or record does not exist, or an update if it
+ *          already exists. Security Lake securely stores your data at rest using Amazon Web Services encryption solutions. For more details, see <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/data-protection.html">Data protection in Amazon Security Lake</a>.</p>
+ *          <p>For example, omitting the key <code>encryptionConfiguration</code> from a Region that is
+ *          included in an update call that currently uses KMS will leave that Region's KMS key in
+ *          place, but specifying <code>encryptionConfiguration: \{kmsKeyId: 'S3_MANAGED_KEY'\}</code>
+ *          for that same Region will reset the key to <code>S3-managed</code>.</p>
+ *          <p>For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/lifecycle-management.html">Amazon Security Lake User Guide</a>. </p>
  * @example
@@ -34,0 +43,0 @@ * Use a bare-bones client and the command you need to make an API call.

dist-types/index.d.ts

@@ -22,7 +22,7 @@ /**
  *          <p>Security Lake automates the collection of security-related log and event data from
- *          integrated Amazon Web Services and third-party services. It also helps you manage
+ *          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).</p>
- *          <p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
+ *          <p>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.</p>
@@ -29,0 +29,0 @@ *

dist-types/models/models_0.d.ts

@@ -36,3 +36,3 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 /**
- * <p>The AWS identity.</p>
+ * <p>The Amazon Web Services identity.</p>
  * @public
@@ -42,3 +42,3 @@ */
     /**
-     * <p>The AWS identity principal.</p>
+     * <p>The Amazon Web Services identity principal.</p>
      * @public
@@ -48,3 +48,3 @@ */
     /**
-     * <p>The external ID used to estalish trust relationship with the AWS identity.</p>
+     * <p>The external ID used to establish trust relationship with the Amazon Web Services identity.</p>
      * @public
@@ -73,3 +73,4 @@ */
 /**
- * <p>The Security Lake logs source configuration file describes the information needed to generate Security Lake logs. </p>
+ * <p>To add a natively-supported Amazon Web Services service as a log source, use these
+ *          parameters to specify the configuration settings for the log source. </p>
  * @public
@@ -89,3 +90,3 @@ */
     /**
-     * <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
+     * <p>The name for a Amazon Web Services source. </p>
      * @public
@@ -95,3 +96,3 @@ */
     /**
-     * <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
+     * <p>The version for a Amazon Web Services source. </p>
      * @public
@@ -102,3 +103,4 @@ */
 /**
- * <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.</p>
+ * <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services
+ *          services.</p>
  * @public
@@ -170,3 +172,3 @@ */
     /**
-     * <p>Lists all accounts in which enabling a natively supported Amazon Web Service as
+     * <p>Lists all accounts in which enabling a natively supported Amazon Web Services service as
      *          a Security Lake source failed. The failure occurred as these accounts are not part of an
@@ -245,3 +247,3 @@ *          organization.</p>
 /**
- * <p>The configuration for the Glue Crawler for the third-party custom source.</p>
+ * <p>The configuration used for the Glue Crawler for a third-party custom source.</p>
  * @public
@@ -268,3 +270,3 @@ */
 /**
- * <p>The configuration for the third-party custom source.</p>
+ * <p>The configuration used for the third-party custom source.</p>
  * @public
@@ -274,3 +276,3 @@ */
     /**
-     * <p>The configuration for the Glue Crawler for the third-party custom source.</p>
+     * <p>The configuration used for the Glue Crawler for a third-party custom source.</p>
      * @public
@@ -291,3 +293,8 @@ */
      * <p>Specify the name for a third-party custom source. This must be a Regionally unique
-     *          value.</p>
+     *          value. The <code>sourceName</code> you enter here, is used in the
+     *             <code>LogProviderRole</code> name which follows the convention
+     *             <code>AmazonSecurityLake-Provider-\{name of the custom source\}-\{region\}</code>. You must
+     *          use a <code>CustomLogSource</code> name that is shorter than or equal to 20 characters.
+     *          This ensures that the <code>LogProviderRole</code> name is below the 64 character
+     *          limit.</p>
      * @public
@@ -456,3 +463,3 @@ */
     /**
-     * <p>The configuration for the third-party custom source.</p>
+     * <p>The configuration used for the third-party custom source.</p>
      * @public
@@ -535,3 +542,3 @@ */
     /**
-     * <p>The created third-party custom source.</p>
+     * <p>The third-party custom source that was created.</p>
      * @public
@@ -547,3 +554,3 @@ */
     /**
-     * <p>The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake
+     * <p>The identifier of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake
      *          object.</p>
@@ -796,3 +803,3 @@ * @public
     /**
-     * <p>Retrieves the status of the configuration operation for an account in Amazon Security Lake.</p>
+     * <p>Retrieves the status of the <code>CreateDatalake</code> API call for an account in Amazon Security Lake.</p>
      * @public
@@ -833,3 +840,3 @@ */
     /**
-     * <p>The expiration period and time-to-live (TTL).</p>
+     * <p>The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.</p>
      * @public
@@ -879,3 +886,3 @@ */
  * <p>The supported source types from which logs and events are collected in Amazon Security Lake.
- *          For a list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
+ *          For a list of supported Amazon Web Services services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
  * @public
@@ -889,3 +896,3 @@ */
     /**
-     * <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
+     * <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
      * @public
@@ -942,4 +949,4 @@ */
     /**
-     * <p>The supported Amazon Web Services from which logs and events are collected.
-     *          Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
+     * <p>The supported Amazon Web Services services from which logs and events are collected.
+     *          Security Lake supports log and event collection for natively supported Amazon Web Services services.</p>
      * @public
@@ -1009,3 +1016,3 @@ */
     /**
-     * <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html">Amazon Security Lake User Guide</a>.</p>
+     * <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html">Amazon Security Lake User Guide</a>.</p>
      * @public
@@ -1092,3 +1099,3 @@ */
 /**
- * <p>The configurations for HTTPS subscriber notification.</p>
+ * <p>The configurations used for HTTPS subscriber notification.</p>
  * @public
@@ -1127,3 +1134,3 @@ */
 /**
- * <p>The configurations for SQS subscriber notification.</p>
+ * <p>The configurations used for EventBridge subscriber notification.</p>
  * @public
@@ -1154,3 +1161,3 @@ */
     /**
-     * <p>The configurations for HTTPS subscriber notification.</p>
+     * <p>The configurations used for HTTPS subscriber notification.</p>
      * @public
@@ -1286,3 +1293,3 @@ */
     /**
-     * <p>The configuration for new accounts.</p>
+     * <p>The configuration used for new accounts in Security Lake.</p>
      * @public
@@ -1348,4 +1355,4 @@ */
 /**
- * <p>Amazon Security Lake collects logs and events from supported Amazon Web Services and
- *          custom sources. For the list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
+ * <p>Amazon Security Lake collects logs and events from supported Amazon Web Services services and
+ *          custom sources. For the list of supported Amazon Web Services services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
  * @public
@@ -1360,4 +1367,4 @@ */
     /**
-     * <p>The supported Amazon Web Services from which logs and events are collected.
-     *          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
+     * <p>The supported Amazon Web Services services from which logs and events are collected.
+     *          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.</p>
      * @public
@@ -1642,3 +1649,3 @@ */
     /**
-     * <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
+     * <p>Specifies the Region or Regions that will contribute data to the rollup region.</p>
      * @public
@@ -1761,3 +1768,3 @@ */
     /**
-     * <p>The expiration period and time-to-live (TTL).</p>
+     * <p>The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.</p>
      * @public
@@ -1798,3 +1805,3 @@ */
     /**
-     * <p>List the maximum number of failures in Security Lake.</p>
+     * <p>Lists the maximum number of failures in Security Lake.</p>
      * @public
@@ -1804,3 +1811,3 @@ */
     /**
-     * <p>List if there are more results available. The value of nextToken is a unique pagination
+     * <p>Lists if there are more results available. The value of nextToken is a unique pagination
      *          token for each page. Repeat the call using the returned token to retrieve the next page.
@@ -1819,3 +1826,3 @@ *          Keep all other arguments unchanged.</p>
     /**
-     * <p>Lists the failures that cannot be retried in the current Region.</p>
+     * <p>Lists the failures that cannot be retried.</p>
      * @public
@@ -1825,3 +1832,3 @@ */
     /**
-     * <p>List if there are more results available. The value of nextToken is a unique pagination
+     * <p>Lists if there are more results available. The value of nextToken is a unique pagination
      *          token for each page. Repeat the call using the returned token to retrieve the next page.
@@ -1912,3 +1919,3 @@ *          Keep all other arguments unchanged.</p>
     /**
-     * <p>The AWS identity used to access your data.</p>
+     * <p>The Amazon Web Services identity used to access your data.</p>
      * @public
@@ -1928,4 +1935,4 @@ */
     /**
-     * <p>The supported Amazon Web Services from which logs and events are collected. For
-     *          the list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
+     * <p>The supported Amazon Web Services services from which logs and events are collected. For
+     *          the list of supported Amazon Web Services services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
      * @public
@@ -2026,3 +2033,3 @@ */
     /**
-     * <p>The time-to-live (TTL) for the exception message to remain.</p>
+     * <p>The time-to-live (TTL) for the exception message to remain. It is the duration of time until which the exception message remains. </p>
      * @public
@@ -2029,0 +2036,0 @@ */

dist-types/SecurityLake.d.ts

@@ -254,7 +254,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
  *          <p>Security Lake automates the collection of security-related log and event data from
- *          integrated Amazon Web Services and third-party services. It also helps you manage
+ *          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).</p>
- *          <p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
+ *          <p>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.</p>
@@ -261,0 +261,0 @@ * @public

dist-types/SecurityLakeClient.d.ts

@@ -205,7 +205,7 @@ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
  *          <p>Security Lake automates the collection of security-related log and event data from
- *          integrated Amazon Web Services and third-party services. It also helps you manage
+ *          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).</p>
- *          <p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
+ *          <p>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.</p>
@@ -212,0 +212,0 @@ * @public

package.json

 {
   "name": "@aws-sdk/client-securitylake",
   "description": "AWS SDK for JavaScript Securitylake Client for Node.js, Browser and React Native",
-  "version": "3.670.0",
+  "version": "3.671.0",
   "scripts": {
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",

README.md

@@ -29,7 +29,7 @@ <!-- generated file, do not edit directly -->
 <p>Security Lake automates the collection of security-related log and event data from
-integrated Amazon Web Services and third-party services. It also helps you manage
+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).</p>
-<p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
+<p>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.</p>
@@ -36,0 +36,0 @@

No alert changes

Improved metrics

Total package byte prevSize

700458

increased by0.41%

Lines of code

15023

increased by0.11%

No dependency changes