Class: AWS.SecurityLake

var params = {
  customSourceName: 'STRING_VALUE', /* required */
  eventClass: ACCESS_ACTIVITY | FILE_ACTIVITY | KERNEL_ACTIVITY | KERNEL_EXTENSION | MEMORY_ACTIVITY | MODULE_ACTIVITY | PROCESS_ACTIVITY | REGISTRY_KEY_ACTIVITY | REGISTRY_VALUE_ACTIVITY | RESOURCE_ACTIVITY | SCHEDULED_JOB_ACTIVITY | SECURITY_FINDING | ACCOUNT_CHANGE | AUTHENTICATION | AUTHORIZATION | ENTITY_MANAGEMENT_AUDIT | DHCP_ACTIVITY | NETWORK_ACTIVITY | DNS_ACTIVITY | FTP_ACTIVITY | HTTP_ACTIVITY | RDP_ACTIVITY | SMB_ACTIVITY | SSH_ACTIVITY | CLOUD_API | CONTAINER_LIFECYCLE | DATABASE_LIFECYCLE | CONFIG_STATE | CLOUD_STORAGE | INVENTORY_INFO | RFB_ACTIVITY | SMTP_ACTIVITY | VIRTUAL_MACHINE_ACTIVITY, /* required */
  glueInvocationRoleArn: 'STRING_VALUE', /* required */
  logProviderAccountId: 'STRING_VALUE' /* required */
};
securitylake.createCustomLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • eventClass — (String)

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

    Possible values include:
    • "ACCESS_ACTIVITY"
    • "FILE_ACTIVITY"
    • "KERNEL_ACTIVITY"
    • "KERNEL_EXTENSION"
    • "MEMORY_ACTIVITY"
    • "MODULE_ACTIVITY"
    • "PROCESS_ACTIVITY"
    • "REGISTRY_KEY_ACTIVITY"
    • "REGISTRY_VALUE_ACTIVITY"
    • "RESOURCE_ACTIVITY"
    • "SCHEDULED_JOB_ACTIVITY"
    • "SECURITY_FINDING"
    • "ACCOUNT_CHANGE"
    • "AUTHENTICATION"
    • "AUTHORIZATION"
    • "ENTITY_MANAGEMENT_AUDIT"
    • "DHCP_ACTIVITY"
    • "NETWORK_ACTIVITY"
    • "DNS_ACTIVITY"
    • "FTP_ACTIVITY"
    • "HTTP_ACTIVITY"
    • "RDP_ACTIVITY"
    • "SMB_ACTIVITY"
    • "SSH_ACTIVITY"
    • "CLOUD_API"
    • "CONTAINER_LIFECYCLE"
    • "DATABASE_LIFECYCLE"
    • "CONFIG_STATE"
    • "CLOUD_STORAGE"
    • "INVENTORY_INFO"
    • "RFB_ACTIVITY"
    • "SMTP_ACTIVITY"
    • "VIRTUAL_MACHINE_ACTIVITY"
  • glueInvocationRoleArn — (String)

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

    • The managed policy AWSGlueServiceRole

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

  • logProviderAccountId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • customDataLocation — (String)

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

    • glueCrawlerName — (String)

      The name of the Glue crawler.

    • glueDatabaseName — (String)

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

    • glueTableName — (String)

      The table name of the Glue crawler.

    • logProviderAccessRoleArn — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  configurations: {
    '<Region>': {
      encryptionKey: 'STRING_VALUE',
      replicationDestinationRegions: [
        us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
        /* more items */
      ],
      replicationRoleArn: 'STRING_VALUE',
      retentionSettings: [
        {
          retentionPeriod: 'NUMBER_VALUE',
          storageClass: STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER_IR | GLACIER | DEEP_ARCHIVE | EXPIRE
        },
        /* more items */
      ],
      tagsMap: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      }
    },
    /* '<Region>': ... */
  },
  enableAll: true || false,
  metaStoreManagerRoleArn: 'STRING_VALUE',
  regions: [
    us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
    /* more items */
  ]
};
securitylake.createDatalake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • encryptionKey — (String)

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

    • replicationDestinationRegions — (Array<String>)

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

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

    • replicationRoleArn — (String)

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

    • retentionSettings — (Array<map>)

      Retention settings for the destination Amazon S3 buckets.

      • retentionPeriod — (Integer)

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

      • storageClass — (String)

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

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

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

  • enableAll — (Boolean)

    Enable Security Lake in all Regions.

  • metaStoreManagerRoleArn — (String)

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

  • regions — (Array<String>)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  configurationForNewAccounts: [ /* required */
    {
      region: us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2, /* required */
      sources: [ /* required */
        ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.createDatalakeAutoEnable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • region — required — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: HTTP | HTTPS | EMAIL | EMAIL_JSON | SMS | SQS | LAMBDA | APP | FIREHOSE /* required */
};
securitylake.createDatalakeExceptionsSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • subscriptionProtocol — (String)

    The subscription protocol to which exception notifications are posted.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  accountId: 'STRING_VALUE', /* required */
  externalId: 'STRING_VALUE', /* required */
  sourceTypes: [ /* required */
    {
      awsSourceType: ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
      customSourceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  subscriberName: 'STRING_VALUE', /* required */
  accessTypes: [
    LAKEFORMATION | S3,
    /* more items */
  ],
  subscriberDescription: 'STRING_VALUE'
};
securitylake.createSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Amazon S3 or Lake Formation access type.

  • accountId — (String)

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

  • externalId — (String)

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

  • sourceTypes — (Array<map>)

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

    • awsSourceType — (String)

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

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

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

  • subscriberDescription — (String)

    The description for your subscriber account in Security Lake.

  • subscriberName — (String)

    The name of your Security Lake subscriber account.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • roleArn — (String)

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

    • s3BucketArn — (String)

      The ARN for the Amazon S3 bucket.

    • snsArn — (String)

      The ARN for the Amazon Simple Notification Service.

    • subscriptionId — (String)

      The subscriptionId created by the CreateSubscriber API call.

Returns:

• (AWS.Request) —

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

var params = {
  subscriptionId: 'STRING_VALUE', /* required */
  createSqs: true || false,
  httpsApiKeyName: 'STRING_VALUE',
  httpsApiKeyValue: 'STRING_VALUE',
  httpsMethod: POST | PUT,
  roleArn: 'STRING_VALUE',
  subscriptionEndpoint: 'STRING_VALUE'
};
securitylake.createSubscriptionNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • createSqs — (Boolean)

    Create an Amazon Simple Queue Service queue.

  • httpsApiKeyName — (String)

    The key name for the notification subscription.

  • httpsApiKeyValue — (String)

    The key value for the notification subscription.

  • httpsMethod — (String)

    The HTTPS method used for the notification subscription.

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

    The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.

  • subscriptionEndpoint — (String)

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

  • subscriptionId — (String)

    The subscription ID for the notification subscription/

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • queueArn — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  inputOrder: [ /* required */
    REGION | SOURCE_TYPE | MEMBER,
    /* more items */
  ],
  disableAllDimensions: {
    '<String>': {
      '<String>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<String>': ... */
    },
    /* '<String>': ... */
  },
  disableSingleDimension: [
    'STRING_VALUE',
    /* more items */
  ],
  disableTwoDimensions: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  }
};
securitylake.deleteAwsLogSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • disableSingleDimension — (Array<String>)

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

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

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

  • inputOrder — (Array<String>)

    This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • failed — (Array<String>)

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

    • processing — (Array<String>)

      Deletion of the Amazon Web Services sources is in progress.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The custom source name for the custom log source.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • customDataLocation — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  removeFromConfigurationForNewAccounts: [ /* required */
    {
      region: us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2, /* required */
      sources: [ /* required */
        ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
        /* more items */
      ]
    },
    /* more items */
  ]
};
securitylake.deleteDatalakeAutoEnable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    Delete Amazon Security Lake with the specified configuration settings to stop ingesting security data for new accounts in Security Lake.

    • region — required — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The account ID the Security Lake delegated administrator.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • status — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ID of the Security Lake subscriber account.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • configurations — (map<map>)

      Retrieves the Security Lake configuration object.

      • encryptionKey — (String)

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

      • replicationDestinationRegions — (Array<String>)

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

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

      • replicationRoleArn — (String)

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

      • retentionSettings — (Array<map>)

        Retention settings for the destination Amazon S3 buckets.

        • retentionPeriod — (Integer)

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

        • storageClass — (String)

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

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

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

      • status — (String)

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

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • autoEnableNewAccounts — (Array<map>)

      The configuration for new accounts.

      • region — required — (String)

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

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • exceptionMessageExpiry — (Integer)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • protocolAndNotificationEndpoint — (map)

      Retrieves the exception notification subscription information.

      • endpoint — (String)

        The account that is subscribed to receive exception notifications.

      • protocol — (String)

        The protocol to which notification messages are posted.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • maxAccountResults — (Integer)

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

  • nextToken — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • accountSourcesList — (Array<map>)

      The list of enabled accounts and enabled sources.

      • account — required — (String)

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

      • eventClass — (String)

        Initializes a new instance of the Event class.

        Possible values include:
        • "ACCESS_ACTIVITY"
        • "FILE_ACTIVITY"
        • "KERNEL_ACTIVITY"
        • "KERNEL_EXTENSION"
        • "MEMORY_ACTIVITY"
        • "MODULE_ACTIVITY"
        • "PROCESS_ACTIVITY"
        • "REGISTRY_KEY_ACTIVITY"
        • "REGISTRY_VALUE_ACTIVITY"
        • "RESOURCE_ACTIVITY"
        • "SCHEDULED_JOB_ACTIVITY"
        • "SECURITY_FINDING"
        • "ACCOUNT_CHANGE"
        • "AUTHENTICATION"
        • "AUTHORIZATION"
        • "ENTITY_MANAGEMENT_AUDIT"
        • "DHCP_ACTIVITY"
        • "NETWORK_ACTIVITY"
        • "DNS_ACTIVITY"
        • "FTP_ACTIVITY"
        • "HTTP_ACTIVITY"
        • "RDP_ACTIVITY"
        • "SMB_ACTIVITY"
        • "SSH_ACTIVITY"
        • "CLOUD_API"
        • "CONTAINER_LIFECYCLE"
        • "DATABASE_LIFECYCLE"
        • "CONFIG_STATE"
        • "CLOUD_STORAGE"
        • "INVENTORY_INFO"
        • "RFB_ACTIVITY"
        • "SMTP_ACTIVITY"
        • "VIRTUAL_MACHINE_ACTIVITY"
      • logsStatus — (Array<map>)

        The log status for the Security Lake account.

        • healthStatus — required — (String)

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

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

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

      • sourceType — required — (String)

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

    • nextToken — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriber — (map)

      The subscription information for the specified subscription ID.

      • accessTypes — (Array<String>)

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

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

      • accountId — required — (String)

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

      • createdAt — (Date)

        The date and time when the subscription was created.

      • externalId — (String)

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

      • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon S3 bucket.

      • snsArn — (String)

        The ARN for the Amazon Simple Notification Service.

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

        • awsSourceType — (String)

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

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

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

      • subscriberDescription — (String)

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

      • subscriberName — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriptionEndpoint — (String)

        The subscription endpoint to which exception messages are posted.

      • subscriptionId — required — (String)

        The subscription ID of the Amazon Security Lake subscriber account.

      • subscriptionProtocol — (String)

        The subscription protocol to which exception messages are posted.

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

        The subscription status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscription was created.

Returns:

• (AWS.Request) —

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

var params = {
  maxFailures: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  regionSet: [
    us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
    /* more items */
  ]
};
securitylake.listDatalakeExceptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    List the maximum number of failures in Security Lake.

  • nextToken — (String)

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

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

  • regionSet — (Array<String>)

    List the Amazon Web Services Regions from which exceptions are retrieved.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • nextToken — (String)

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

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

    • nonRetryableFailures — (Array<map>)

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

      • failures — (Array<map>)

        List of all failures.

        • exceptionMessage — required — (String)

          List of all exception messages.

        • remediation — required — (String)

          List of all remediation steps for failures.

        • timestamp — required — (Date)

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

      • region — (String)

        List of Amazon Web Services Regions where the failure occurred.

Returns:

• (AWS.Request) —

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

var params = {
  inputOrder: [
    REGION | SOURCE_TYPE | MEMBER,
    /* more items */
  ],
  listAllDimensions: {
    '<String>': {
      '<String>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<String>': ... */
    },
    /* '<String>': ... */
  },
  listSingleDimension: [
    'STRING_VALUE',
    /* more items */
  ],
  listTwoDimensions: {
    '<String>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<String>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
securitylake.listLogSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

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

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

  • listSingleDimension — (Array<String>)

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

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

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

  • maxResults — (Integer)

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

  • nextToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • nextToken — (String)

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

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

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

Returns:

• (AWS.Request) —

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

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.

      • accountId — required — (String)

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

      • createdAt — (Date)

        The date and time when the subscription was created.

      • externalId — (String)

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

      • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon S3 bucket.

      • snsArn — (String)

        The ARN for the Amazon Simple Notification Service.

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

        • awsSourceType — (String)

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

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

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

      • subscriberDescription — (String)

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

      • subscriberName — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriptionEndpoint — (String)

        The subscription endpoint to which exception messages are posted.

      • subscriptionId — required — (String)

        The subscription ID of the Amazon Security Lake subscriber account.

      • subscriptionProtocol — (String)

        The subscription protocol to which exception messages are posted.

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

        The subscription status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscription was created.

Returns:

• (AWS.Request) —

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

var params = {
  configurations: { /* required */
    '<Region>': {
      encryptionKey: 'STRING_VALUE',
      replicationDestinationRegions: [
        us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2,
        /* more items */
      ],
      replicationRoleArn: 'STRING_VALUE',
      retentionSettings: [
        {
          retentionPeriod: 'NUMBER_VALUE',
          storageClass: STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER_IR | GLACIER | DEEP_ARCHIVE | EXPIRE
        },
        /* more items */
      ],
      tagsMap: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      }
    },
    /* '<Region>': ... */
  }
};
securitylake.updateDatalake(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • encryptionKey — (String)

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

    • replicationDestinationRegions — (Array<String>)

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

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

    • replicationRoleArn — (String)

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

    • retentionSettings — (Array<map>)

      Retention settings for the destination Amazon S3 buckets.

      • retentionPeriod — (Integer)

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

      • storageClass — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  notificationEndpoint: 'STRING_VALUE', /* required */
  subscriptionProtocol: HTTP | HTTPS | EMAIL | EMAIL_JSON | SMS | SQS | LAMBDA | APP | FIREHOSE /* required */
};
securitylake.updateDatalakeExceptionsSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The account that is subscribed to receive exception notifications.

  • subscriptionProtocol — (String)

    The subscription protocol to which exception messages are posted.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  sourceTypes: [ /* required */
    {
      awsSourceType: ROUTE53 | VPC_FLOW | CLOUD_TRAIL | SH_FINDINGS,
      customSourceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  externalId: 'STRING_VALUE',
  subscriberDescription: 'STRING_VALUE',
  subscriberName: 'STRING_VALUE'
};
securitylake.updateSubscriber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The external ID of the Security Lake account.

  • id — (String)

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

  • sourceTypes — (Array<map>)

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

    • awsSourceType — (String)

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

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

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

  • subscriberDescription — (String)

    The description of the Security Lake account subscriber.

  • subscriberName — (String)

    The name of the Security Lake account subscriber.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • subscriber — (map)

      The account of the subscriber.

      • accessTypes — (Array<String>)

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

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

      • accountId — required — (String)

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

      • createdAt — (Date)

        The date and time when the subscription was created.

      • externalId — (String)

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

      • roleArn — (String)

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

      • s3BucketArn — (String)

        The ARN for the Amazon S3 bucket.

      • snsArn — (String)

        The ARN for the Amazon Simple Notification Service.

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

        • awsSourceType — (String)

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

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

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

      • subscriberDescription — (String)

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

      • subscriberName — (String)

        The name of your Amazon Security Lake subscriber account.

      • subscriptionEndpoint — (String)

        The subscription endpoint to which exception messages are posted.

      • subscriptionId — required — (String)

        The subscription ID of the Amazon Security Lake subscriber account.

      • subscriptionProtocol — (String)

        The subscription protocol to which exception messages are posted.

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

        The subscription status of the Amazon Security Lake subscriber account.

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

        The date and time when the subscription was created.

Returns:

• (AWS.Request) —

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

var params = {
  subscriptionId: 'STRING_VALUE', /* required */
  createSqs: true || false,
  httpsApiKeyName: 'STRING_VALUE',
  httpsApiKeyValue: 'STRING_VALUE',
  httpsMethod: POST | PUT,
  roleArn: 'STRING_VALUE',
  subscriptionEndpoint: 'STRING_VALUE'
};
securitylake.updateSubscriptionNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • createSqs — (Boolean)

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

  • httpsApiKeyName — (String)

    The key name for the subscription notification.

  • httpsApiKeyValue — (String)

    The key value for the subscription notification.

  • httpsMethod — (String)

    The HTTPS method used for the subscription notification.

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

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

  • subscriptionEndpoint — (String)

    The subscription endpoint in Security Lake.

  • subscriptionId — (String)

    The subscription ID for which the subscription notification is specified.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • queueArn — (String)

      Returns the ARN of the queue.

Returns:

• (AWS.Request) —

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