Securitylake

This page documents function available when using the Securitylake module, created with @service Securitylake.

Index

Documentation

Main.Securitylake.create_aws_log_sourceMethod
create_aws_log_source(sources)
create_aws_log_source(sources, params::Dict{String,<:Any})

Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it, You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.

Arguments

  • sources: Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
Main.Securitylake.create_custom_log_sourceMethod
create_custom_log_source(source_name)
create_custom_log_source(source_name, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "configuration": The configuration for the third-party custom source.
  • "eventClasses": 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: ACCESSACTIVITY FILEACTIVITY KERNELACTIVITY KERNELEXTENSION MEMORYACTIVITY MODULEACTIVITY PROCESSACTIVITY REGISTRYKEYACTIVITY REGISTRYVALUEACTIVITY RESOURCEACTIVITY SCHEDULEDJOBACTIVITY SECURITYFINDING ACCOUNTCHANGE AUTHENTICATION AUTHORIZATION ENTITYMANAGEMENTAUDIT DHCPACTIVITY NETWORKACTIVITY DNSACTIVITY FTPACTIVITY HTTPACTIVITY RDPACTIVITY SMBACTIVITY SSHACTIVITY CONFIGSTATE INVENTORYINFO EMAILACTIVITY APIACTIVITY CLOUD_API
  • "sourceVersion": Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
Main.Securitylake.create_data_lakeMethod
create_data_lake(configurations, meta_store_manager_role_arn)
create_data_lake(configurations, meta_store_manager_role_arn, params::Dict{String,<:Any})

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. By default, the CreateDataLake Security Lake in all Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations. When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

Arguments

  • configurations: Specify the Region or Regions that will contribute data to the rollup region.
  • meta_store_manager_role_arn: 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.
Main.Securitylake.create_data_lake_exception_subscriptionMethod
create_data_lake_exception_subscription(notification_endpoint, subscription_protocol)
create_data_lake_exception_subscription(notification_endpoint, subscription_protocol, params::Dict{String,<:Any})

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

Arguments

  • notification_endpoint: The Amazon Web Services account where you want to receive exception notifications.
  • subscription_protocol: The subscription protocol to which exception notifications are posted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "exceptionTimeToLive": The expiration period and time-to-live (TTL).
Main.Securitylake.create_data_lake_organization_configurationMethod
create_data_lake_organization_configuration(auto_enable_new_account)
create_data_lake_organization_configuration(auto_enable_new_account, params::Dict{String,<:Any})

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

Arguments

  • auto_enable_new_account: Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
Main.Securitylake.create_subscriberMethod
create_subscriber(sources, subscriber_identity, subscriber_name)
create_subscriber(sources, subscriber_identity, subscriber_name, params::Dict{String,<:Any})

Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

Arguments

  • sources: 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.
  • subscriber_identity: The AWS identity used to access your data.
  • subscriber_name: The name of your Security Lake subscriber account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accessTypes": The Amazon S3 or Lake Formation access type.
  • "subscriberDescription": The description for your subscriber account in Security Lake.
Main.Securitylake.create_subscriber_notificationMethod
create_subscriber_notification(configuration, subscriber_id)
create_subscriber_notification(configuration, subscriber_id, params::Dict{String,<:Any})

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

Arguments

  • configuration: Specify the configuration using which you want to create the subscriber notification.
  • subscriber_id: The subscriber ID for the notification subscription.
Main.Securitylake.delete_aws_log_sourceMethod
delete_aws_log_source(sources)
delete_aws_log_source(sources, params::Dict{String,<:Any})

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal. You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.

Arguments

  • sources: Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
Main.Securitylake.delete_custom_log_sourceMethod
delete_custom_log_source(source_name)
delete_custom_log_source(source_name, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sourceVersion": The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
Main.Securitylake.delete_data_lakeMethod
delete_data_lake(regions)
delete_data_lake(regions, params::Dict{String,<:Any})

When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region. The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

Arguments

  • regions: The list of Regions where Security Lake is enabled.
Main.Securitylake.delete_data_lake_organization_configurationMethod
delete_data_lake_organization_configuration(auto_enable_new_account)
delete_data_lake_organization_configuration(auto_enable_new_account, params::Dict{String,<:Any})

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

Arguments

  • auto_enable_new_account: Removes the automatic enablement of configuration settings for new member accounts in Security Lake.
Main.Securitylake.delete_subscriberMethod
delete_subscriber(subscriber_id)
delete_subscriber(subscriber_id, params::Dict{String,<:Any})

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

Arguments

  • subscriber_id: A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
Main.Securitylake.delete_subscriber_notificationMethod
delete_subscriber_notification(subscriber_id)
delete_subscriber_notification(subscriber_id, params::Dict{String,<:Any})

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

Arguments

  • subscriber_id: The ID of the Security Lake subscriber account.
Main.Securitylake.deregister_data_lake_delegated_administratorMethod
deregister_data_lake_delegated_administrator()
deregister_data_lake_delegated_administrator(params::Dict{String,<:Any})

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

Main.Securitylake.get_data_lake_organization_configurationMethod
get_data_lake_organization_configuration()
get_data_lake_organization_configuration(params::Dict{String,<:Any})

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

Main.Securitylake.get_data_lake_sourcesMethod
get_data_lake_sources()
get_data_lake_sources(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accounts": 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": The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
  • "nextToken": 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.
Main.Securitylake.get_subscriberMethod
get_subscriber(subscriber_id)
get_subscriber(subscriber_id, params::Dict{String,<:Any})

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

Arguments

  • subscriber_id: A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
Main.Securitylake.list_data_lake_exceptionsMethod
list_data_lake_exceptions()
list_data_lake_exceptions(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": List the maximum number of failures in Security Lake.
  • "nextToken": 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": List the Amazon Web Services Regions from which exceptions are retrieved.
Main.Securitylake.list_data_lakesMethod
list_data_lakes()
list_data_lakes(params::Dict{String,<:Any})

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the ListDataLakes API to know whether Security Lake is enabled for any region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "regions": The list of regions where Security Lake is enabled.
Main.Securitylake.list_log_sourcesMethod
list_log_sources()
list_log_sources(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accounts": The list of Amazon Web Services accounts for which log sources are displayed.
  • "maxResults": The maximum number of accounts for which the log sources are displayed.
  • "nextToken": If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
  • "regions": The list of regions for which log sources are displayed.
  • "sources": The list of sources for which log sources are displayed.
Main.Securitylake.list_subscribersMethod
list_subscribers()
list_subscribers(params::Dict{String,<:Any})

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of accounts for which the configuration is displayed.
  • "nextToken": If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
Main.Securitylake.register_data_lake_delegated_administratorMethod
register_data_lake_delegated_administrator(account_id)
register_data_lake_delegated_administrator(account_id, params::Dict{String,<:Any})

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

Arguments

  • account_id: The Amazon Web Services account ID of the Security Lake delegated administrator.
Main.Securitylake.update_data_lakeMethod
update_data_lake(configurations)
update_data_lake(configurations, params::Dict{String,<:Any})

Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.

Arguments

  • configurations: Specify the Region or Regions that will contribute data to the rollup region.
Main.Securitylake.update_data_lake_exception_subscriptionMethod
update_data_lake_exception_subscription(notification_endpoint, subscription_protocol)
update_data_lake_exception_subscription(notification_endpoint, subscription_protocol, params::Dict{String,<:Any})

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

Arguments

  • notification_endpoint: The account that is subscribed to receive exception notifications.
  • subscription_protocol: The subscription protocol to which exception messages are posted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "exceptionTimeToLive": The time-to-live (TTL) for the exception message to remain.
Main.Securitylake.update_subscriberMethod
update_subscriber(subscriber_id)
update_subscriber(subscriber_id, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sources": 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.
  • "subscriberDescription": The description of the Security Lake account subscriber.
  • "subscriberIdentity": The AWS identity used to access your data.
  • "subscriberName": The name of the Security Lake account subscriber.
Main.Securitylake.update_subscriber_notificationMethod
update_subscriber_notification(configuration, subscriber_id)
update_subscriber_notification(configuration, subscriber_id, params::Dict{String,<:Any})

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

Arguments

  • configuration: The configuration for subscriber notification.
  • subscriber_id: The subscription ID for which the subscription notification is specified.