Class: AWS.SecurityLake

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

Parameters:

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

    The configuration for the third-party custom source.

    • crawlerConfiguration — required — (map)

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

      • roleArn — required — (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

    • providerIdentity — required — (map)

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

      • externalId — required — (String)

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

      • principal — required — (String)

        The AWS identity principal.

  • eventClasses — (Array<String>)

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

    • ACCESS_ACTIVITY

    • FILE_ACTIVITY

    • KERNEL_ACTIVITY

    • KERNEL_EXTENSION

    • MEMORY_ACTIVITY

    • MODULE_ACTIVITY

    • PROCESS_ACTIVITY

    • REGISTRY_KEY_ACTIVITY

    • REGISTRY_VALUE_ACTIVITY

    • RESOURCE_ACTIVITY

    • SCHEDULED_JOB_ACTIVITY

    • SECURITY_FINDING

    • ACCOUNT_CHANGE

    • AUTHENTICATION

    • AUTHORIZATION

    • ENTITY_MANAGEMENT_AUDIT

    • DHCP_ACTIVITY

    • NETWORK_ACTIVITY

    • DNS_ACTIVITY

    • FTP_ACTIVITY

    • HTTP_ACTIVITY

    • RDP_ACTIVITY

    • SMB_ACTIVITY

    • SSH_ACTIVITY

    • CONFIG_STATE

    • INVENTORY_INFO

    • EMAIL_ACTIVITY

    • API_ACTIVITY

    • CLOUD_API

  • sourceName — (String)

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

  • sourceVersion — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • source — (map)

      The created third-party custom source.

      • attributes — (map)

        The attributes of a third-party custom source.

        • crawlerArn — (String)

          The ARN of the Glue crawler.

        • databaseArn — (String)

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

        • tableArn — (String)

          The ARN of the Glue table.

      • provider — (map)

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

        • location — (String)

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

        • roleArn — (String)

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

      • sourceName — (String)

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

      • sourceVersion — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • encryptionConfiguration — (map)

      Provides encryption details of Amazon Security Lake object.

      • kmsKeyId — (String)

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

    • lifecycleConfiguration — (map)

      Provides lifecycle details of Amazon Security Lake object.

      • expiration — (map)

        Provides data expiration details of Amazon Security Lake object.

        • days — (Integer)

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

      • transitions — (Array<map>)

        Provides data storage transition details of Amazon Security Lake object.

        • days — (Integer)

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

        • storageClass — (String)

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

    • region — required — (String)

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

    • replicationConfiguration — (map)

      Provides replication details of Amazon Security Lake object.

      • regions — (Array<String>)

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

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

      • roleArn — (String)

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

  • metaStoreManagerRoleArn — (String)

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

  • tags — (Array<map>)

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

    • key — required — (String)

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

    • value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • dataLakes — (Array<map>)

      The created Security Lake configuration object.

      • createStatus — (String)

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

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

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

      • encryptionConfiguration — (map)

        Provides encryption details of Amazon Security Lake object.

        • kmsKeyId — (String)

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

      • lifecycleConfiguration — (map)

        Provides lifecycle details of Amazon Security Lake object.

        • expiration — (map)

          Provides data expiration details of Amazon Security Lake object.

          • days — (Integer)

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

        • transitions — (Array<map>)

          Provides data storage transition details of Amazon Security Lake object.

          • days — (Integer)

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

          • storageClass — (String)

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

      • region — required — (String)

        The Amazon Web Services Regions where Security Lake is enabled.

      • replicationConfiguration — (map)

        Provides replication details of Amazon Security Lake object.

        • regions — (Array<String>)

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

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

        • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon Security Lake Amazon S3 bucket.

      • updateStatus — (map)

        The status of the last UpdateDataLake or DeleteDataLake API request.

        • exception — (map)

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

          • code — (String)

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

          • reason — (String)

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

        • requestId — (String)

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

        • status — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • notificationEndpoint — (String)

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

  • subscriptionProtocol — (String)

    The subscription protocol to which exception notifications are posted.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • region — required — (String)

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

    • sources — required — (Array<map>)

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

      • sourceName — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Amazon S3 or Lake Formation access type.

  • sources — (Array<map>)

    The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

    • awsLogSource — (map)

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

      • sourceName — (String)

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

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

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

    • customLogSource — (map)

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

      • attributes — (map)

        The attributes of a third-party custom source.

        • crawlerArn — (String)

          The ARN of the Glue crawler.

        • databaseArn — (String)

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

        • tableArn — (String)

          The ARN of the Glue table.

      • provider — (map)

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

        • location — (String)

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

        • roleArn — (String)

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

      • sourceName — (String)

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

      • sourceVersion — (String)

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

  • subscriberDescription — (String)

    The description for your subscriber account in Security Lake.

  • subscriberIdentity — (map)

    The Amazon Web Services identity used to access your data.

    • externalId — required — (String)

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

    • principal — required — (String)

      The AWS identity principal.

  • subscriberName — (String)

    The name of your Security Lake subscriber account.

  • tags — (Array<map>)

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

    • key — required — (String)

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

    • value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriber — (map)

      Retrieve information about the subscriber created using the CreateSubscriber API.

      • accessTypes — (Array<String>)

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

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

      • createdAt — (Date)

        The date and time when the subscriber was created.

      • resourceShareArn — (String)

        The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services 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.

      • sources — required — (Array<map>)

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

        • awsLogSource — (map)

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

          • sourceName — (String)

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

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

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

        • customLogSource — (map)

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

          • attributes — (map)

            The attributes of a third-party custom source.

            • crawlerArn — (String)

              The ARN of the Glue crawler.

            • databaseArn — (String)

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

            • tableArn — (String)

              The ARN of the Glue table.

          • provider — (map)

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

            • location — (String)

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

            • roleArn — (String)

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

          • sourceName — (String)

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

          • sourceVersion — (String)

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

      • subscriberArn — required — (String)

        The subscriber ARN of the Amazon Security Lake subscriber account.

      • subscriberDescription — (String)

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

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

      • subscriberId — required — (String)

        The subscriber ID of the Amazon Security Lake subscriber account.

      • subscriberIdentity — required — (map)

        The Amazon Web Services identity used to access your data.

        • externalId — required — (String)

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

        • principal — required — (String)

          The AWS identity principal.

      • subscriberName — required — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriberStatus — (String)

        The subscriber status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscriber was last updated.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • httpsNotificationConfiguration — (map)

      The configurations for HTTPS subscriber notification.

      • authorizationApiKeyName — (String)

        The key name for the notification subscription.

      • authorizationApiKeyValue — (String)

        The key value for the notification subscription.

      • endpoint — required — (String)

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

      • httpMethod — (String)

        The HTTPS method used for the notification subscription.

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

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

    • sqsNotificationConfiguration — (map)

      The configurations for SQS subscriber notification.

  • subscriberId — (String)

    The subscriber ID for the notification subscription.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriberEndpoint — (String)

      The subscriber endpoint to which exception messages are posted.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • accounts — (Array<String>)

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

    • regions — required — (Array<String>)

      Specify the Regions where you want to enable Security Lake.

    • sourceName — required — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • failed — (Array<String>)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • sourceVersion — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The list of Regions where Security Lake is enabled.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • region — required — (String)

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

    • sources — required — (Array<map>)

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

      • sourceName — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ID of the Security Lake subscriber account.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • exceptionTimeToLive — (Integer)

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

    • notificationEndpoint — (String)

      The Amazon Web Services account where you receive exception notifications.

    • subscriptionProtocol — (String)

      The subscription protocol to which exception notifications are posted.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • autoEnableNewAccount — (Array<map>)

      The configuration for new accounts.

      • region — required — (String)

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

      • sources — required — (Array<map>)

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

        • sourceName — (String)

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

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • maxResults — (Integer)

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

  • nextToken — (String)

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • dataLakeArn — (String)

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

    • dataLakeSources — (Array<map>)

      The list of enabled accounts and enabled sources.

      • account — (String)

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

      • eventClasses — (Array<String>)

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

        • ACCESS_ACTIVITY

        • FILE_ACTIVITY

        • KERNEL_ACTIVITY

        • KERNEL_EXTENSION

        • MEMORY_ACTIVITY

        • MODULE_ACTIVITY

        • PROCESS_ACTIVITY

        • REGISTRY_KEY_ACTIVITY

        • REGISTRY_VALUE_ACTIVITY

        • RESOURCE_ACTIVITY

        • SCHEDULED_JOB_ACTIVITY

        • SECURITY_FINDING

        • ACCOUNT_CHANGE

        • AUTHENTICATION

        • AUTHORIZATION

        • ENTITY_MANAGEMENT_AUDIT

        • DHCP_ACTIVITY

        • NETWORK_ACTIVITY

        • DNS_ACTIVITY

        • FTP_ACTIVITY

        • HTTP_ACTIVITY

        • RDP_ACTIVITY

        • SMB_ACTIVITY

        • SSH_ACTIVITY

        • CONFIG_STATE

        • INVENTORY_INFO

        • EMAIL_ACTIVITY

        • API_ACTIVITY

        • CLOUD_API

      • sourceName — (String)

        The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

      • sourceStatuses — (Array<map>)

        The log status for the Security Lake account.

        • resource — (String)

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

        • status — (String)

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

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

      Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriber — (map)

      The subscriber information for the specified subscriber ID.

      • accessTypes — (Array<String>)

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

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

      • createdAt — (Date)

        The date and time when the subscriber was created.

      • resourceShareArn — (String)

        The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services 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.

      • sources — required — (Array<map>)

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

        • awsLogSource — (map)

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

          • sourceName — (String)

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

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

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

        • customLogSource — (map)

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

          • attributes — (map)

            The attributes of a third-party custom source.

            • crawlerArn — (String)

              The ARN of the Glue crawler.

            • databaseArn — (String)

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

            • tableArn — (String)

              The ARN of the Glue table.

          • provider — (map)

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

            • location — (String)

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

            • roleArn — (String)

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

          • sourceName — (String)

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

          • sourceVersion — (String)

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

      • subscriberArn — required — (String)

        The subscriber ARN of the Amazon Security Lake subscriber account.

      • subscriberDescription — (String)

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

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

      • subscriberId — required — (String)

        The subscriber ID of the Amazon Security Lake subscriber account.

      • subscriberIdentity — required — (map)

        The Amazon Web Services identity used to access your data.

        • externalId — required — (String)

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

        • principal — required — (String)

          The AWS identity principal.

      • subscriberName — required — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriberStatus — (String)

        The subscriber status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscriber was last updated.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    List the maximum number of failures in Security Lake.

  • nextToken — (String)

    List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

  • regions — (Array<String>)

    The Amazon Web Services Regions from which exceptions are retrieved.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • exceptions — (Array<map>)

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

      • exception — (String)

        The underlying exception of a Security Lake exception.

      • region — (String)

        The Amazon Web Services Regions where the exception occurred.

      • remediation — (String)

        List of all remediation steps for a Security Lake exception.

      • timestamp — (Date)

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

    • nextToken — (String)

      List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The list of Regions where Security Lake is enabled.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • dataLakes — (Array<map>)

      Retrieves the Security Lake configuration object.

      • createStatus — (String)

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

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

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

      • encryptionConfiguration — (map)

        Provides encryption details of Amazon Security Lake object.

        • kmsKeyId — (String)

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

      • lifecycleConfiguration — (map)

        Provides lifecycle details of Amazon Security Lake object.

        • expiration — (map)

          Provides data expiration details of Amazon Security Lake object.

          • days — (Integer)

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

        • transitions — (Array<map>)

          Provides data storage transition details of Amazon Security Lake object.

          • days — (Integer)

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

          • storageClass — (String)

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

      • region — required — (String)

        The Amazon Web Services Regions where Security Lake is enabled.

      • replicationConfiguration — (map)

        Provides replication details of Amazon Security Lake object.

        • regions — (Array<String>)

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

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

        • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon Security Lake Amazon S3 bucket.

      • updateStatus — (map)

        The status of the last UpdateDataLake or DeleteDataLake API request.

        • exception — (map)

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

          • code — (String)

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

          • reason — (String)

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

        • requestId — (String)

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

        • status — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • maxResults — (Integer)

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

  • nextToken — (String)

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

  • regions — (Array<String>)

    The list of Regions for which log sources are displayed.

  • sources — (Array<map>)

    The list of sources for which log sources are displayed.

    • awsLogSource — (map)

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

      • sourceName — (String)

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

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

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

    • customLogSource — (map)

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

      • attributes — (map)

        The attributes of a third-party custom source.

        • crawlerArn — (String)

          The ARN of the Glue crawler.

        • databaseArn — (String)

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

        • tableArn — (String)

          The ARN of the Glue table.

      • provider — (map)

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

        • location — (String)

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

        • roleArn — (String)

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

      • sourceName — (String)

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

      • sourceVersion — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • nextToken — (String)

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

    • sources — (Array<map>)

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

      • account — (String)

        Specify the account from which you want to collect logs.

      • region — (String)

        Specify the Regions from which you want to collect logs.

      • sources — (Array<map>)

        Specify the sources from which you want to collect logs.

        • awsLogSource — (map)

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

          • sourceName — (String)

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

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

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

        • customLogSource — (map)

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

          • attributes — (map)

            The attributes of a third-party custom source.

            • crawlerArn — (String)

              The ARN of the Glue crawler.

            • databaseArn — (String)

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

            • tableArn — (String)

              The ARN of the Glue table.

          • provider — (map)

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

            • location — (String)

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

            • roleArn — (String)

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

          • sourceName — (String)

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

          • sourceVersion — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • nextToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • nextToken — (String)

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

    • subscribers — (Array<map>)

      The subscribers available for the specified Security Lake account ID.

      • accessTypes — (Array<String>)

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

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

      • createdAt — (Date)

        The date and time when the subscriber was created.

      • resourceShareArn — (String)

        The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services 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.

      • sources — required — (Array<map>)

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

        • awsLogSource — (map)

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

          • sourceName — (String)

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

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

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

        • customLogSource — (map)

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

          • attributes — (map)

            The attributes of a third-party custom source.

            • crawlerArn — (String)

              The ARN of the Glue crawler.

            • databaseArn — (String)

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

            • tableArn — (String)

              The ARN of the Glue table.

          • provider — (map)

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

            • location — (String)

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

            • roleArn — (String)

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

          • sourceName — (String)

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

          • sourceVersion — (String)

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

      • subscriberArn — required — (String)

        The subscriber ARN of the Amazon Security Lake subscriber account.

      • subscriberDescription — (String)

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

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

      • subscriberId — required — (String)

        The subscriber ID of the Amazon Security Lake subscriber account.

      • subscriberIdentity — required — (map)

        The Amazon Web Services identity used to access your data.

        • externalId — required — (String)

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

        • principal — required — (String)

          The AWS identity principal.

      • subscriberName — required — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriberStatus — (String)

        The subscriber status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscriber was last updated.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • tags — (Array<map>)

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

      • key — required — (String)

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

      • value — required — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • tags — (Array<map>)

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

    • key — required — (String)

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

    • value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • tagKeys — (Array<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • encryptionConfiguration — (map)

      Provides encryption details of Amazon Security Lake object.

      • kmsKeyId — (String)

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

    • lifecycleConfiguration — (map)

      Provides lifecycle details of Amazon Security Lake object.

      • expiration — (map)

        Provides data expiration details of Amazon Security Lake object.

        • days — (Integer)

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

      • transitions — (Array<map>)

        Provides data storage transition details of Amazon Security Lake object.

        • days — (Integer)

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

        • storageClass — (String)

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

    • region — required — (String)

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

    • replicationConfiguration — (map)

      Provides replication details of Amazon Security Lake object.

      • regions — (Array<String>)

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

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

      • roleArn — (String)

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

  • metaStoreManagerRoleArn — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • dataLakes — (Array<map>)

      The created Security Lake configuration object.

      • createStatus — (String)

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

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

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

      • encryptionConfiguration — (map)

        Provides encryption details of Amazon Security Lake object.

        • kmsKeyId — (String)

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

      • lifecycleConfiguration — (map)

        Provides lifecycle details of Amazon Security Lake object.

        • expiration — (map)

          Provides data expiration details of Amazon Security Lake object.

          • days — (Integer)

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

        • transitions — (Array<map>)

          Provides data storage transition details of Amazon Security Lake object.

          • days — (Integer)

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

          • storageClass — (String)

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

      • region — required — (String)

        The Amazon Web Services Regions where Security Lake is enabled.

      • replicationConfiguration — (map)

        Provides replication details of Amazon Security Lake object.

        • regions — (Array<String>)

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

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

        • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon Security Lake Amazon S3 bucket.

      • updateStatus — (map)

        The status of the last UpdateDataLake or DeleteDataLake API request.

        • exception — (map)

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

          • code — (String)

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

          • reason — (String)

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

        • requestId — (String)

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

        • status — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • notificationEndpoint — (String)

    The account that is subscribed to receive exception notifications.

  • subscriptionProtocol — (String)

    The subscription protocol to which exception messages are posted.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

    • awsLogSource — (map)

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

      • sourceName — (String)

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

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

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

    • customLogSource — (map)

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

      • attributes — (map)

        The attributes of a third-party custom source.

        • crawlerArn — (String)

          The ARN of the Glue crawler.

        • databaseArn — (String)

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

        • tableArn — (String)

          The ARN of the Glue table.

      • provider — (map)

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

        • location — (String)

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

        • roleArn — (String)

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

      • sourceName — (String)

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

      • sourceVersion — (String)

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

  • subscriberDescription — (String)

    The description of the Security Lake account subscriber.

  • subscriberId — (String)

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

  • subscriberIdentity — (map)

    The AWS identity used to access your data.

    • externalId — required — (String)

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

    • principal — required — (String)

      The AWS identity principal.

  • subscriberName — (String)

    The name of the Security Lake account subscriber.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriber — (map)

      The updated subscriber information.

      • accessTypes — (Array<String>)

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

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

      • createdAt — (Date)

        The date and time when the subscriber was created.

      • resourceShareArn — (String)

        The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services 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.

      • sources — required — (Array<map>)

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

        • awsLogSource — (map)

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

          • sourceName — (String)

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

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

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

        • customLogSource — (map)

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

          • attributes — (map)

            The attributes of a third-party custom source.

            • crawlerArn — (String)

              The ARN of the Glue crawler.

            • databaseArn — (String)

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

            • tableArn — (String)

              The ARN of the Glue table.

          • provider — (map)

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

            • location — (String)

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

            • roleArn — (String)

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

          • sourceName — (String)

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

          • sourceVersion — (String)

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

      • subscriberArn — required — (String)

        The subscriber ARN of the Amazon Security Lake subscriber account.

      • subscriberDescription — (String)

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

      • subscriberEndpoint — (String)

        The subscriber endpoint to which exception messages are posted.

      • subscriberId — required — (String)

        The subscriber ID of the Amazon Security Lake subscriber account.

      • subscriberIdentity — required — (map)

        The Amazon Web Services identity used to access your data.

        • externalId — required — (String)

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

        • principal — required — (String)

          The AWS identity principal.

      • subscriberName — required — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriberStatus — (String)

        The subscriber status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscriber was last updated.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The configuration for subscriber notification.

    • httpsNotificationConfiguration — (map)

      The configurations for HTTPS subscriber notification.

      • authorizationApiKeyName — (String)

        The key name for the notification subscription.

      • authorizationApiKeyValue — (String)

        The key value for the notification subscription.

      • endpoint — required — (String)

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

      • httpMethod — (String)

        The HTTPS method used for the notification subscription.

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

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

    • sqsNotificationConfiguration — (map)

      The configurations for SQS subscriber notification.

  • subscriberId — (String)

    The subscription ID for which the subscription notification is specified.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriberEndpoint — (String)

      The subscriber endpoint to which exception messages are posted.

Returns:

• (AWS.Request) —

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