You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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

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

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Servicesaccount. 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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.

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 = {
  inputOrder: [ /* required */
    REGION | SOURCE_TYPE | MEMBER,
    /* more items */
  ],
  enableAllDimensions: {
    '<String>': {
      '<String>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<String>': ... */
    },
    /* '<String>': ... */
  },
  enableSingleDimension: [
    'STRING_VALUE',
    /* more items */
  ],
  enableTwoDimensions: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  }
};
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: {})
    • enableAllDimensions — (map<map<Array<String>>>)

      Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.

    • enableSingleDimension — (Array<String>)

      Enables data collection from all Amazon Web Services sources in specific accounts or Regions.

    • enableTwoDimensions — (map<Array<String>>)

      Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.

    • inputOrder — (Array<String>)

      Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member 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. 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.

      • processing — (Array<String>)

        Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.

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 to an associated Glue table and an Glue crawler.

Service Reference:

Examples:

Calling the createCustomLogSource operation

var params = {
  customSourceName: 'STRING_VALUE', /* required */
  eventClass: 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 | CLOUD_API | CONTAINER_LIFECYCLE | DATABASE_LIFECYCLE | CONFIG_STATE | CLOUD_STORAGE | INVENTORY_INFO | RFB_ACTIVITY | SMTP_ACTIVITY | VIRTUAL_MACHINE_ACTIVITY, /* required */
  glueInvocationRoleArn: 'STRING_VALUE', /* required */
  logProviderAccountId: 'STRING_VALUE' /* required */
};
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: {})
    • customSourceName — (String)

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

    • eventClass — (String)

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

      Possible values include:
      • "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"
      • "CLOUD_API"
      • "CONTAINER_LIFECYCLE"
      • "DATABASE_LIFECYCLE"
      • "CONFIG_STATE"
      • "CLOUD_STORAGE"
      • "INVENTORY_INFO"
      • "RFB_ACTIVITY"
      • "SMTP_ACTIVITY"
      • "VIRTUAL_MACHINE_ACTIVITY"
    • glueInvocationRoleArn — (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

    • logProviderAccountId — (String)

      The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

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:

      • customDataLocation — (String)

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

      • glueCrawlerName — (String)

        The name of the Glue crawler.

      • glueDatabaseName — (String)

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

      • glueTableName — (String)

        The table name of the Glue crawler.

      • logProviderAccessRoleArn — (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.

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. You can either use the enableAll parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions parameter and then 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: {
    '<Region>': {
      encryptionKey: 'STRING_VALUE',
      replicationDestinationRegions: [
        us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
        /* more items */
      ],
      replicationRoleArn: 'STRING_VALUE',
      retentionSettings: [
        {
          retentionPeriod: 'NUMBER_VALUE',
          storageClass: STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER_IR | GLACIER | DEEP_ARCHIVE | EXPIRE
        },
        /* more items */
      ],
      tagsMap: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      }
    },
    /* '<Region>': ... */
  },
  enableAll: true || false,
  metaStoreManagerRoleArn: 'STRING_VALUE',
  regions: [
    us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
    /* 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 — (map<map>)

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

      • encryptionKey — (String)

        The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.

      • replicationDestinationRegions — (Array<String>)

        Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.

        Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

      • replicationRoleArn — (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.

      • retentionSettings — (Array<map>)

        Retention settings for the destination Amazon S3 buckets.

        • retentionPeriod — (Integer)

          The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

        • storageClass — (String)

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

          Possible values include:
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "GLACIER_IR"
          • "GLACIER"
          • "DEEP_ARCHIVE"
          • "EXPIRE"
      • tagsMap — (map<String>)

        A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

    • enableAll — (Boolean)

      Enable Security Lake in all Regions.

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

    • regions — (Array<String>)

      Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.

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.

createDatalakeAutoEnable(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.

Service Reference:

Examples:

Calling the createDatalakeAutoEnable operation

var params = {
  configurationForNewAccounts: [ /* required */
    {
      region: us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2, /* required */
      sources: [ /* required */
        ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.createDatalakeAutoEnable(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: {})
    • configurationForNewAccounts — (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.

        Possible values include:
        • "us-east-1"
        • "us-west-2"
        • "eu-central-1"
        • "us-east-2"
        • "eu-west-1"
        • "ap-northeast-1"
        • "ap-southeast-2"
      • sourcesrequired — (Array<String>)

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

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.

createDatalakeDelegatedAdmin(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.

Service Reference:

Examples:

Calling the createDatalakeDelegatedAdmin operation

var params = {
  account: 'STRING_VALUE' /* required */
};
securitylake.createDatalakeDelegatedAdmin(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: {})
    • account — (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.

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

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

Examples:

Calling the createDatalakeExceptionsSubscription operation

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: HTTP | HTTPS | EMAIL | EMAIL_JSON | SMS | SQS | LAMBDA | APP | FIREHOSE /* required */
};
securitylake.createDatalakeExceptionsSubscription(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: {})
    • 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.

      Possible values include:
      • "HTTP"
      • "HTTPS"
      • "EMAIL"
      • "EMAIL_JSON"
      • "SMS"
      • "SQS"
      • "LAMBDA"
      • "APP"
      • "FIREHOSE"

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 = {
  accountId: 'STRING_VALUE', /* required */
  externalId: 'STRING_VALUE', /* required */
  sourceTypes: [ /* required */
    {
      awsSourceType: ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
      customSourceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  subscriberName: 'STRING_VALUE', /* required */
  accessTypes: [
    LAKEFORMATION | S3,
    /* more items */
  ],
  subscriberDescription: 'STRING_VALUE'
};
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.

    • accountId — (String)

      The Amazon Web Services account ID used to access your data.

    • externalId — (String)

      The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

    • sourceTypes — (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.

      • awsSourceType — (String)

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

        Possible values include:
        • "ROUTE53"
        • "VPC_FLOW"
        • "CLOUD_TRAIL"
        • "SH_FINDINGS"
      • customSourceType — (String)

        Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

    • subscriberDescription — (String)

      The description for your subscriber account in Security Lake.

    • subscriberName — (String)

      The name of your 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. The data object has the following properties:

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

      • resourceShareName — (String)

        The name of the resource share.

      • roleArn — (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 Amazon Security Lake User Guide.

      • s3BucketArn — (String)

        The ARN for the Amazon S3 bucket.

      • snsArn — (String)

        The ARN for the Amazon Simple Notification Service.

      • subscriptionId — (String)

        The subscriptionId created by the CreateSubscriber API call.

Returns:

  • (AWS.Request)

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

createSubscriptionNotificationConfiguration(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.

Examples:

Calling the createSubscriptionNotificationConfiguration operation

var params = {
  subscriptionId: 'STRING_VALUE', /* required */
  createSqs: true || false,
  httpsApiKeyName: 'STRING_VALUE',
  httpsApiKeyValue: 'STRING_VALUE',
  httpsMethod: POST | PUT,
  roleArn: 'STRING_VALUE',
  subscriptionEndpoint: 'STRING_VALUE'
};
securitylake.createSubscriptionNotificationConfiguration(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: {})
    • createSqs — (Boolean)

      Create an Amazon Simple Queue Service queue.

    • httpsApiKeyName — (String)

      The key name for the notification subscription.

    • httpsApiKeyValue — (String)

      The key value for the notification subscription.

    • httpsMethod — (String)

      The HTTPS method used for the notification subscription.

      Possible values include:
      • "POST"
      • "PUT"
    • roleArn — (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.

    • subscriptionEndpoint — (String)

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

    • subscriptionId — (String)

      The subscription 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:

      • queueArn — (String)

        Returns the Amazon Resource Name (ARN) of the queue.

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. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.

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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.

When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.

Service Reference:

Examples:

Calling the deleteAwsLogSource operation

var params = {
  inputOrder: [ /* required */
    REGION | SOURCE_TYPE | MEMBER,
    /* more items */
  ],
  disableAllDimensions: {
    '<String>': {
      '<String>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<String>': ... */
    },
    /* '<String>': ... */
  },
  disableSingleDimension: [
    'STRING_VALUE',
    /* more items */
  ],
  disableTwoDimensions: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  }
};
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: {})
    • disableAllDimensions — (map<map<Array<String>>>)

      Removes the specific Amazon Web Services sources from specific accounts and specific Regions.

    • disableSingleDimension — (Array<String>)

      Removes all Amazon Web Services sources from specific accounts or Regions.

    • disableTwoDimensions — (map<Array<String>>)

      Remove a specific Amazon Web Services source from specific accounts or Regions.

    • inputOrder — (Array<String>)

      This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services 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. 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.

      • processing — (Array<String>)

        Deletion of the Amazon Web Services sources is in progress.

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.

Service Reference:

Examples:

Calling the deleteCustomLogSource operation

var params = {
  customSourceName: 'STRING_VALUE' /* required */
};
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: {})
    • customSourceName — (String)

      The custom source name for the custom log 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:

      • customDataLocation — (String)

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

Returns:

  • (AWS.Request)

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

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

When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .

This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes 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. The DeleteDatalake operation does not delete the 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 = {
};
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: {})

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.

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

DeleteDatalakeAutoEnable removes automatic enablement of configuration settings for new member accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. You must run this API using credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.

Service Reference:

Examples:

Calling the deleteDatalakeAutoEnable operation

var params = {
  removeFromConfigurationForNewAccounts: [ /* required */
    {
      region: us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2, /* required */
      sources: [ /* required */
        ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.deleteDatalakeAutoEnable(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: {})
    • removeFromConfigurationForNewAccounts — (Array<map>)

      Remove automatic enablement of configuration settings for new member accounts in Security Lake.

      • regionrequired — (String)

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

        Possible values include:
        • "us-east-1"
        • "us-west-2"
        • "eu-central-1"
        • "us-east-2"
        • "eu-west-1"
        • "ap-northeast-1"
        • "ap-southeast-2"
      • sourcesrequired — (Array<String>)

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

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.

deleteDatalakeDelegatedAdmin(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.

Service Reference:

Examples:

Calling the deleteDatalakeDelegatedAdmin operation

var params = {
  account: 'STRING_VALUE' /* required */
};
securitylake.deleteDatalakeDelegatedAdmin(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: {})
    • account — (String)

      The account ID 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.

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

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

Examples:

Calling the deleteDatalakeExceptionsSubscription operation

var params = {
};
securitylake.deleteDatalakeExceptionsSubscription(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:

      • status — (String)

        Retrieves the status of the delete Security Lake operation for an account.

Returns:

  • (AWS.Request)

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

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

Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.

Service Reference:

Examples:

Calling the deleteSubscriber operation

var params = {
  id: '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: {})
    • id — (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.

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

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

Examples:

Calling the deleteSubscriptionNotificationConfiguration operation

var params = {
  subscriptionId: 'STRING_VALUE' /* required */
};
securitylake.deleteSubscriptionNotificationConfiguration(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: {})
    • subscriptionId — (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.

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

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake API to know whether Security Lake is enabled for the current Region. This API does not take input parameters.

Service Reference:

Examples:

Calling the getDatalake operation

var params = {
};
securitylake.getDatalake(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:

      • configurations — (map<map>)

        Retrieves the Security Lake configuration object.

        • encryptionKey — (String)

          The type of encryption key used by secure the Security Lake configuration object.

        • replicationDestinationRegions — (Array<String>)

          Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.

          Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

        • replicationRoleArn — (String)

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

        • retentionSettings — (Array<map>)

          Retention settings for the destination Amazon S3 buckets.

          • retentionPeriod — (Integer)

            The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

          • storageClass — (String)

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

            Possible values include:
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "GLACIER_IR"
            • "GLACIER"
            • "DEEP_ARCHIVE"
            • "EXPIRE"
        • s3BucketArn — (String)

          Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.

        • status — (String)

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

          Possible values include:
          • "INITIALIZED"
          • "PENDING"
          • "COMPLETED"
          • "FAILED"
        • tagsMap — (map<String>)

          A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

        • updateStatus — (map)

          The status of the last UpdateDatalake or DeleteDatalake API request.

          • lastUpdateFailure — (map)

            The details of the last UpdateDatalakeor DeleteDatalake API request which failed.

            • code — (String)

              The reason code for the failure of the last UpdateDatalake or DeleteDatalake API request.

            • reason — (String)

              The reason for the failure of the last UpdateDatalakeor DeleteDatalake API request.

          • lastUpdateRequestId — (String)

            The unique ID for the UpdateDatalake or DeleteDatalake API request.

          • lastUpdateStatus — (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.

getDatalakeAutoEnable(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.

Service Reference:

Examples:

Calling the getDatalakeAutoEnable operation

var params = {
};
securitylake.getDatalakeAutoEnable(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:

      • autoEnableNewAccounts — (Array<map>)

        The configuration for new accounts.

        • regionrequired — (String)

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

          Possible values include:
          • "us-east-1"
          • "us-west-2"
          • "eu-central-1"
          • "us-east-2"
          • "eu-west-1"
          • "ap-northeast-1"
          • "ap-southeast-2"
        • sourcesrequired — (Array<String>)

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

Returns:

  • (AWS.Request)

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

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

Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.

Service Reference:

Examples:

Calling the getDatalakeExceptionsExpiry operation

var params = {
};
securitylake.getDatalakeExceptionsExpiry(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:

      • exceptionMessageExpiry — (Integer)

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

Returns:

  • (AWS.Request)

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

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

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

Examples:

Calling the getDatalakeExceptionsSubscription operation

var params = {
};
securitylake.getDatalakeExceptionsSubscription(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:

      • protocolAndNotificationEndpoint — (map)

        Retrieves the exception notification subscription information.

        • endpoint — (String)

          The account that is subscribed to receive exception notifications.

        • protocol — (String)

          The protocol to which notification messages are posted.

Returns:

  • (AWS.Request)

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

getDatalakeStatus(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 getDatalakeStatus operation

var params = {
  accountSet: [
    'STRING_VALUE',
    /* more items */
  ],
  maxAccountResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
securitylake.getDatalakeStatus(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: {})
    • accountSet — (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.

    • maxAccountResults — (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:

      • accountSourcesList — (Array<map>)

        The list of enabled accounts and enabled sources.

        • accountrequired — (String)

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

        • eventClass — (String)

          Initializes a new instance of the Event class.

          Possible values include:
          • "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"
          • "CLOUD_API"
          • "CONTAINER_LIFECYCLE"
          • "DATABASE_LIFECYCLE"
          • "CONFIG_STATE"
          • "CLOUD_STORAGE"
          • "INVENTORY_INFO"
          • "RFB_ACTIVITY"
          • "SMTP_ACTIVITY"
          • "VIRTUAL_MACHINE_ACTIVITY"
        • logsStatus — (Array<map>)

          The log status for the Security Lake account.

          • healthStatusrequired — (String)

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

            Possible values include:
            • "ACTIVE"
            • "DEACTIVATED"
            • "PENDING"
          • pathToLogsrequired — (String)

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

        • sourceTyperequired — (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.

      • 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 = {
  id: '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: {})
    • id — (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 subscription information for the specified subscription 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.

        • accountIdrequired — (String)

          The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

        • createdAt — (Date)

          The date and time when the subscription was created.

        • externalId — (String)

          The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

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

        • snsArn — (String)

          The ARN for the Amazon Simple Notification Service.

        • sourceTypesrequired — (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.

          • awsSourceType — (String)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

            Possible values include:
            • "ROUTE53"
            • "VPC_FLOW"
            • "CLOUD_TRAIL"
            • "SH_FINDINGS"
          • customSourceType — (String)

            Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

        • subscriberDescription — (String)

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

        • subscriberName — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriptionEndpoint — (String)

          The subscription endpoint to which exception messages are posted.

        • subscriptionIdrequired — (String)

          The subscription ID of the Amazon Security Lake subscriber account.

        • subscriptionProtocol — (String)

          The subscription protocol to which exception messages are posted.

          Possible values include:
          • "HTTPS"
          • "SQS"
        • subscriptionStatus — (String)

          The subscription status of the Amazon Security Lake subscriber account.

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

          The date and time when the subscription was created.

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 = {
  maxFailures: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regionSet: [
    us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
    /* 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: {})
    • maxFailures — (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.

    • regionSet — (Array<String>)

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

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

      • nonRetryableFailures — (Array<map>)

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

        • failures — (Array<map>)

          List of all failures.

          • exceptionMessagerequired — (String)

            List of all exception messages.

          • remediationrequired — (String)

            List of all remediation steps for failures.

          • timestamprequired — (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.

        • region — (String)

          List of Amazon Web Services Regions where the failure occurred.

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 = {
  inputOrder: [
    REGION | SOURCE_TYPE | MEMBER,
    /* more items */
  ],
  listAllDimensions: {
    '<String>': {
      '<String>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<String>': ... */
    },
    /* '<String>': ... */
  },
  listSingleDimension: [
    'STRING_VALUE',
    /* more items */
  ],
  listTwoDimensions: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
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: {})
    • inputOrder — (Array<String>)

      Lists the log sources in input order, namely Region, source type, and member account.

    • listAllDimensions — (map<map<Array<String>>>)

      List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.

    • listSingleDimension — (Array<String>)

      List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.

    • listTwoDimensions — (map<Array<String>>)

      Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.

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

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.

      • regionSourceTypesAccountsList — (Array<map<map<Array<String>>>>)

        Lists the log sources by Regions for enabled Security Lake accounts.

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.

        • accountIdrequired — (String)

          The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

        • createdAt — (Date)

          The date and time when the subscription was created.

        • externalId — (String)

          The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

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

        • snsArn — (String)

          The ARN for the Amazon Simple Notification Service.

        • sourceTypesrequired — (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.

          • awsSourceType — (String)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

            Possible values include:
            • "ROUTE53"
            • "VPC_FLOW"
            • "CLOUD_TRAIL"
            • "SH_FINDINGS"
          • customSourceType — (String)

            Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

        • subscriberDescription — (String)

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

        • subscriberName — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriptionEndpoint — (String)

          The subscription endpoint to which exception messages are posted.

        • subscriptionIdrequired — (String)

          The subscription ID of the Amazon Security Lake subscriber account.

        • subscriptionProtocol — (String)

          The subscription protocol to which exception messages are posted.

          Possible values include:
          • "HTTPS"
          • "SQS"
        • subscriptionStatus — (String)

          The subscription status of the Amazon Security Lake subscriber account.

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

          The date and time when the subscription was created.

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>': {
      encryptionKey: 'STRING_VALUE',
      replicationDestinationRegions: [
        us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
        /* more items */
      ],
      replicationRoleArn: 'STRING_VALUE',
      retentionSettings: [
        {
          retentionPeriod: 'NUMBER_VALUE',
          storageClass: STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER_IR | GLACIER | DEEP_ARCHIVE | EXPIRE
        },
        /* more items */
      ],
      tagsMap: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      }
    },
    /* '<Region>': ... */
  }
};
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 — (map<map>)

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

      • encryptionKey — (String)

        The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.

      • replicationDestinationRegions — (Array<String>)

        Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.

        Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

      • replicationRoleArn — (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.

      • retentionSettings — (Array<map>)

        Retention settings for the destination Amazon S3 buckets.

        • retentionPeriod — (Integer)

          The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

        • storageClass — (String)

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

          Possible values include:
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "INTELLIGENT_TIERING"
          • "GLACIER_IR"
          • "GLACIER"
          • "DEEP_ARCHIVE"
          • "EXPIRE"
      • tagsMap — (map<String>)

        A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

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.

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

Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.

Service Reference:

Examples:

Calling the updateDatalakeExceptionsExpiry operation

var params = {
  exceptionMessageExpiry: 'NUMBER_VALUE' /* required */
};
securitylake.updateDatalakeExceptionsExpiry(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: {})
    • exceptionMessageExpiry — (Integer)

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

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.

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

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

Examples:

Calling the updateDatalakeExceptionsSubscription operation

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: HTTP | HTTPS | EMAIL | EMAIL_JSON | SMS | SQS | LAMBDA | APP | FIREHOSE /* required */
};
securitylake.updateDatalakeExceptionsSubscription(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: {})
    • notificationEndpoint — (String)

      The account that is subscribed to receive exception notifications.

    • subscriptionProtocol — (String)

      The subscription protocol to which exception messages are posted.

      Possible values include:
      • "HTTP"
      • "HTTPS"
      • "EMAIL"
      • "EMAIL_JSON"
      • "SMS"
      • "SQS"
      • "LAMBDA"
      • "APP"
      • "FIREHOSE"

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 = {
  id: 'STRING_VALUE', /* required */
  sourceTypes: [ /* required */
    {
      awsSourceType: ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
      customSourceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  externalId: 'STRING_VALUE',
  subscriberDescription: 'STRING_VALUE',
  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: {})
    • externalId — (String)

      The external ID of the Security Lake account.

    • id — (String)

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

    • sourceTypes — (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.

      • awsSourceType — (String)

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

        Possible values include:
        • "ROUTE53"
        • "VPC_FLOW"
        • "CLOUD_TRAIL"
        • "SH_FINDINGS"
      • customSourceType — (String)

        Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

    • subscriberDescription — (String)

      The description of the Security Lake account subscriber.

    • 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 account of the subscriber.

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

        • accountIdrequired — (String)

          The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

        • createdAt — (Date)

          The date and time when the subscription was created.

        • externalId — (String)

          The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

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

        • snsArn — (String)

          The ARN for the Amazon Simple Notification Service.

        • sourceTypesrequired — (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.

          • awsSourceType — (String)

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

            Possible values include:
            • "ROUTE53"
            • "VPC_FLOW"
            • "CLOUD_TRAIL"
            • "SH_FINDINGS"
          • customSourceType — (String)

            Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

        • subscriberDescription — (String)

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

        • subscriberName — (String)

          The name of your Amazon Security Lake subscriber account.

        • subscriptionEndpoint — (String)

          The subscription endpoint to which exception messages are posted.

        • subscriptionIdrequired — (String)

          The subscription ID of the Amazon Security Lake subscriber account.

        • subscriptionProtocol — (String)

          The subscription protocol to which exception messages are posted.

          Possible values include:
          • "HTTPS"
          • "SQS"
        • subscriptionStatus — (String)

          The subscription status of the Amazon Security Lake subscriber account.

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

          The date and time when the subscription was created.

Returns:

  • (AWS.Request)

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

updateSubscriptionNotificationConfiguration(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.

Examples:

Calling the updateSubscriptionNotificationConfiguration operation

var params = {
  subscriptionId: 'STRING_VALUE', /* required */
  createSqs: true || false,
  httpsApiKeyName: 'STRING_VALUE',
  httpsApiKeyValue: 'STRING_VALUE',
  httpsMethod: POST | PUT,
  roleArn: 'STRING_VALUE',
  subscriptionEndpoint: 'STRING_VALUE'
};
securitylake.updateSubscriptionNotificationConfiguration(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: {})
    • createSqs — (Boolean)

      Create a new subscription notification for the specified subscription ID in Amazon Security Lake.

    • httpsApiKeyName — (String)

      The key name for the subscription notification.

    • httpsApiKeyValue — (String)

      The key value for the subscription notification.

    • httpsMethod — (String)

      The HTTPS method used for the subscription notification.

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

      The Amazon Resource Name (ARN) specifying the role of the subscriber. For more information about ARNs and how to use them in policies, see, see the Managing data access and Amazon Web Services Managed Policiesin the Amazon Security Lake User Guide.

    • subscriptionEndpoint — (String)

      The subscription endpoint in Security Lake.

    • subscriptionId — (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:

      • queueArn — (String)

        Returns the ARN of the queue.

Returns:

  • (AWS.Request)

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