@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSecurityLake
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSecurityLake instead.
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 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 and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAwsLogSourceResult |
createAwsLogSource(CreateAwsLogSourceRequest createAwsLogSourceRequest)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
|
CreateCustomLogSourceResult |
createCustomLogSource(CreateCustomLogSourceRequest createCustomLogSourceRequest)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to
create a custom source.
|
CreateDataLakeResult |
createDataLake(CreateDataLakeRequest createDataLakeRequest)
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
|
CreateDataLakeExceptionSubscriptionResult |
createDataLakeExceptionSubscription(CreateDataLakeExceptionSubscriptionRequest createDataLakeExceptionSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
CreateDataLakeOrganizationConfigurationResult |
createDataLakeOrganizationConfiguration(CreateDataLakeOrganizationConfigurationRequest createDataLakeOrganizationConfigurationRequest)
Automatically enables Amazon Security Lake for new member accounts in your organization.
|
CreateSubscriberResult |
createSubscriber(CreateSubscriberRequest createSubscriberRequest)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
|
CreateSubscriberNotificationResult |
createSubscriberNotification(CreateSubscriberNotificationRequest createSubscriberNotificationRequest)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in
Security Lake.
|
DeleteAwsLogSourceResult |
deleteAwsLogSource(DeleteAwsLogSourceRequest deleteAwsLogSourceRequest)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
|
DeleteCustomLogSourceResult |
deleteCustomLogSource(DeleteCustomLogSourceRequest deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security
Lake.
|
DeleteDataLakeResult |
deleteDataLake(DeleteDataLakeRequest deleteDataLakeRequest)
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.
|
DeleteDataLakeExceptionSubscriptionResult |
deleteDataLakeExceptionSubscription(DeleteDataLakeExceptionSubscriptionRequest deleteDataLakeExceptionSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
DeleteDataLakeOrganizationConfigurationResult |
deleteDataLakeOrganizationConfiguration(DeleteDataLakeOrganizationConfigurationRequest deleteDataLakeOrganizationConfigurationRequest)
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in
Organizations.
|
DeleteSubscriberResult |
deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon
Security Lake.
|
DeleteSubscriberNotificationResult |
deleteSubscriberNotification(DeleteSubscriberNotificationRequest deleteSubscriberNotificationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
DeregisterDataLakeDelegatedAdministratorResult |
deregisterDataLakeDelegatedAdministrator(DeregisterDataLakeDelegatedAdministratorRequest deregisterDataLakeDelegatedAdministratorRequest)
Deletes the Amazon Security Lake delegated administrator account for the organization.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataLakeExceptionSubscriptionResult |
getDataLakeExceptionSubscription(GetDataLakeExceptionSubscriptionRequest getDataLakeExceptionSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
|
GetDataLakeOrganizationConfigurationResult |
getDataLakeOrganizationConfiguration(GetDataLakeOrganizationConfigurationRequest getDataLakeOrganizationConfigurationRequest)
Retrieves the configuration that will be automatically set up for accounts added to the organization after the
organization has onboarded to Amazon Security Lake.
|
GetDataLakeSourcesResult |
getDataLakeSources(GetDataLakeSourcesRequest getDataLakeSourcesRequest)
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.
|
GetSubscriberResult |
getSubscriber(GetSubscriberRequest getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID.
|
ListDataLakeExceptionsResult |
listDataLakeExceptions(ListDataLakeExceptionsRequest listDataLakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
ListDataLakesResult |
listDataLakes(ListDataLakesRequest listDataLakesRequest)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
|
ListLogSourcesResult |
listLogSources(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
|
ListSubscribersResult |
listSubscribers(ListSubscribersRequest listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
|
RegisterDataLakeDelegatedAdministratorResult |
registerDataLakeDelegatedAdministrator(RegisterDataLakeDelegatedAdministratorRequest registerDataLakeDelegatedAdministratorRequest)
Designates the Amazon Security Lake delegated administrator account for the organization.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
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.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
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.
|
UpdateDataLakeResult |
updateDataLake(UpdateDataLakeRequest updateDataLakeRequest)
Specifies where to store your security data and for how long.
|
UpdateDataLakeExceptionSubscriptionResult |
updateDataLakeExceptionSubscription(UpdateDataLakeExceptionSubscriptionRequest updateDataLakeExceptionSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
UpdateSubscriberResult |
updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
Updates an existing subscription for the given Amazon Security Lake account ID.
|
UpdateSubscriberNotificationResult |
updateSubscriberNotification(UpdateSubscriberNotificationRequest updateSubscriberNotificationRequest)
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification
subscription endpoint for a subscriber.
|
static final String ENDPOINT_PREFIX
CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest createAwsLogSourceRequest)
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.
createAwsLogSourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest createCustomLogSourceRequest)
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.
createCustomLogSourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateDataLakeResult createDataLake(CreateDataLakeRequest createDataLakeRequest)
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.
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.
createDataLakeRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateDataLakeExceptionSubscriptionResult createDataLakeExceptionSubscription(CreateDataLakeExceptionSubscriptionRequest createDataLakeExceptionSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
createDataLakeExceptionSubscriptionRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateDataLakeOrganizationConfigurationResult createDataLakeOrganizationConfiguration(CreateDataLakeOrganizationConfigurationRequest createDataLakeOrganizationConfigurationRequest)
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.
createDataLakeOrganizationConfigurationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateSubscriberResult createSubscriber(CreateSubscriberRequest createSubscriberRequest)
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.
createSubscriberRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.CreateSubscriberNotificationResult createSubscriberNotification(CreateSubscriberNotificationRequest createSubscriberNotificationRequest)
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.
createSubscriberNotificationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest deleteAwsLogSourceRequest)
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.
deleteAwsLogSourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
deleteCustomLogSourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteDataLakeResult deleteDataLake(DeleteDataLakeRequest deleteDataLakeRequest)
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.
deleteDataLakeRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteDataLakeExceptionSubscriptionResult deleteDataLakeExceptionSubscription(DeleteDataLakeExceptionSubscriptionRequest deleteDataLakeExceptionSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteDataLakeExceptionSubscriptionRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteDataLakeOrganizationConfigurationResult deleteDataLakeOrganizationConfiguration(DeleteDataLakeOrganizationConfigurationRequest deleteDataLakeOrganizationConfigurationRequest)
Turns 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.
deleteDataLakeOrganizationConfigurationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
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.
deleteSubscriberRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeleteSubscriberNotificationResult deleteSubscriberNotification(DeleteSubscriberNotificationRequest deleteSubscriberNotificationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteSubscriberNotificationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.DeregisterDataLakeDelegatedAdministratorResult deregisterDataLakeDelegatedAdministrator(DeregisterDataLakeDelegatedAdministratorRequest deregisterDataLakeDelegatedAdministratorRequest)
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.
deregisterDataLakeDelegatedAdministratorRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.GetDataLakeExceptionSubscriptionResult getDataLakeExceptionSubscription(GetDataLakeExceptionSubscriptionRequest getDataLakeExceptionSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
getDataLakeExceptionSubscriptionRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.GetDataLakeOrganizationConfigurationResult getDataLakeOrganizationConfiguration(GetDataLakeOrganizationConfigurationRequest getDataLakeOrganizationConfigurationRequest)
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.
getDataLakeOrganizationConfigurationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.GetDataLakeSourcesResult getDataLakeSources(GetDataLakeSourcesRequest getDataLakeSourcesRequest)
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.
getDataLakeSourcesRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.GetSubscriberResult getSubscriber(GetSubscriberRequest getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
getSubscriberRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.ListDataLakeExceptionsResult listDataLakeExceptions(ListDataLakeExceptionsRequest listDataLakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
listDataLakeExceptionsRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.ListDataLakesResult listDataLakes(ListDataLakesRequest listDataLakesRequest)
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.
listDataLakesRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.ListLogSourcesResult listLogSources(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
listLogSourcesRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.ListSubscribersResult listSubscribers(ListSubscribersRequest listSubscribersRequest)
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.
listSubscribersRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.RegisterDataLakeDelegatedAdministratorResult registerDataLakeDelegatedAdministrator(RegisterDataLakeDelegatedAdministratorRequest registerDataLakeDelegatedAdministratorRequest)
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.
registerDataLakeDelegatedAdministratorRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.UpdateDataLakeResult updateDataLake(UpdateDataLakeRequest updateDataLakeRequest)
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.
updateDataLakeRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.UpdateDataLakeExceptionSubscriptionResult updateDataLakeExceptionSubscription(UpdateDataLakeExceptionSubscriptionRequest updateDataLakeExceptionSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
updateDataLakeExceptionSubscriptionRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
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.
updateSubscriberRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.UpdateSubscriberNotificationResult updateSubscriberNotification(UpdateSubscriberNotificationRequest updateSubscriberNotificationRequest)
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
updateSubscriberNotificationRequest - BadRequestException - The request is malformed or contains an error such as an invalid parameter value or a missing required
parameter.ResourceNotFoundException - The resource could not be found.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.AccessDeniedException - You do not have sufficient access to perform this action. Access denied errors appear when Amazon
Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a
policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs
when there is no applicable Deny statement and also no applicable Allow statement.ConflictException - Occurs when a conflict with a previous successful write is detected. This generally occurs when the
previous write did not have time to propagate to the host serving the current request. A retry (with
appropriate backoff logic) is the recommended response to this exception.ThrottlingException - The limit on the number of requests per second was exceeded.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.