Amazon Web Services, Inc.

Amazon Security Lake

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud,…

Identity & security#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 31

Data lake

  • POSTCreate aws log source/v1/datalake/logsources/awsAdds a natively supported Amazon Web Services service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web…
  • POSTCreate custom log source/v1/datalake/logsources/customAdds 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…
  • PUTUpdate data lake/v1/datalakeYou 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…
  • POSTCreate data lake/v1/datalakeInitializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with…
  • GETGet data lake organization configuration/v1/datalake/organization/configurationRetrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security…
  • POSTCreate data lake organization configuration/v1/datalake/organization/configurationAutomatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member…
  • POSTDelete aws log source/v1/datalake/logsources/aws/deleteRemoves 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…
  • DELETEDelete custom log source/v1/datalake/logsources/custom/:sourceName?sourceVersion=stringRemoves a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
  • POSTDelete data lake/v1/datalake/deleteWhen 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…
  • POSTDelete data lake organization configuration/v1/datalake/organization/configuration/deleteTurns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security…
  • POSTGet data lake sources/v1/datalake/sourcesRetrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting…
  • GETList data lakes/v1/datalakes?regions=Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether…
  • POSTList log sources/v1/datalake/logsources/listRetrieves the log sources.

Subscriber

  • GETList subscribers/v1/subscribers?nextToken=string&maxResults=0Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or…
  • POSTCreate subscriber/v1/subscribersCreates 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…
  • PUTUpdate subscriber notification/v1/subscribers/:subscriberId/notificationUpdates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
  • POSTCreate subscriber notification/v1/subscribers/:subscriberId/notificationNotifies 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…
  • DELETEDelete subscriber notification/v1/subscribers/:subscriberId/notificationDeletes the specified subscription notification in Amazon Security Lake for the organization you specify.
  • GETGet subscriber/v1/subscribers/:subscriberIdRetrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
  • PUTUpdate subscriber/v1/subscribers/:subscriberIdUpdates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber…
  • DELETEDelete subscriber/v1/subscribers/:subscriberIdDeletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber…
  • GETGet data lake exception subscription/v1/datalake/exceptions/subscriptionRetrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
  • PUTUpdate data lake exception subscription/v1/datalake/exceptions/subscriptionUpdates the specified notification subscription in Amazon Security Lake for the organization you specify.
  • POSTCreate data lake exception subscription/v1/datalake/exceptions/subscriptionCreates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for…
  • DELETEDelete data lake exception subscription/v1/datalake/exceptions/subscriptionDeletes the specified notification subscription in Amazon Security Lake for the organization you specify.
  • POSTRegister data lake delegated administrator/v1/datalake/delegateDesignates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account.…
  • DELETEDeregister data lake delegated administrator/v1/datalake/delegateDeletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The…
  • POSTList data lake exceptions/v1/datalake/exceptionsLists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
  • GETList tags for resource/v1/tags/:resourceArnRetrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon…
  • POSTTag resource/v1/tags/:resourceArnAdds 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…
  • DELETEUntag resource/v1/tags/:resourceArn?tagKeys=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…

API details

Base URL
https://securitylake.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
31 operations on 18 pathsPOST 15GET 6DELETE 6PUT 4
Main resources
Data lake 13Subscriber 8
Description format
AWS Smithy model, API version 2018-05-10

How to test the Amazon Security Lake in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Security Lake collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create aws log source” (POST /v1/datalake/logsources/aws), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Security Lake?

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud,… It is listed under Identity & security and has 31 endpoints.

Who publishes the Amazon Security Lake?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Security Lake?

Requests go to https://securitylake.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Security Lake?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Security Lake have?

31 operations on 18 paths (15 POST, 6 GET, 6 DELETE, 4 PUT). The largest groups are Data lake, Subscriber.

Is forking the Amazon Security Lake free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.