@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSecurityLakeClient extends AmazonWebServiceClient implements AmazonSecurityLake
Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms("Betas and Previews").
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 Servicesaccount. 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonSecurityLakeClientBuilder |
builder() |
CreateAwsLogSourceResult |
createAwsLogSource(CreateAwsLogSourceRequest request)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
|
CreateCustomLogSourceResult |
createCustomLogSource(CreateCustomLogSourceRequest request)
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 request)
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
|
CreateDatalakeAutoEnableResult |
createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest request)
Automatically enables Amazon Security Lake for new member accounts in your organization.
|
CreateDatalakeDelegatedAdminResult |
createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request)
Designates the Amazon Security Lake delegated administrator account for the organization.
|
CreateDatalakeExceptionsSubscriptionResult |
createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
CreateSubscriberResult |
createSubscriber(CreateSubscriberRequest request)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
|
CreateSubscriptionNotificationConfigurationResult |
createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request)
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 request)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
|
DeleteCustomLogSourceResult |
deleteCustomLogSource(DeleteCustomLogSourceRequest request)
Removes a custom log source from Amazon Security Lake.
|
DeleteDatalakeResult |
deleteDatalake(DeleteDatalakeRequest request)
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services
Regions.
|
DeleteDatalakeAutoEnableResult |
deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request)
Automatically deletes Amazon Security Lake to stop collecting security data.
|
DeleteDatalakeDelegatedAdminResult |
deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request)
Deletes the Amazon Security Lake delegated administrator account for the organization.
|
DeleteDatalakeExceptionsSubscriptionResult |
deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
DeleteSubscriberResult |
deleteSubscriber(DeleteSubscriberRequest request)
Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake.
|
DeleteSubscriptionNotificationConfigurationResult |
deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
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.
|
GetDatalakeResult |
getDatalake(GetDatalakeRequest request)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID.
|
GetDatalakeAutoEnableResult |
getDatalakeAutoEnable(GetDatalakeAutoEnableRequest request)
Retrieves the configuration that will be automatically set up for accounts added to the organization after the
organization has onboarded to Amazon Security Lake.
|
GetDatalakeExceptionsExpiryResult |
getDatalakeExceptionsExpiry(GetDatalakeExceptionsExpiryRequest request)
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain.
|
GetDatalakeExceptionsSubscriptionResult |
getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest request)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
|
GetDatalakeStatusResult |
getDatalakeStatus(GetDatalakeStatusRequest request)
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 request)
Retrieves the subscription information for the specified subscription ID.
|
ListDatalakeExceptionsResult |
listDatalakeExceptions(ListDatalakeExceptionsRequest request)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
ListLogSourcesResult |
listLogSources(ListLogSourcesRequest request)
Retrieves the log sources in the current Amazon Web Services Region.
|
ListSubscribersResult |
listSubscribers(ListSubscribersRequest request)
List all subscribers for the specific Amazon Security Lake account ID.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
UpdateDatalakeResult |
updateDatalake(UpdateDatalakeRequest request)
Specifies where to store your security data and for how long.
|
UpdateDatalakeExceptionsExpiryResult |
updateDatalakeExceptionsExpiry(UpdateDatalakeExceptionsExpiryRequest request)
Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL)
for the exception message to remain.
|
UpdateDatalakeExceptionsSubscriptionResult |
updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest request)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
UpdateSubscriberResult |
updateSubscriber(UpdateSubscriberRequest request)
Updates an existing subscription for the given Amazon Security Lake account ID.
|
UpdateSubscriptionNotificationConfigurationResult |
updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request)
Creates a new subscription notification or adds the existing subscription notification setting for the specified
subscription ID.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonSecurityLakeClientBuilder builder()
public CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest request)
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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.
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.
createAwsLogSource in interface AmazonSecurityLakecreateAwsLogSourceRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.S3Exception - Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a
request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is
incorrectly handling a request and you need to contact Amazon, this extended request ID may provide
useful debugging information.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest request)
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 to an associated Glue table and an Glue crawler.
createCustomLogSource in interface AmazonSecurityLakecreateCustomLogSourceRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ConflictSourceNamesException - There was a conflict when you attempted to modify a Security Lake source name.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.BucketNotFoundException - Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public CreateDatalakeResult createDatalake(CreateDatalakeRequest request)
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.
You can either use the enableAll parameter to specify all Regions or specify the Regions where you
want to enable Security Lake. To specify particular Regions, use the Regions parameter and then
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.
createDatalake in interface AmazonSecurityLakecreateDatalakeRequest - ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use Service Quotas to request a service quota increase.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.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ThrottlingException - The limit on the number of requests per second was exceeded.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.ResourceNotFoundException - The resource could not be found.public CreateDatalakeAutoEnableResult createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest request)
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.
createDatalakeAutoEnable in interface AmazonSecurityLakecreateDatalakeAutoEnableRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public CreateDatalakeDelegatedAdminResult createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request)
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.
createDatalakeDelegatedAdmin in interface AmazonSecurityLakecreateDatalakeDelegatedAdminRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ThrottlingException - The limit on the number of requests per second was exceeded.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.public CreateDatalakeExceptionsSubscriptionResult createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
createDatalakeExceptionsSubscription in interface AmazonSecurityLakecreateDatalakeExceptionsSubscriptionRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)
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.
createSubscriber in interface AmazonSecurityLakecreateSubscriberRequest - ConflictSubscriptionException - A conflicting subscription exception operation is in progress.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.BucketNotFoundException - Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public CreateSubscriptionNotificationConfigurationResult createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
createSubscriptionNotificationConfiguration in interface AmazonSecurityLakecreateSubscriptionNotificationConfigurationRequest - ConcurrentModificationException - More than one process tried to modify a resource at the same time.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest request)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.
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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.
When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.
deleteAwsLogSource in interface AmazonSecurityLakedeleteAwsLogSourceRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest request)
Removes a custom log source from Amazon Security Lake.
deleteCustomLogSource in interface AmazonSecurityLakedeleteCustomLogSourceRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ConflictSourceNamesException - There was a conflict when you attempted to modify a Security Lake source name.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.BucketNotFoundException - Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public DeleteDatalakeResult deleteDatalake(DeleteDatalakeRequest request)
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data
accessible to subscribers. Security Lake also deletes 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. The
DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web
Services account. For more information, see the Amazon Security Lake
User Guide.
deleteDatalake in interface AmazonSecurityLakedeleteDatalakeRequest - ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use Service Quotas to request a service quota increase.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.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ThrottlingException - The limit on the number of requests per second was exceeded.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.ResourceNotFoundException - The resource could not be found.public DeleteDatalakeAutoEnableResult deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request)
Automatically deletes Amazon Security Lake to stop collecting security data. When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data
accessible to subscribers. Security Lake also deletes 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. The
DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web
Services account. For more information, see the Amazon Security Lake
User Guide.
deleteDatalakeAutoEnable in interface AmazonSecurityLakedeleteDatalakeAutoEnableRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public DeleteDatalakeDelegatedAdminResult deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request)
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.
deleteDatalakeDelegatedAdmin in interface AmazonSecurityLakedeleteDatalakeDelegatedAdminRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.ThrottlingException - The limit on the number of requests per second was exceeded.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.public DeleteDatalakeExceptionsSubscriptionResult deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteDatalakeExceptionsSubscription in interface AmazonSecurityLakedeleteDatalakeExceptionsSubscriptionRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)
Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.
deleteSubscriber in interface AmazonSecurityLakedeleteSubscriberRequest - ConcurrentModificationException - More than one process tried to modify a resource at the same time.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.BucketNotFoundException - Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public DeleteSubscriptionNotificationConfigurationResult deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteSubscriptionNotificationConfiguration in interface AmazonSecurityLakedeleteSubscriptionNotificationConfigurationRequest - ConcurrentModificationException - More than one process tried to modify a resource at the same time.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public GetDatalakeResult getDatalake(GetDatalakeRequest request)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can
use the GetDatalake API to know whether Security Lake is enabled for the current Region. This API
does not take input parameters.
getDatalake in interface AmazonSecurityLakegetDatalakeRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public GetDatalakeAutoEnableResult getDatalakeAutoEnable(GetDatalakeAutoEnableRequest request)
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.
getDatalakeAutoEnable in interface AmazonSecurityLakegetDatalakeAutoEnableRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public GetDatalakeExceptionsExpiryResult getDatalakeExceptionsExpiry(GetDatalakeExceptionsExpiryRequest request)
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.
getDatalakeExceptionsExpiry in interface AmazonSecurityLakegetDatalakeExceptionsExpiryRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public GetDatalakeExceptionsSubscriptionResult getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest request)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
getDatalakeExceptionsSubscription in interface AmazonSecurityLakegetDatalakeExceptionsSubscriptionRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public GetDatalakeStatusResult getDatalakeStatus(GetDatalakeStatusRequest request)
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.
getDatalakeStatus in interface AmazonSecurityLakegetDatalakeStatusRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public GetSubscriberResult getSubscriber(GetSubscriberRequest request)
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
getSubscriber in interface AmazonSecurityLakegetSubscriberRequest - 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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public ListDatalakeExceptionsResult listDatalakeExceptions(ListDatalakeExceptionsRequest request)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
listDatalakeExceptions in interface AmazonSecurityLakelistDatalakeExceptionsRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public ListLogSourcesResult listLogSources(ListLogSourcesRequest request)
Retrieves the log sources in the current Amazon Web Services Region.
listLogSources in interface AmazonSecurityLakelistLogSourcesRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public ListSubscribersResult listSubscribers(ListSubscribersRequest request)
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.
listSubscribers in interface AmazonSecurityLakelistSubscribersRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public UpdateDatalakeResult updateDatalake(UpdateDatalakeRequest request)
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.
updateDatalake in interface AmazonSecurityLakeupdateDatalakeRequest - EventBridgeException - Represents an error interacting with the Amazon EventBridge service.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.public UpdateDatalakeExceptionsExpiryResult updateDatalakeExceptionsExpiry(UpdateDatalakeExceptionsExpiryRequest request)
Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.
updateDatalakeExceptionsExpiry in interface AmazonSecurityLakeupdateDatalakeExceptionsExpiryRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public UpdateDatalakeExceptionsSubscriptionResult updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest request)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
updateDatalakeExceptionsSubscription in interface AmazonSecurityLakeupdateDatalakeExceptionsSubscriptionRequest - InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)
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.
updateSubscriber in interface AmazonSecurityLakeupdateSubscriberRequest - ConflictSubscriptionException - A conflicting subscription exception operation is in progress.ConcurrentModificationException - More than one process tried to modify a resource at the same time.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public UpdateSubscriptionNotificationConfigurationResult updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request)
Creates a new subscription notification or adds the existing subscription notification setting for the specified subscription ID.
updateSubscriptionNotificationConfiguration in interface AmazonSecurityLakeupdateSubscriptionNotificationConfigurationRequest - ConcurrentModificationException - More than one process tried to modify a resource at the same time.InternalServerException - Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting,
perform the operation again.ValidationException - Your signing certificate could not be validated.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.ResourceNotFoundException - The resource could not be found.AccountNotFoundException - Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or
the account whose credentials you used to make this request isn't a member of an organization.InvalidInputException - The request was rejected because a value that's not valid or is out of range was supplied for an input
parameter.public 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 the request.
getCachedResponseMetadata in interface AmazonSecurityLakerequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonSecurityLakeshutdown in class AmazonWebServiceClient