View Source AWS.SecurityLake (aws-elixir v1.0.4)
Amazon Security Lake is a fully managed security data lake service.
You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
Link to this section Summary
Functions
Adds a natively supported Amazon Web Services service as an Amazon Security Lake source.
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source.
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
Automatically enables Amazon Security Lake for new member accounts in your organization.
Creates a subscriber for accounts that are already enabled in Amazon Security Lake.
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
Removes a natively supported Amazon Web Services service as an Amazon Security Lake source.
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
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.
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations.
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake.
Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.
Deletes the Amazon Security Lake delegated administrator account for the organization.
Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake.
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.
Retrieves the subscription information for the specified subscription ID.
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
Retrieves the log sources.
Lists all subscribers for the specific Amazon Security Lake account ID.
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
Designates the Amazon Security Lake delegated administrator account for the organization.
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
You can use UpdateDataLake to specify where to store your security data, how
it should
be encrypted at rest and for how long.
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
Updates an existing subscription for the given Amazon Security Lake account ID.
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
Link to this section Functions
Adds a natively supported Amazon Web Services 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 Services 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
services as a
source. Use CreateCustomLogSource to enable data collection from a custom
source.
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.
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
You
can enable Security Lake in Amazon Web Services Regions with customized settings
before enabling
log collection in Regions. To specify particular Regions, configure these
Regions using the
configurations parameter. If you have already enabled Security Lake in a
Region
when you call this command, the command will update the Region if you provide
new
configuration parameters. If you have not already enabled Security Lake in the
Region when you
call this API, it will set up the data lake in the Region with the specified
configurations.
When you enable Security Lake, it starts ingesting security data after the
CreateAwsLogSource call and after you create subscribers using the
CreateSubscriber API. 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.
create_data_lake_exception_subscription(client, input, options \\ [])
View SourceCreates the specified notification subscription in Amazon Security Lake for the organization you specify.
The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.
create_data_lake_organization_configuration(client, input, options \\ [])
View SourceAutomatically 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.
Creates a subscriber 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.
create_subscriber_notification(client, subscriber_id, input, options \\ [])
View SourceNotifies 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.
Removes a natively supported Amazon Web Services 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.
delete_custom_log_source(client, source_name, input, options \\ [])
View SourceRemoves a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
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.
delete_data_lake_exception_subscription(client, input, options \\ [])
View SourceDeletes the specified notification subscription in Amazon Security Lake for the organization you specify.
delete_data_lake_organization_configuration(client, input, options \\ [])
View SourceTurns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations.
Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
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.
delete_subscriber_notification(client, subscriber_id, input, options \\ [])
View SourceDeletes the specified subscription notification in Amazon Security Lake for the organization you specify.
deregister_data_lake_delegated_administrator(client, input, options \\ [])
View SourceDeletes 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.
Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
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.
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.
Retrieves the subscription information for the specified subscription ID.
You can get information about a specific subscriber.
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
You can use this operation to determine whether Security Lake is enabled for a Region.
Retrieves the log sources.
list_subscribers(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
register_data_lake_delegated_administrator(client, input, options \\ [])
View SourceDesignates 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.
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
You can use UpdateDataLake to specify where to store your security data, how
it should
be encrypted at rest and for how long.
You can add a Rollup Region
to consolidate data from multiple Amazon Web Services Regions, replace
default encryption (SSE-S3) with Customer Manged Key,
or specify transition and expiration actions through storage Lifecycle management.
The UpdateDataLake API works as an "upsert" operation that performs an insert
if the specified item or record does not exist, or an update if it
already exists. Security Lake securely stores your data at rest using Amazon Web
Services encryption solutions. For more details, see Data protection in Amazon Security
Lake.
For example, omitting the key encryptionConfiguration from a Region that is
included in an update call that currently uses KMS will leave that Region's KMS
key in
place, but specifying encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'}
for that same Region will reset the key to S3-managed.
For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the Amazon Security Lake User Guide.
update_data_lake_exception_subscription(client, input, options \\ [])
View SourceUpdates the specified notification subscription in Amazon Security Lake for the organization you specify.
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.
update_subscriber_notification(client, subscriber_id, input, options \\ [])
View SourceUpdates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.