We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.SecurityLake

Inherits:
AWS.Service show all
Identifier:
securitylake
API Version:
2018-05-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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 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 and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.

Sending a Request Using SecurityLake

var securitylake = new AWS.SecurityLake();
securitylake.createAwsLogSource(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SecurityLake object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var securitylake = new AWS.SecurityLake({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the securitylake service identifier:

AWS.config.apiVersions = {
  securitylake: '2018-05-10',
  // other service API versions
};

var securitylake = new AWS.SecurityLake();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SecurityLake(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SecurityLake object

var securitylake = new AWS.SecurityLake({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SecurityLake.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SecurityLake.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SecurityLake.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createAwsLogSource(params = {}, callback) ⇒ AWS.Request

Adds a natively supported Amazon Web 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.

You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.

Service Reference:

Examples:

Calling the createAwsLogSource operation

var params = {
  sources: [ /* required */
    {
      regions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF, /* required */
      accounts: [
        'STRING_VALUE',
        /* more items */
      ],
      sourceVersion: 'STRING_VALUE'
    },
    /* more items */
  ]
};
securitylake.createAwsLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sources — (Array<map>)

      Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.

      • accounts — (Array<String>)

        Specify the Amazon Web Services account information where you want to enable Security Lake.

      • regionsrequired — (Array<String>)

        Specify the Regions where you want to enable Security Lake.

      • sourceNamerequired — (String)

        The name for a Amazon Web Services source. This must be a Regionally unique value.

        Possible values include:
        • "ROUTE53"
        • "VPC_FLOW"
        • "SH_FINDINGS"
        • "CLOUD_TRAIL_MGMT"
        • "LAMBDA_EXECUTION"
        • "S3_DATA"
        • "EKS_AUDIT"
        • "WAF"
      • sourceVersion — (String)

        The version for a Amazon Web Services source. This must be a Regionally unique value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • failed — (Array<String>)

        Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCustomLogSource(params = {}, callback) ⇒ AWS.Request

Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.

Service Reference:

Examples:

Calling the createCustomLogSource operation

var params = {
  configuration: { /* required */
    crawlerConfiguration: { /* required */
      roleArn: 'STRING_VALUE' /* required */
    },
    providerIdentity: { /* required */
      externalId: 'STRING_VALUE', /* required */
      principal: 'STRING_VALUE' /* required */
    }
  },
  sourceName: 'STRING_VALUE', /* required */
  eventClasses: [
    'STRING_VALUE',
    /* more items */
  ],
  sourceVersion: 'STRING_VALUE'
};
securitylake.createCustomLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • configuration — (map)

      The configuration for the third-party custom source.

      • crawlerConfigurationrequired — (map)

        The configuration for the Glue Crawler for the third-party custom source.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:

          • The managed policy AWSGlueServiceRole

          • A custom policy granting access to your Amazon S3 Data Lake

      • providerIdentityrequired — (map)

        The identity of the log provider for the third-party custom source.

        • externalIdrequired — (String)

          The external ID used to estalish trust relationship with the AWS identity.

        • principalrequired — (String)

          The AWS identity principal.

    • eventClasses — (Array<String>)

      The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:

      • ACCESS_ACTIVITY

      • FILE_ACTIVITY

      • KERNEL_ACTIVITY

      • KERNEL_EXTENSION

      • MEMORY_ACTIVITY

      • MODULE_ACTIVITY

      • PROCESS_ACTIVITY

      • REGISTRY_KEY_ACTIVITY

      • REGISTRY_VALUE_ACTIVITY

      • RESOURCE_ACTIVITY

      • SCHEDULED_JOB_ACTIVITY

      • SECURITY_FINDING

      • ACCOUNT_CHANGE

      • AUTHENTICATION

      • AUTHORIZATION

      • ENTITY_MANAGEMENT_AUDIT

      • DHCP_ACTIVITY

      • NETWORK_ACTIVITY

      • DNS_ACTIVITY

      • FTP_ACTIVITY

      • HTTP_ACTIVITY

      • RDP_ACTIVITY

      • SMB_ACTIVITY

      • SSH_ACTIVITY

      • CONFIG_STATE

      • INVENTORY_INFO

      • EMAIL_ACTIVITY

      • API_ACTIVITY

      • CLOUD_API

    • sourceName — (String)

      Specify the name for a third-party custom source. This must be a Regionally unique value.

    • sourceVersion — (String)

      Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • source — (map)

        The created third-party custom source.

        • attributes — (map)

          The attributes of a third-party custom source.

          • crawlerArn — (String)

            The ARN of the Glue crawler.

          • databaseArn — (String)

            The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

          • tableArn — (String)

            The ARN of the Glue table.

        • provider — (map)

          The details of the log provider for a third-party custom source.

          • location — (String)

            The location of the partition in the Amazon S3 bucket for Security Lake.

          • roleArn — (String)

            The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

        • sourceName — (String)

          The name for a third-party custom source. This must be a Regionally unique value.

        • sourceVersion — (String)

          The version for a third-party custom source. This must be a Regionally unique value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataLake(params = {}, callback) ⇒ AWS.Request

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.

When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables 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 more information, see the Amazon Security Lake User Guide.

Service Reference:

Examples:

Calling the createDataLake operation

var params = {
  configurations: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      encryptionConfiguration: {
        kmsKeyId: 'STRING_VALUE'
      },
      lifecycleConfiguration: {
        expiration: {
          days: 'NUMBER_VALUE'
        },
        transitions: [
          {
            days: 'NUMBER_VALUE',
            storageClass: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      replicationConfiguration: {
        regions: [
          'STRING_VALUE',
          /* more items */
        ],
        roleArn: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  metaStoreManagerRoleArn: 'STRING_VALUE', /* required */
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
securitylake.createDataLake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • configurations — (Array<map>)

      Specify the Region or Regions that will contribute data to the rollup region.

      • encryptionConfiguration — (map)

        Provides encryption details of Amazon Security Lake object.

        • kmsKeyId — (String)

          The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

      • lifecycleConfiguration — (map)

        Provides lifecycle details of Amazon Security Lake object.

        • expiration — (map)

          Provides data expiration details of Amazon Security Lake object.

          • days — (Integer)

            Number of days before data expires in the Amazon Security Lake object.

        • transitions — (Array<map>)

          Provides data storage transition details of Amazon Security Lake object.

          • days — (Integer)

            Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

          • storageClass — (String)

            The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

      • regionrequired — (String)

        The Amazon Web Services Regions where Security Lake is automatically enabled.

      • replicationConfiguration — (map)

        Provides replication details of Amazon Security Lake object.

        • regions — (Array<String>)

          Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

          Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

        • roleArn — (String)

          Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

    • metaStoreManagerRoleArn — (String)

      The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.

    • tags — (Array<map>)

      An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

      • keyrequired — (String)

        The name of the tag. This is a general label that acts as a category for a more specific tag value (value).

      • valuerequired — (String)

        The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataLakes — (Array<map>)

        The created Security Lake configuration object.

        • createStatus — (String)

          Retrieves the status of the configuration operation for an account in Amazon Security Lake.

          Possible values include:
          • "INITIALIZED"
          • "PENDING"
          • "COMPLETED"
          • "FAILED"
        • dataLakeArnrequired — (String)

          The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.

        • encryptionConfiguration — (map)

          Provides encryption details of Amazon Security Lake object.

          • kmsKeyId — (String)

            The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

        • lifecycleConfiguration — (map)

          Provides lifecycle details of Amazon Security Lake object.

          • expiration — (map)

            Provides data expiration details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data expires in the Amazon Security Lake object.

          • transitions — (Array<map>)

            Provides data storage transition details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

            • storageClass — (String)

              The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

        • regionrequired — (String)

          The Amazon Web Services Regions where Security Lake is enabled.

        • replicationConfiguration — (map)

          Provides replication details of Amazon Security Lake object.

          • regions — (Array<String>)

            Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

            Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

          • roleArn — (String)

            Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

        • s3BucketArn — (String)

          The ARN for the Amazon Security Lake Amazon S3 bucket.

        • updateStatus — (map)

          The status of the last UpdateDataLake or DeleteDataLake API request.

          • exception — (map)

            The details of the last UpdateDataLakeor DeleteDataLake API request which failed.

            • code — (String)

              The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.

            • reason — (String)

              The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.

          • requestId — (String)

            The unique ID for the last UpdateDataLake or DeleteDataLake API request.

          • status — (String)

            The status of the last UpdateDataLake or DeleteDataLake API request that was requested.

            Possible values include:
            • "INITIALIZED"
            • "PENDING"
            • "COMPLETED"
            • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataLakeExceptionSubscription(params = {}, callback) ⇒ AWS.Request

Creates the specified notification subscription in Amazon Security Lake for the organization you specify.

Examples:

Calling the createDataLakeExceptionSubscription operation

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: 'STRING_VALUE', /* required */
  exceptionTimeToLive: 'NUMBER_VALUE'
};
securitylake.createDataLakeExceptionSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • exceptionTimeToLive — (Integer)

      The expiration period and time-to-live (TTL).

    • notificationEndpoint — (String)

      The Amazon Web Services account where you want to receive exception notifications.

    • subscriptionProtocol — (String)

      The subscription protocol to which exception notifications are posted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataLakeOrganizationConfiguration(params = {}, callback) ⇒ AWS.Request

Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.

Examples:

Calling the createDataLakeOrganizationConfiguration operation

var params = {
  autoEnableNewAccount: [
    {
      region: 'STRING_VALUE', /* required */
      sources: [ /* required */
        {
          sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF,
          sourceVersion: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.createDataLakeOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • autoEnableNewAccount — (Array<map>)

      Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.

      • regionrequired — (String)

        The Amazon Web Services Regions where Security Lake is automatically enabled.

      • sourcesrequired — (Array<map>)

        The Amazon Web Services sources that are automatically enabled in Security Lake.

        • sourceName — (String)

          The name for a Amazon Web Services source. This must be a Regionally unique value.

          Possible values include:
          • "ROUTE53"
          • "VPC_FLOW"
          • "SH_FINDINGS"
          • "CLOUD_TRAIL_MGMT"
          • "LAMBDA_EXECUTION"
          • "S3_DATA"
          • "EKS_AUDIT"
          • "WAF"
        • sourceVersion — (String)

          The version for a Amazon Web Services source. This must be a Regionally unique value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSubscriber(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createSubscriber operation

var params = {
  sources: [ /* required */
    {
      awsLogSource: {
        sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF,
        sourceVersion: 'STRING_VALUE'
      },
      customLogSource: {
        attributes: {
          crawlerArn: 'STRING_VALUE',
          databaseArn: 'STRING_VALUE',
          tableArn: 'STRING_VALUE'
        },
        provider: {
          location: 'STRING_VALUE',
          roleArn: 'STRING_VALUE'
        },
        sourceName: 'STRING_VALUE',
        sourceVersion: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  subscriberIdentity: { /* required */
    externalId: 'STRING_VALUE', /* required */
    principal: 'STRING_VALUE' /* required */
  },
  subscriberName: 'STRING_VALUE', /* required */
  accessTypes: [
    LAKEFORMATION | S3,
    /* more items */
  ],
  subscriberDescription: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
securitylake.createSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accessTypes — (Array<String>)

      The Amazon S3 or Lake Formation access type.

    • sources — (Array<map>)

      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.

      • awsLogSource — (map)

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

        • sourceName — (String)

          The name for a Amazon Web Services source. This must be a Regionally unique value.

          Possible values include:
          • "ROUTE53"
          • "VPC_FLOW"
          • "SH_FINDINGS"
          • "CLOUD_TRAIL_MGMT"
          • "LAMBDA_EXECUTION"
          • "S3_DATA"
          • "EKS_AUDIT"
          • "WAF"
        • sourceVersion — (String)

          The version for a Amazon Web Services source. This must be a Regionally unique value.

      • customLogSource — (map)

        Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

        • attributes — (map)

          The attributes of a third-party custom source.

          • crawlerArn — (String)

            The ARN of the Glue crawler.

          • databaseArn — (String)

            The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

          • tableArn — (String)

            The ARN of the Glue table.

        • provider — (map)

          The details of the log provider for a third-party custom source.

          • location — (String)

            The location of the partition in the Amazon S3 bucket for Security Lake.

          • roleArn — (String)

            The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

        • sourceName — (String)

          The name for a third-party custom source. This must be a Regionally unique value.

        • sourceVersion — (String)

          The version for a third-party custom source. This must be a Regionally unique value.

    • subscriberDescription — (String)

      The description for your subscriber account in Security Lake.

    • subscriberIdentity — (map)

      The AWS identity used to access your data.

      • externalIdrequired — (String)

        The external ID used to estalish trust relationship with the AWS identity.

      • principalrequired — (String)

        The AWS identity principal.

    • subscriberName — (String)

      The name of your Security Lake subscriber account.

    • tags — (Array<map>)

      An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

      • keyrequired — (String)

        The name of the tag. This is a general label that acts as a category for a more specific tag value (value).

      • valuerequired — (String)

        The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • subscriber — (map)

        Retrieve information about the subscriber created using the CreateSubscriber API.

        • accessTypes — (Array<String>)

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

        • createdAt — (Date)

          The date and time when the subscriber was created.

        • resourceShareArn — (String)

          The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

          This field is available only for Lake Formation subscribers created after March 8, 2023.

        • resourceShareName — (String)

          The name of the resource share.

        • roleArn — (String)

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn — (String)

          The ARN for the Amazon S3 bucket.

        • sourcesrequired — (Array<map>)

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • awsLogSource — (map)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

            • sourceName — (String)

              The name for a Amazon Web Services source. This must be a Regionally unique value.

              Possible values include:
              • "ROUTE53"
              • "VPC_FLOW"
              • "SH_FINDINGS"
              • "CLOUD_TRAIL_MGMT"
              • "LAMBDA_EXECUTION"
              • "S3_DATA"
              • "EKS_AUDIT"
              • "WAF"
            • sourceVersion — (String)

              The version for a Amazon Web Services source. This must be a Regionally unique value.

          • customLogSource — (map)

            Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

            • attributes — (map)

              The attributes of a third-party custom source.

              • crawlerArn — (String)

                The ARN of the Glue crawler.

              • databaseArn — (String)

                The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

              • tableArn — (String)

                The ARN of the Glue table.

            • provider — (map)

              The details of the log provider for a third-party custom source.

              • location — (String)

                The location of the partition in the Amazon S3 bucket for Security Lake.

              • roleArn — (String)

                The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

            • sourceName — (String)

              The name for a third-party custom source. This must be a Regionally unique value.

            • sourceVersion — (String)

              The version for a third-party custom source. This must be a Regionally unique value.

        • subscriberArnrequired — (String)

          The subscriber ARN of the Amazon Security Lake subscriber account.

        • subscriberDescription — (String)

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

        • subscriberEndpoint — (String)

          The subscriber endpoint to which exception messages are posted.

        • subscriberIdrequired — (String)

          The subscriber ID of the Amazon Security Lake subscriber account.

        • subscriberIdentityrequired — (map)

          The AWS identity used to access your data.

          • externalIdrequired — (String)

            The external ID used to estalish trust relationship with the AWS identity.

          • principalrequired — (String)

            The AWS identity principal.

        • subscriberNamerequired — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriberStatus — (String)

          The subscriber status of the Amazon Security Lake subscriber account.

          Possible values include:
          • "ACTIVE"
          • "DEACTIVATED"
          • "PENDING"
          • "READY"
        • updatedAt — (Date)

          The date and time when the subscriber was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSubscriberNotification(params = {}, callback) ⇒ AWS.Request

Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.

Service Reference:

Examples:

Calling the createSubscriberNotification operation

var params = {
  configuration: { /* required */
    httpsNotificationConfiguration: {
      endpoint: 'STRING_VALUE', /* required */
      targetRoleArn: 'STRING_VALUE', /* required */
      authorizationApiKeyName: 'STRING_VALUE',
      authorizationApiKeyValue: 'STRING_VALUE',
      httpMethod: POST | PUT
    },
    sqsNotificationConfiguration: {
    }
  },
  subscriberId: 'STRING_VALUE' /* required */
};
securitylake.createSubscriberNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • configuration — (map)

      Specify the configuration using which you want to create the subscriber notification.

      • httpsNotificationConfiguration — (map)

        The configurations for HTTPS subscriber notification.

        • authorizationApiKeyName — (String)

          The key name for the notification subscription.

        • authorizationApiKeyValue — (String)

          The key value for the notification subscription.

        • endpointrequired — (String)

          The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

        • httpMethod — (String)

          The HTTPS method used for the notification subscription.

          Possible values include:
          • "POST"
          • "PUT"
        • targetRoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.

      • sqsNotificationConfiguration — (map)

        The configurations for SQS subscriber notification.

    • subscriberId — (String)

      The subscriber ID for the notification subscription.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAwsLogSource(params = {}, callback) ⇒ AWS.Request

Removes a natively supported Amazon Web 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 collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal.

You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.

Service Reference:

Examples:

Calling the deleteAwsLogSource operation

var params = {
  sources: [ /* required */
    {
      regions: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF, /* required */
      accounts: [
        'STRING_VALUE',
        /* more items */
      ],
      sourceVersion: 'STRING_VALUE'
    },
    /* more items */
  ]
};
securitylake.deleteAwsLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sources — (Array<map>)

      Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.

      • accounts — (Array<String>)

        Specify the Amazon Web Services account information where you want to enable Security Lake.

      • regionsrequired — (Array<String>)

        Specify the Regions where you want to enable Security Lake.

      • sourceNamerequired — (String)

        The name for a Amazon Web Services source. This must be a Regionally unique value.

        Possible values include:
        • "ROUTE53"
        • "VPC_FLOW"
        • "SH_FINDINGS"
        • "CLOUD_TRAIL_MGMT"
        • "LAMBDA_EXECUTION"
        • "S3_DATA"
        • "EKS_AUDIT"
        • "WAF"
      • sourceVersion — (String)

        The version for a Amazon Web Services source. This must be a Regionally unique value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • failed — (Array<String>)

        Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteCustomLogSource(params = {}, callback) ⇒ AWS.Request

Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.

Service Reference:

Examples:

Calling the deleteCustomLogSource operation

var params = {
  sourceName: 'STRING_VALUE', /* required */
  sourceVersion: 'STRING_VALUE'
};
securitylake.deleteCustomLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceName — (String)

      The source name of custom log source that you want to delete.

    • sourceVersion — (String)

      The source version for the third-party custom source. You can limit the custom source removal to the specified source version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataLake(params = {}, callback) ⇒ AWS.Request

When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region.

The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

Service Reference:

Examples:

Calling the deleteDataLake operation

var params = {
  regions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securitylake.deleteDataLake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • regions — (Array<String>)

      The list of Regions where Security Lake is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataLakeExceptionSubscription(params = {}, callback) ⇒ AWS.Request

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Examples:

Calling the deleteDataLakeExceptionSubscription operation

var params = {
};
securitylake.deleteDataLakeExceptionSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataLakeOrganizationConfiguration(params = {}, callback) ⇒ AWS.Request

Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.

Examples:

Calling the deleteDataLakeOrganizationConfiguration operation

var params = {
  autoEnableNewAccount: [
    {
      region: 'STRING_VALUE', /* required */
      sources: [ /* required */
        {
          sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF,
          sourceVersion: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.deleteDataLakeOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • autoEnableNewAccount — (Array<map>)

      Turns off automatic enablement of Security Lake for member accounts that are added to an organization.

      • regionrequired — (String)

        The Amazon Web Services Regions where Security Lake is automatically enabled.

      • sourcesrequired — (Array<map>)

        The Amazon Web Services sources that are automatically enabled in Security Lake.

        • sourceName — (String)

          The name for a Amazon Web Services source. This must be a Regionally unique value.

          Possible values include:
          • "ROUTE53"
          • "VPC_FLOW"
          • "SH_FINDINGS"
          • "CLOUD_TRAIL_MGMT"
          • "LAMBDA_EXECUTION"
          • "S3_DATA"
          • "EKS_AUDIT"
          • "WAF"
        • sourceVersion — (String)

          The version for a Amazon Web Services source. This must be a Regionally unique value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSubscriber(params = {}, callback) ⇒ AWS.Request

Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.

Service Reference:

Examples:

Calling the deleteSubscriber operation

var params = {
  subscriberId: 'STRING_VALUE' /* required */
};
securitylake.deleteSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • subscriberId — (String)

      A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSubscriberNotification(params = {}, callback) ⇒ AWS.Request

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Service Reference:

Examples:

Calling the deleteSubscriberNotification operation

var params = {
  subscriberId: 'STRING_VALUE' /* required */
};
securitylake.deleteSubscriberNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • subscriberId — (String)

      The ID of the Security Lake subscriber account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterDataLakeDelegatedAdministrator(params = {}, callback) ⇒ AWS.Request

Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

Examples:

Calling the deregisterDataLakeDelegatedAdministrator operation

var params = {
};
securitylake.deregisterDataLakeDelegatedAdministrator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataLakeExceptionSubscription(params = {}, callback) ⇒ AWS.Request

Retrieves the details of exception notifications for the account in Amazon Security Lake.

Examples:

Calling the getDataLakeExceptionSubscription operation

var params = {
};
securitylake.getDataLakeExceptionSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exceptionTimeToLive — (Integer)

        The expiration period and time-to-live (TTL).

      • notificationEndpoint — (String)

        The Amazon Web Services account where you receive exception notifications.

      • subscriptionProtocol — (String)

        The subscription protocol to which exception notifications are posted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataLakeOrganizationConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.

Examples:

Calling the getDataLakeOrganizationConfiguration operation

var params = {
};
securitylake.getDataLakeOrganizationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • autoEnableNewAccount — (Array<map>)

        The configuration for new accounts.

        • regionrequired — (String)

          The Amazon Web Services Regions where Security Lake is automatically enabled.

        • sourcesrequired — (Array<map>)

          The Amazon Web Services sources that are automatically enabled in Security Lake.

          • sourceName — (String)

            The name for a Amazon Web Services source. This must be a Regionally unique value.

            Possible values include:
            • "ROUTE53"
            • "VPC_FLOW"
            • "SH_FINDINGS"
            • "CLOUD_TRAIL_MGMT"
            • "LAMBDA_EXECUTION"
            • "S3_DATA"
            • "EKS_AUDIT"
            • "WAF"
          • sourceVersion — (String)

            The version for a Amazon Web Services source. This must be a Regionally unique value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataLakeSources(params = {}, callback) ⇒ AWS.Request

Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.

Service Reference:

Examples:

Calling the getDataLakeSources operation

var params = {
  accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
securitylake.getDataLakeSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accounts — (Array<String>)

      The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

    • maxResults — (Integer)

      The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.

    • nextToken — (String)

      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. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataLakeArn — (String)

        The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.

      • dataLakeSources — (Array<map>)

        The list of enabled accounts and enabled sources.

        • account — (String)

          The ID of the Security Lake account for which logs are collected.

        • eventClasses — (Array<String>)

          The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:

          • ACCESS_ACTIVITY

          • FILE_ACTIVITY

          • KERNEL_ACTIVITY

          • KERNEL_EXTENSION

          • MEMORY_ACTIVITY

          • MODULE_ACTIVITY

          • PROCESS_ACTIVITY

          • REGISTRY_KEY_ACTIVITY

          • REGISTRY_VALUE_ACTIVITY

          • RESOURCE_ACTIVITY

          • SCHEDULED_JOB_ACTIVITY

          • SECURITY_FINDING

          • ACCOUNT_CHANGE

          • AUTHENTICATION

          • AUTHORIZATION

          • ENTITY_MANAGEMENT_AUDIT

          • DHCP_ACTIVITY

          • NETWORK_ACTIVITY

          • DNS_ACTIVITY

          • FTP_ACTIVITY

          • HTTP_ACTIVITY

          • RDP_ACTIVITY

          • SMB_ACTIVITY

          • SSH_ACTIVITY

          • CONFIG_STATE

          • INVENTORY_INFO

          • EMAIL_ACTIVITY

          • API_ACTIVITY

          • CLOUD_API

        • sourceName — (String)

          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.

        • sourceStatuses — (Array<map>)

          The log status for the Security Lake account.

          • resource — (String)

            Defines path the stored logs are available which has information on your systems, applications, and services.

          • status — (String)

            The health status of services, including error codes and patterns.

            Possible values include:
            • "COLLECTING"
            • "MISCONFIGURED"
            • "NOT_COLLECTING"
      • nextToken — (String)

        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. Keep all other arguments unchanged.

        Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSubscriber(params = {}, callback) ⇒ AWS.Request

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

Service Reference:

Examples:

Calling the getSubscriber operation

var params = {
  subscriberId: 'STRING_VALUE' /* required */
};
securitylake.getSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • subscriberId — (String)

      A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • subscriber — (map)

        The subscriber information for the specified subscriber ID.

        • accessTypes — (Array<String>)

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

        • createdAt — (Date)

          The date and time when the subscriber was created.

        • resourceShareArn — (String)

          The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

          This field is available only for Lake Formation subscribers created after March 8, 2023.

        • resourceShareName — (String)

          The name of the resource share.

        • roleArn — (String)

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn — (String)

          The ARN for the Amazon S3 bucket.

        • sourcesrequired — (Array<map>)

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • awsLogSource — (map)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

            • sourceName — (String)

              The name for a Amazon Web Services source. This must be a Regionally unique value.

              Possible values include:
              • "ROUTE53"
              • "VPC_FLOW"
              • "SH_FINDINGS"
              • "CLOUD_TRAIL_MGMT"
              • "LAMBDA_EXECUTION"
              • "S3_DATA"
              • "EKS_AUDIT"
              • "WAF"
            • sourceVersion — (String)

              The version for a Amazon Web Services source. This must be a Regionally unique value.

          • customLogSource — (map)

            Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

            • attributes — (map)

              The attributes of a third-party custom source.

              • crawlerArn — (String)

                The ARN of the Glue crawler.

              • databaseArn — (String)

                The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

              • tableArn — (String)

                The ARN of the Glue table.

            • provider — (map)

              The details of the log provider for a third-party custom source.

              • location — (String)

                The location of the partition in the Amazon S3 bucket for Security Lake.

              • roleArn — (String)

                The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

            • sourceName — (String)

              The name for a third-party custom source. This must be a Regionally unique value.

            • sourceVersion — (String)

              The version for a third-party custom source. This must be a Regionally unique value.

        • subscriberArnrequired — (String)

          The subscriber ARN of the Amazon Security Lake subscriber account.

        • subscriberDescription — (String)

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

        • subscriberEndpoint — (String)

          The subscriber endpoint to which exception messages are posted.

        • subscriberIdrequired — (String)

          The subscriber ID of the Amazon Security Lake subscriber account.

        • subscriberIdentityrequired — (map)

          The AWS identity used to access your data.

          • externalIdrequired — (String)

            The external ID used to estalish trust relationship with the AWS identity.

          • principalrequired — (String)

            The AWS identity principal.

        • subscriberNamerequired — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriberStatus — (String)

          The subscriber status of the Amazon Security Lake subscriber account.

          Possible values include:
          • "ACTIVE"
          • "DEACTIVATED"
          • "PENDING"
          • "READY"
        • updatedAt — (Date)

          The date and time when the subscriber was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataLakeExceptions(params = {}, callback) ⇒ AWS.Request

Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.

Service Reference:

Examples:

Calling the listDataLakeExceptions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regions: [
    'STRING_VALUE',
    /* more items */
  ]
};
securitylake.listDataLakeExceptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      List the maximum number of failures in Security Lake.

    • nextToken — (String)

      List 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. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    • regions — (Array<String>)

      The Amazon Web Services Regions from which exceptions are retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exceptions — (Array<map>)

        Lists the failures that cannot be retried in the current Region.

        • exception — (String)

          The underlying exception of a Security Lake exception.

        • region — (String)

          The Amazon Web Services Regions where the exception occurred.

        • remediation — (String)

          List of all remediation steps for a Security Lake exception.

        • timestamp — (Date)

          This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.

      • nextToken — (String)

        List 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. Keep all other arguments unchanged.

        Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataLakes(params = {}, callback) ⇒ AWS.Request

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.

Service Reference:

Examples:

Calling the listDataLakes operation

var params = {
  regions: [
    'STRING_VALUE',
    /* more items */
  ]
};
securitylake.listDataLakes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • regions — (Array<String>)

      The list of Regions where Security Lake is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataLakes — (Array<map>)

        Retrieves the Security Lake configuration object.

        • createStatus — (String)

          Retrieves the status of the configuration operation for an account in Amazon Security Lake.

          Possible values include:
          • "INITIALIZED"
          • "PENDING"
          • "COMPLETED"
          • "FAILED"
        • dataLakeArnrequired — (String)

          The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.

        • encryptionConfiguration — (map)

          Provides encryption details of Amazon Security Lake object.

          • kmsKeyId — (String)

            The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

        • lifecycleConfiguration — (map)

          Provides lifecycle details of Amazon Security Lake object.

          • expiration — (map)

            Provides data expiration details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data expires in the Amazon Security Lake object.

          • transitions — (Array<map>)

            Provides data storage transition details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

            • storageClass — (String)

              The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

        • regionrequired — (String)

          The Amazon Web Services Regions where Security Lake is enabled.

        • replicationConfiguration — (map)

          Provides replication details of Amazon Security Lake object.

          • regions — (Array<String>)

            Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

            Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

          • roleArn — (String)

            Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

        • s3BucketArn — (String)

          The ARN for the Amazon Security Lake Amazon S3 bucket.

        • updateStatus — (map)

          The status of the last UpdateDataLake or DeleteDataLake API request.

          • exception — (map)

            The details of the last UpdateDataLakeor DeleteDataLake API request which failed.

            • code — (String)

              The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.

            • reason — (String)

              The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.

          • requestId — (String)

            The unique ID for the last UpdateDataLake or DeleteDataLake API request.

          • status — (String)

            The status of the last UpdateDataLake or DeleteDataLake API request that was requested.

            Possible values include:
            • "INITIALIZED"
            • "PENDING"
            • "COMPLETED"
            • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLogSources(params = {}, callback) ⇒ AWS.Request

Retrieves the log sources in the current Amazon Web Services Region.

Service Reference:

Examples:

Calling the listLogSources operation

var params = {
  accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regions: [
    'STRING_VALUE',
    /* more items */
  ],
  sources: [
    {
      awsLogSource: {
        sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF,
        sourceVersion: 'STRING_VALUE'
      },
      customLogSource: {
        attributes: {
          crawlerArn: 'STRING_VALUE',
          databaseArn: 'STRING_VALUE',
          tableArn: 'STRING_VALUE'
        },
        provider: {
          location: 'STRING_VALUE',
          roleArn: 'STRING_VALUE'
        },
        sourceName: 'STRING_VALUE',
        sourceVersion: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
securitylake.listLogSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accounts — (Array<String>)

      The list of Amazon Web Services accounts for which log sources are displayed.

    • maxResults — (Integer)

      The maximum number of accounts for which the log sources are displayed.

    • nextToken — (String)

      If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

    • regions — (Array<String>)

      The list of Regions for which log sources are displayed.

    • sources — (Array<map>)

      The list of sources for which log sources are displayed.

      • awsLogSource — (map)

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

        • sourceName — (String)

          The name for a Amazon Web Services source. This must be a Regionally unique value.

          Possible values include:
          • "ROUTE53"
          • "VPC_FLOW"
          • "SH_FINDINGS"
          • "CLOUD_TRAIL_MGMT"
          • "LAMBDA_EXECUTION"
          • "S3_DATA"
          • "EKS_AUDIT"
          • "WAF"
        • sourceVersion — (String)

          The version for a Amazon Web Services source. This must be a Regionally unique value.

      • customLogSource — (map)

        Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

        • attributes — (map)

          The attributes of a third-party custom source.

          • crawlerArn — (String)

            The ARN of the Glue crawler.

          • databaseArn — (String)

            The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

          • tableArn — (String)

            The ARN of the Glue table.

        • provider — (map)

          The details of the log provider for a third-party custom source.

          • location — (String)

            The location of the partition in the Amazon S3 bucket for Security Lake.

          • roleArn — (String)

            The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

        • sourceName — (String)

          The name for a third-party custom source. This must be a Regionally unique value.

        • sourceVersion — (String)

          The version for a third-party custom source. This must be a Regionally unique value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

      • sources — (Array<map>)

        The list of log sources in your organization that send data to the data lake.

        • account — (String)

          Specify the account from which you want to collect logs.

        • region — (String)

          Specify the Regions from which you want to collect logs.

        • sources — (Array<map>)

          Specify the sources from which you want to collect logs.

          • awsLogSource — (map)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

            • sourceName — (String)

              The name for a Amazon Web Services source. This must be a Regionally unique value.

              Possible values include:
              • "ROUTE53"
              • "VPC_FLOW"
              • "SH_FINDINGS"
              • "CLOUD_TRAIL_MGMT"
              • "LAMBDA_EXECUTION"
              • "S3_DATA"
              • "EKS_AUDIT"
              • "WAF"
            • sourceVersion — (String)

              The version for a Amazon Web Services source. This must be a Regionally unique value.

          • customLogSource — (map)

            Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

            • attributes — (map)

              The attributes of a third-party custom source.

              • crawlerArn — (String)

                The ARN of the Glue crawler.

              • databaseArn — (String)

                The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

              • tableArn — (String)

                The ARN of the Glue table.

            • provider — (map)

              The details of the log provider for a third-party custom source.

              • location — (String)

                The location of the partition in the Amazon S3 bucket for Security Lake.

              • roleArn — (String)

                The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

            • sourceName — (String)

              The name for a third-party custom source. This must be a Regionally unique value.

            • sourceVersion — (String)

              The version for a third-party custom source. This must be a Regionally unique value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSubscribers(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSubscribers operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
securitylake.listSubscribers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of accounts for which the configuration is displayed.

    • nextToken — (String)

      If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

      • subscribers — (Array<map>)

        The subscribers available for the specified Security Lake account ID.

        • accessTypes — (Array<String>)

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

        • createdAt — (Date)

          The date and time when the subscriber was created.

        • resourceShareArn — (String)

          The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

          This field is available only for Lake Formation subscribers created after March 8, 2023.

        • resourceShareName — (String)

          The name of the resource share.

        • roleArn — (String)

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn — (String)

          The ARN for the Amazon S3 bucket.

        • sourcesrequired — (Array<map>)

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • awsLogSource — (map)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

            • sourceName — (String)

              The name for a Amazon Web Services source. This must be a Regionally unique value.

              Possible values include:
              • "ROUTE53"
              • "VPC_FLOW"
              • "SH_FINDINGS"
              • "CLOUD_TRAIL_MGMT"
              • "LAMBDA_EXECUTION"
              • "S3_DATA"
              • "EKS_AUDIT"
              • "WAF"
            • sourceVersion — (String)

              The version for a Amazon Web Services source. This must be a Regionally unique value.

          • customLogSource — (map)

            Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

            • attributes — (map)

              The attributes of a third-party custom source.

              • crawlerArn — (String)

                The ARN of the Glue crawler.

              • databaseArn — (String)

                The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

              • tableArn — (String)

                The ARN of the Glue table.

            • provider — (map)

              The details of the log provider for a third-party custom source.

              • location — (String)

                The location of the partition in the Amazon S3 bucket for Security Lake.

              • roleArn — (String)

                The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

            • sourceName — (String)

              The name for a third-party custom source. This must be a Regionally unique value.

            • sourceVersion — (String)

              The version for a third-party custom source. This must be a Regionally unique value.

        • subscriberArnrequired — (String)

          The subscriber ARN of the Amazon Security Lake subscriber account.

        • subscriberDescription — (String)

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

        • subscriberEndpoint — (String)

          The subscriber endpoint to which exception messages are posted.

        • subscriberIdrequired — (String)

          The subscriber ID of the Amazon Security Lake subscriber account.

        • subscriberIdentityrequired — (map)

          The AWS identity used to access your data.

          • externalIdrequired — (String)

            The external ID used to estalish trust relationship with the AWS identity.

          • principalrequired — (String)

            The AWS identity principal.

        • subscriberNamerequired — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriberStatus — (String)

          The subscriber status of the Amazon Security Lake subscriber account.

          Possible values include:
          • "ACTIVE"
          • "DEACTIVATED"
          • "PENDING"
          • "READY"
        • updatedAt — (Date)

          The date and time when the subscriber was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
securitylake.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (Array<map>)

        An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.

        • keyrequired — (String)

          The name of the tag. This is a general label that acts as a category for a more specific tag value (value).

        • valuerequired — (String)

          The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerDataLakeDelegatedAdministrator(params = {}, callback) ⇒ AWS.Request

Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

Examples:

Calling the registerDataLakeDelegatedAdministrator operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
securitylake.registerDataLakeDelegatedAdministrator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • accountId — (String)

      The Amazon Web Services account ID of the Security Lake delegated administrator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
securitylake.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.

    • tags — (Array<map>)

      An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

      • keyrequired — (String)

        The name of the tag. This is a general label that acts as a category for a more specific tag value (value).

      • valuerequired — (String)

        The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
securitylake.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.

    • tagKeys — (Array<String>)

      A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataLake(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateDataLake operation

var params = {
  configurations: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      encryptionConfiguration: {
        kmsKeyId: 'STRING_VALUE'
      },
      lifecycleConfiguration: {
        expiration: {
          days: 'NUMBER_VALUE'
        },
        transitions: [
          {
            days: 'NUMBER_VALUE',
            storageClass: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      replicationConfiguration: {
        regions: [
          'STRING_VALUE',
          /* more items */
        ],
        roleArn: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  metaStoreManagerRoleArn: 'STRING_VALUE'
};
securitylake.updateDataLake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • configurations — (Array<map>)

      Specify the Region or Regions that will contribute data to the rollup region.

      • encryptionConfiguration — (map)

        Provides encryption details of Amazon Security Lake object.

        • kmsKeyId — (String)

          The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

      • lifecycleConfiguration — (map)

        Provides lifecycle details of Amazon Security Lake object.

        • expiration — (map)

          Provides data expiration details of Amazon Security Lake object.

          • days — (Integer)

            Number of days before data expires in the Amazon Security Lake object.

        • transitions — (Array<map>)

          Provides data storage transition details of Amazon Security Lake object.

          • days — (Integer)

            Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

          • storageClass — (String)

            The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

      • regionrequired — (String)

        The Amazon Web Services Regions where Security Lake is automatically enabled.

      • replicationConfiguration — (map)

        Provides replication details of Amazon Security Lake object.

        • regions — (Array<String>)

          Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

          Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

        • roleArn — (String)

          Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

    • metaStoreManagerRoleArn — (String)

      The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dataLakes — (Array<map>)

        The created Security Lake configuration object.

        • createStatus — (String)

          Retrieves the status of the configuration operation for an account in Amazon Security Lake.

          Possible values include:
          • "INITIALIZED"
          • "PENDING"
          • "COMPLETED"
          • "FAILED"
        • dataLakeArnrequired — (String)

          The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.

        • encryptionConfiguration — (map)

          Provides encryption details of Amazon Security Lake object.

          • kmsKeyId — (String)

            The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.

        • lifecycleConfiguration — (map)

          Provides lifecycle details of Amazon Security Lake object.

          • expiration — (map)

            Provides data expiration details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data expires in the Amazon Security Lake object.

          • transitions — (Array<map>)

            Provides data storage transition details of Amazon Security Lake object.

            • days — (Integer)

              Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.

            • storageClass — (String)

              The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

        • regionrequired — (String)

          The Amazon Web Services Regions where Security Lake is enabled.

        • replicationConfiguration — (map)

          Provides replication details of Amazon Security Lake object.

          • regions — (Array<String>)

            Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.

            Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.

          • roleArn — (String)

            Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

        • s3BucketArn — (String)

          The ARN for the Amazon Security Lake Amazon S3 bucket.

        • updateStatus — (map)

          The status of the last UpdateDataLake or DeleteDataLake API request.

          • exception — (map)

            The details of the last UpdateDataLakeor DeleteDataLake API request which failed.

            • code — (String)

              The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.

            • reason — (String)

              The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.

          • requestId — (String)

            The unique ID for the last UpdateDataLake or DeleteDataLake API request.

          • status — (String)

            The status of the last UpdateDataLake or DeleteDataLake API request that was requested.

            Possible values include:
            • "INITIALIZED"
            • "PENDING"
            • "COMPLETED"
            • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataLakeExceptionSubscription(params = {}, callback) ⇒ AWS.Request

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

Examples:

Calling the updateDataLakeExceptionSubscription operation

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: 'STRING_VALUE', /* required */
  exceptionTimeToLive: 'NUMBER_VALUE'
};
securitylake.updateDataLakeExceptionSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • exceptionTimeToLive — (Integer)

      The time-to-live (TTL) for the exception message to remain.

    • notificationEndpoint — (String)

      The account that is subscribed to receive exception notifications.

    • subscriptionProtocol — (String)

      The subscription protocol to which exception messages are posted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSubscriber(params = {}, callback) ⇒ AWS.Request

Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.

Service Reference:

Examples:

Calling the updateSubscriber operation

var params = {
  subscriberId: 'STRING_VALUE', /* required */
  sources: [
    {
      awsLogSource: {
        sourceName: ROUTE53 | VPC_FLOW | SH_FINDINGS | CLOUD_TRAIL_MGMT | LAMBDA_EXECUTION | S3_DATA | EKS_AUDIT | WAF,
        sourceVersion: 'STRING_VALUE'
      },
      customLogSource: {
        attributes: {
          crawlerArn: 'STRING_VALUE',
          databaseArn: 'STRING_VALUE',
          tableArn: 'STRING_VALUE'
        },
        provider: {
          location: 'STRING_VALUE',
          roleArn: 'STRING_VALUE'
        },
        sourceName: 'STRING_VALUE',
        sourceVersion: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  subscriberDescription: 'STRING_VALUE',
  subscriberIdentity: {
    externalId: 'STRING_VALUE', /* required */
    principal: 'STRING_VALUE' /* required */
  },
  subscriberName: 'STRING_VALUE'
};
securitylake.updateSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sources — (Array<map>)

      The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

      • awsLogSource — (map)

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

        • sourceName — (String)

          The name for a Amazon Web Services source. This must be a Regionally unique value.

          Possible values include:
          • "ROUTE53"
          • "VPC_FLOW"
          • "SH_FINDINGS"
          • "CLOUD_TRAIL_MGMT"
          • "LAMBDA_EXECUTION"
          • "S3_DATA"
          • "EKS_AUDIT"
          • "WAF"
        • sourceVersion — (String)

          The version for a Amazon Web Services source. This must be a Regionally unique value.

      • customLogSource — (map)

        Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

        • attributes — (map)

          The attributes of a third-party custom source.

          • crawlerArn — (String)

            The ARN of the Glue crawler.

          • databaseArn — (String)

            The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

          • tableArn — (String)

            The ARN of the Glue table.

        • provider — (map)

          The details of the log provider for a third-party custom source.

          • location — (String)

            The location of the partition in the Amazon S3 bucket for Security Lake.

          • roleArn — (String)

            The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

        • sourceName — (String)

          The name for a third-party custom source. This must be a Regionally unique value.

        • sourceVersion — (String)

          The version for a third-party custom source. This must be a Regionally unique value.

    • subscriberDescription — (String)

      The description of the Security Lake account subscriber.

    • subscriberId — (String)

      A value created by Security Lake that uniquely identifies your subscription.

    • subscriberIdentity — (map)

      The AWS identity used to access your data.

      • externalIdrequired — (String)

        The external ID used to estalish trust relationship with the AWS identity.

      • principalrequired — (String)

        The AWS identity principal.

    • subscriberName — (String)

      The name of the Security Lake account subscriber.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • subscriber — (map)

        The updated subscriber information.

        • accessTypes — (Array<String>)

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

        • createdAt — (Date)

          The date and time when the subscriber was created.

        • resourceShareArn — (String)

          The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

          This field is available only for Lake Formation subscribers created after March 8, 2023.

        • resourceShareName — (String)

          The name of the resource share.

        • roleArn — (String)

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn — (String)

          The ARN for the Amazon S3 bucket.

        • sourcesrequired — (Array<map>)

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • awsLogSource — (map)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

            • sourceName — (String)

              The name for a Amazon Web Services source. This must be a Regionally unique value.

              Possible values include:
              • "ROUTE53"
              • "VPC_FLOW"
              • "SH_FINDINGS"
              • "CLOUD_TRAIL_MGMT"
              • "LAMBDA_EXECUTION"
              • "S3_DATA"
              • "EKS_AUDIT"
              • "WAF"
            • sourceVersion — (String)

              The version for a Amazon Web Services source. This must be a Regionally unique value.

          • customLogSource — (map)

            Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.

            • attributes — (map)

              The attributes of a third-party custom source.

              • crawlerArn — (String)

                The ARN of the Glue crawler.

              • databaseArn — (String)

                The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

              • tableArn — (String)

                The ARN of the Glue table.

            • provider — (map)

              The details of the log provider for a third-party custom source.

              • location — (String)

                The location of the partition in the Amazon S3 bucket for Security Lake.

              • roleArn — (String)

                The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

            • sourceName — (String)

              The name for a third-party custom source. This must be a Regionally unique value.

            • sourceVersion — (String)

              The version for a third-party custom source. This must be a Regionally unique value.

        • subscriberArnrequired — (String)

          The subscriber ARN of the Amazon Security Lake subscriber account.

        • subscriberDescription — (String)

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

        • subscriberEndpoint — (String)

          The subscriber endpoint to which exception messages are posted.

        • subscriberIdrequired — (String)

          The subscriber ID of the Amazon Security Lake subscriber account.

        • subscriberIdentityrequired — (map)

          The AWS identity used to access your data.

          • externalIdrequired — (String)

            The external ID used to estalish trust relationship with the AWS identity.

          • principalrequired — (String)

            The AWS identity principal.

        • subscriberNamerequired — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriberStatus — (String)

          The subscriber status of the Amazon Security Lake subscriber account.

          Possible values include:
          • "ACTIVE"
          • "DEACTIVATED"
          • "PENDING"
          • "READY"
        • updatedAt — (Date)

          The date and time when the subscriber was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSubscriberNotification(params = {}, callback) ⇒ AWS.Request

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.

Service Reference:

Examples:

Calling the updateSubscriberNotification operation

var params = {
  configuration: { /* required */
    httpsNotificationConfiguration: {
      endpoint: 'STRING_VALUE', /* required */
      targetRoleArn: 'STRING_VALUE', /* required */
      authorizationApiKeyName: 'STRING_VALUE',
      authorizationApiKeyValue: 'STRING_VALUE',
      httpMethod: POST | PUT
    },
    sqsNotificationConfiguration: {
    }
  },
  subscriberId: 'STRING_VALUE' /* required */
};
securitylake.updateSubscriberNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • configuration — (map)

      The configuration for subscriber notification.

      • httpsNotificationConfiguration — (map)

        The configurations for HTTPS subscriber notification.

        • authorizationApiKeyName — (String)

          The key name for the notification subscription.

        • authorizationApiKeyValue — (String)

          The key value for the notification subscription.

        • endpointrequired — (String)

          The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

        • httpMethod — (String)

          The HTTPS method used for the notification subscription.

          Possible values include:
          • "POST"
          • "PUT"
        • targetRoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.

      • sqsNotificationConfiguration — (map)

        The configurations for SQS subscriber notification.

    • subscriberId — (String)

      The subscription ID for which the subscription notification is specified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.