com.amazonaws.services.securitylake

Class AmazonSecurityLakeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.securitylake.AmazonSecurityLakeClient

All Implemented Interfaces:

AmazonSecurityLake

Direct Known Subclasses:

AmazonSecurityLakeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSecurityLakeClient
extends AmazonWebServiceClient
implements AmazonSecurityLake

Client for accessing Amazon Security Lake. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Security Lake is in preview release. Your use of the Amazon 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 account. Security Lake helps you analyze security data, so you can get a more complete understanding of your security posture across the entire organization and 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.

Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services. and third-party services and manages the lifecycle of data with customizable retention and replication settings. Security Lake also 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.securitylake.AmazonSecurityLake

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSecurityLakeClientBuilder	builder()
CreateAwsLogSourceResult	createAwsLogSource(CreateAwsLogSourceRequest request) Adds a natively-supported Amazon Web Services service as a Security Lake source.
CreateCustomLogSourceResult	createCustomLogSource(CreateCustomLogSourceRequest request) Adds a third-party custom source in Amazon Security Lake, from the 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 enable Security Lake in the specified Regions to begin ingesting security data.
CreateDatalakeDelegatedAdminResult	createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request) Designates the Security Lake administrator account for the organization.
CreateDatalakeExceptionsSubscriptionResult	createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request) Creates the specified notification subscription in Security Lake.
CreateSubscriberResult	createSubscriber(CreateSubscriberRequest request) Creates a subscription permission for accounts that are already enabled in Security Lake.
CreateSubscriptionNotificationConfigurationResult	createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request) Creates the specified notification subscription in Security Lake.
DeleteAwsLogSourceResult	deleteAwsLogSource(DeleteAwsLogSourceRequest request) Removes a natively-supported Amazon Web Services service as a Amazon Security Lake source.
DeleteCustomLogSourceResult	deleteCustomLogSource(DeleteCustomLogSourceRequest request) Removes a custom log source from Security Lake.
DeleteDatalakeResult	deleteDatalake(DeleteDatalakeRequest request) When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions.
DeleteDatalakeAutoEnableResult	deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request) Automatically delete Security Lake in the specified Regions to stop ingesting security data.
DeleteDatalakeDelegatedAdminResult	deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request) Deletes the Security Lake administrator account for the organization.
DeleteDatalakeExceptionsSubscriptionResult	deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request) Deletes the specified notification subscription in Security Lake.
DeleteSubscriberResult	deleteSubscriber(DeleteSubscriberRequest request) Deletes the specified subscription permissions to Security Lake.
DeleteSubscriptionNotificationConfigurationResult	deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request) Deletes the specified notification subscription in Security Lake.
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) Retrieve the Security Lake configuration object for the specified 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 on boarded 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) Retrieve the Security Lake configuration object for the specified account ID.
GetSubscriberResult	getSubscriber(GetSubscriberRequest request) Retrieves subscription information for the specified subscription ID.
ListDatalakeExceptionsResult	listDatalakeExceptions(ListDatalakeExceptionsRequest request) List the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
ListLogSourcesResult	listLogSources(ListLogSourcesRequest request) Lists the log sources in the current region.
ListSubscribersResult	listSubscribers(ListSubscribersRequest request) List all subscribers for the specific Security Lake account ID.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateDatalakeResult	updateDatalake(UpdateDatalakeRequest request) Amazon Security Lake allows you to specify 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) Update the subscription notification for exception notification.
UpdateSubscriberResult	updateSubscriber(UpdateSubscriberRequest request) Update the subscription permission for the given Security Lake account ID.
UpdateSubscriptionNotificationConfigurationResult	updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request) Create a new subscription notification or add the existing subscription notification setting for the specified subscription ID.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonSecurityLakeClientBuilder builder()

createAwsLogSource

public CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest request)

Adds a natively-supported Amazon Web Services service as a Security Lake source. Enables source types for member accounts in required Regions, based on specified parameters. You can choose any source type in any Region for accounts that are either part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, any combination of the three dimensions can be supplied to this API.

By default, 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 members is not specified, the API disables all Security Lake member accounts for sources. Similarly, when Regions are not specified, Security Lake is disabled for all the Regions where Security Lake is available as a service.

You can use this API only to enable a natively-supported Amazon Web Services services as a source. Use CreateCustomLogSource to enable data collection from a custom source.

Specified by:

createAwsLogSource in interface AmazonSecurityLake

Parameters:

createAwsLogSourceRequest -

Returns:

Result of the CreateAwsLogSource operation returned by the service.

Throws:

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 Amazon S3's extended request ID. This ID is required debugging information in the case the user needs to contact Amazon about an issue where Amazon S3 is incorrectly handling a request.

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 can't 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.

See Also:

AWS API Documentation

createCustomLogSource

public CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest request)

Adds a third-party custom source in Amazon Security Lake, from the 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 API roles, use this API to add a custom source name in Security Lake. This operation creates a partition in the Security Lake S3 bucket as the target location for log files from the custom source, an associated Glue table, and an Glue crawler.

Specified by:

createCustomLogSource in interface AmazonSecurityLake

Parameters:

createCustomLogSourceRequest -

Returns:

Result of the CreateCustomLogSource operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

createDatalake

public CreateDatalakeResult createDatalake(CreateDatalakeRequest request)

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Regions with customized settings in advance before enabling log collection in Regions. You can either use the enableAll parameter to specify all Regions or you can specify the Regions you want to enable Security Lake using the Regions parameter and configure these Regions using the configurations parameter. When the CreateDataLake API is called multiple times, if that Region is already enabled, it will update the Region if configuration for that Region is provided. If that Region is a new Region, it will be set up with the customized configurations if it is specified.

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 account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

Specified by:

createDatalake in interface AmazonSecurityLake

Parameters:

createDatalakeRequest -

Returns:

Result of the CreateDatalake operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDatalakeAutoEnable

public CreateDatalakeAutoEnableResult createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest request)

Automatically enable Security Lake in the specified Regions to begin ingesting security data. When you choose to enable organization accounts automatically, then Security Lake begins to enable new accounts as member accounts as they are added to the organization. Security Lake does not enable existing organization accounts that are not yet enabled.

Specified by:

createDatalakeAutoEnable in interface AmazonSecurityLake

Parameters:

createDatalakeAutoEnableRequest -

Returns:

Result of the CreateDatalakeAutoEnable operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

createDatalakeDelegatedAdmin

public CreateDatalakeDelegatedAdminResult createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request)

Designates the Security Lake 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.

Specified by:

createDatalakeDelegatedAdmin in interface AmazonSecurityLake

Parameters:

createDatalakeDelegatedAdminRequest -

Returns:

Result of the CreateDatalakeDelegatedAdmin operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDatalakeExceptionsSubscription

public CreateDatalakeExceptionsSubscriptionResult createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request)

Creates the specified notification subscription in Security Lake. Creates the specified subscription notifications in the specified organization.

Specified by:

createDatalakeExceptionsSubscription in interface AmazonSecurityLake

Parameters:

createDatalakeExceptionsSubscriptionRequest -

Returns:

Result of the CreateDatalakeExceptionsSubscription operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

createSubscriber

public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)

Creates a subscription permission for accounts that are already enabled in Security Lake.

Specified by:

createSubscriber in interface AmazonSecurityLake

Parameters:

createSubscriberRequest -

Returns:

Result of the CreateSubscriber operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

createSubscriptionNotificationConfiguration

public CreateSubscriptionNotificationConfigurationResult createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request)

Creates the specified notification subscription in Security Lake. Creates the specified subscription notifications from the specified organization.

Specified by:

createSubscriptionNotificationConfiguration in interface AmazonSecurityLake

Parameters:

createSubscriptionNotificationConfigurationRequest -

Returns:

Result of the CreateSubscriptionNotificationConfiguration operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

deleteAwsLogSource

public DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest request)

Removes a natively-supported Amazon Web Services service as a 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 Amazon Security Lake collected from the source before disablement.

You can choose any source type in any Region for accounts that are either part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, any combination of the three dimensions can be supplied to this API.

By default, dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when members is not specified, the API disables all Security Lake member accounts for sources. Similarly, when Regions are not specified, Security Lake is disabled for all the Regions where Security Lake is available as a service.

You can use this API to remove a natively-supported Amazon Web Services service as a source. Use DeregisterCustomData to remove a custom source.

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.

Specified by:

deleteAwsLogSource in interface AmazonSecurityLake

Parameters:

deleteAwsLogSourceRequest -

Returns:

Result of the DeleteAwsLogSource operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

deleteCustomLogSource

public DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest request)

Removes a custom log source from Security Lake.

Specified by:

deleteCustomLogSource in interface AmazonSecurityLake

Parameters:

deleteCustomLogSourceRequest -

Returns:

Result of the DeleteCustomLogSource operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

deleteDatalake

public DeleteDatalakeResult deleteDatalake(DeleteDatalakeRequest request)

When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically performs the off-boarding steps to off-board the account from Security Lake . This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your account in the current Region, including security log and event data. DeleteDatalake does not delete the S3 bucket which is owned by the Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

Specified by:

deleteDatalake in interface AmazonSecurityLake

Parameters:

deleteDatalakeRequest -

Returns:

Result of the DeleteDatalake operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDatalakeAutoEnable

public DeleteDatalakeAutoEnableResult deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request)

Automatically delete Security Lake in the specified Regions to stop ingesting security data. When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically performs the off-boarding steps to off-board the account from Security Lake . This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

Specified by:

deleteDatalakeAutoEnable in interface AmazonSecurityLake

Parameters:

deleteDatalakeAutoEnableRequest -

Returns:

Result of the DeleteDatalakeAutoEnable operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

deleteDatalakeDelegatedAdmin

public DeleteDatalakeDelegatedAdminResult deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request)

Deletes the Security Lake 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.

Specified by:

deleteDatalakeDelegatedAdmin in interface AmazonSecurityLake

Parameters:

deleteDatalakeDelegatedAdminRequest -

Returns:

Result of the DeleteDatalakeDelegatedAdmin operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDatalakeExceptionsSubscription

public DeleteDatalakeExceptionsSubscriptionResult deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request)

Deletes the specified notification subscription in Security Lake. Deletes the specified subscription notifications in the specified organization.

Specified by:

deleteDatalakeExceptionsSubscription in interface AmazonSecurityLake

Parameters:

deleteDatalakeExceptionsSubscriptionRequest -

Returns:

Result of the DeleteDatalakeExceptionsSubscription operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

deleteSubscriber

public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)

Deletes the specified subscription permissions to Security Lake. Deletes the specified subscription permissions from the specified organization.

Specified by:

deleteSubscriber in interface AmazonSecurityLake

Parameters:

deleteSubscriberRequest -

Returns:

Result of the DeleteSubscriber operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

deleteSubscriptionNotificationConfiguration

public DeleteSubscriptionNotificationConfigurationResult deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request)

Deletes the specified notification subscription in Security Lake. Deletes the specified subscription notifications from the specified organization.

Specified by:

deleteSubscriptionNotificationConfiguration in interface AmazonSecurityLake

Parameters:

deleteSubscriptionNotificationConfigurationRequest -

Returns:

Result of the DeleteSubscriptionNotificationConfiguration operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

getDatalake

public GetDatalakeResult getDatalake(GetDatalakeRequest request)

Retrieve the Security Lake configuration object for the specified account ID. This API does not take input parameters.

Specified by:

getDatalake in interface AmazonSecurityLake

Parameters:

getDatalakeRequest -

Returns:

Result of the GetDatalake operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

getDatalakeAutoEnable

public GetDatalakeAutoEnableResult getDatalakeAutoEnable(GetDatalakeAutoEnableRequest request)

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

Specified by:

getDatalakeAutoEnable in interface AmazonSecurityLake

Parameters:

getDatalakeAutoEnableRequest -

Returns:

Result of the GetDatalakeAutoEnable operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

getDatalakeExceptionsExpiry

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 a 2 week period of time from when a record was created in Security Lake. This API does not take input parameters. This API does not take input parameters.

Specified by:

getDatalakeExceptionsExpiry in interface AmazonSecurityLake

Parameters:

getDatalakeExceptionsExpiryRequest -

Returns:

Result of the GetDatalakeExceptionsExpiry operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

getDatalakeExceptionsSubscription

public GetDatalakeExceptionsSubscriptionResult getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest request)

Retrieves the details of exception notifications for the account in Amazon Security Lake.

Specified by:

getDatalakeExceptionsSubscription in interface AmazonSecurityLake

Parameters:

getDatalakeExceptionsSubscriptionRequest -

Returns:

Result of the GetDatalakeExceptionsSubscription operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

getDatalakeStatus

public GetDatalakeStatusResult getDatalakeStatus(GetDatalakeStatusRequest request)

Retrieve the Security Lake configuration object for the specified account ID. This API does not take input parameters.

Specified by:

getDatalakeStatus in interface AmazonSecurityLake

Parameters:

getDatalakeStatusRequest -

Returns:

Result of the GetDatalakeStatus operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

getSubscriber

public GetSubscriberResult getSubscriber(GetSubscriberRequest request)

Retrieves subscription information for the specified subscription ID.

Specified by:

getSubscriber in interface AmazonSecurityLake

Parameters:

getSubscriberRequest -

Returns:

Result of the GetSubscriber operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

listDatalakeExceptions

public ListDatalakeExceptionsResult listDatalakeExceptions(ListDatalakeExceptionsRequest request)

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

Specified by:

listDatalakeExceptions in interface AmazonSecurityLake

Parameters:

listDatalakeExceptionsRequest -

Returns:

Result of the ListDatalakeExceptions operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

listLogSources

public ListLogSourcesResult listLogSources(ListLogSourcesRequest request)

Lists the log sources in the current region.

Specified by:

listLogSources in interface AmazonSecurityLake

Parameters:

listLogSourcesRequest -

Returns:

Result of the ListLogSources operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

listSubscribers

public ListSubscribersResult listSubscribers(ListSubscribersRequest request)

List all subscribers for the specific Security Lake account ID.

Specified by:

listSubscribers in interface AmazonSecurityLake

Parameters:

listSubscribersRequest -

Returns:

Result of the ListSubscribers operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

updateDatalake

public UpdateDatalakeResult updateDatalake(UpdateDatalakeRequest request)

Amazon Security Lake allows you to specify where to store your security data and for how long. You can specify a rollup Region to consolidate data from multiple regions.

You can update the properties of a Region or source. Input can either be directly specified to the API.

Specified by:

updateDatalake in interface AmazonSecurityLake

Parameters:

updateDatalakeRequest -

Returns:

Result of the UpdateDatalake operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDatalakeExceptionsExpiry

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 a 2 week period of time from when a record was created in Security Lake.

Specified by:

updateDatalakeExceptionsExpiry in interface AmazonSecurityLake

Parameters:

updateDatalakeExceptionsExpiryRequest -

Returns:

Result of the UpdateDatalakeExceptionsExpiry operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

updateDatalakeExceptionsSubscription

public UpdateDatalakeExceptionsSubscriptionResult updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest request)

Update the subscription notification for exception notification.

Specified by:

updateDatalakeExceptionsSubscription in interface AmazonSecurityLake

Parameters:

updateDatalakeExceptionsSubscriptionRequest -

Returns:

Result of the UpdateDatalakeExceptionsSubscription operation returned by the service.

Throws:

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 can't 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.

See Also:

AWS API Documentation

updateSubscriber

public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)

Update the subscription permission for the given Security Lake account ID.

Specified by:

updateSubscriber in interface AmazonSecurityLake

Parameters:

updateSubscriberRequest -

Returns:

Result of the UpdateSubscriber operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

updateSubscriptionNotificationConfiguration

public UpdateSubscriptionNotificationConfigurationResult updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request)

Create a new subscription notification or add the existing subscription notification setting for the specified subscription ID.

Specified by:

updateSubscriptionNotificationConfiguration in interface AmazonSecurityLake

Parameters:

updateSubscriptionNotificationConfigurationRequest -

Returns:

Result of the UpdateSubscriptionNotificationConfiguration operation returned by the service.

Throws:

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 can't 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 an invalid or out-of-range value was supplied for an input parameter.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonSecurityLake

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonSecurityLake

Overrides:

shutdown in class AmazonWebServiceClient