@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSecurityLake extends Object implements AmazonSecurityLake
AmazonSecurityLake
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
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)
DeleteDatalakeAutoEnable removes automatic enablement of configuration settings for new member
accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. |
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)
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification
subscription endpoint for a subscriber.
|
public CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateDatalakeResult createDatalake(CreateDatalakeRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateDatalakeAutoEnableResult createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateDatalakeDelegatedAdminResult createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateDatalakeExceptionsSubscriptionResult createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
createDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public CreateSubscriptionNotificationConfigurationResult createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
createSubscriptionNotificationConfiguration
in interface AmazonSecurityLake
public DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest request)
AmazonSecurityLake
Removes a custom log source from Amazon Security Lake.
deleteCustomLogSource
in interface AmazonSecurityLake
public DeleteDatalakeResult deleteDatalake(DeleteDatalakeRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public DeleteDatalakeAutoEnableResult deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request)
AmazonSecurityLake
DeleteDatalakeAutoEnable
removes automatic enablement of configuration settings for new member
accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. You must run this API
using credentials of the delegated administrator. When you run this API, new member accounts that are added after
the organization enables Security Lake won't contribute to the data lake.
deleteDatalakeAutoEnable
in interface AmazonSecurityLake
public DeleteDatalakeDelegatedAdminResult deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public DeleteDatalakeExceptionsSubscriptionResult deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public DeleteSubscriptionNotificationConfigurationResult deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteSubscriptionNotificationConfiguration
in interface AmazonSecurityLake
public GetDatalakeResult getDatalake(GetDatalakeRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public GetDatalakeAutoEnableResult getDatalakeAutoEnable(GetDatalakeAutoEnableRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public GetDatalakeExceptionsExpiryResult getDatalakeExceptionsExpiry(GetDatalakeExceptionsExpiryRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public GetDatalakeExceptionsSubscriptionResult getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Retrieves the details of exception notifications for the account in Amazon Security Lake.
getDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public GetDatalakeStatusResult getDatalakeStatus(GetDatalakeStatusRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public GetSubscriberResult getSubscriber(GetSubscriberRequest request)
AmazonSecurityLake
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
getSubscriber
in interface AmazonSecurityLake
public ListDatalakeExceptionsResult listDatalakeExceptions(ListDatalakeExceptionsRequest request)
AmazonSecurityLake
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
listDatalakeExceptions
in interface AmazonSecurityLake
public ListLogSourcesResult listLogSources(ListLogSourcesRequest request)
AmazonSecurityLake
Retrieves the log sources in the current Amazon Web Services Region.
listLogSources
in interface AmazonSecurityLake
public ListSubscribersResult listSubscribers(ListSubscribersRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public UpdateDatalakeResult updateDatalake(UpdateDatalakeRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public UpdateDatalakeExceptionsExpiryResult updateDatalakeExceptionsExpiry(UpdateDatalakeExceptionsExpiryRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public UpdateDatalakeExceptionsSubscriptionResult updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
updateDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)
AmazonSecurityLake
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 AmazonSecurityLake
public UpdateSubscriptionNotificationConfigurationResult updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
updateSubscriptionNotificationConfiguration
in interface AmazonSecurityLake
public void shutdown()
AmazonSecurityLake
shutdown
in interface AmazonSecurityLake
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSecurityLake
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonSecurityLake
request
- The originally executed request.