@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 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.
|
public CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest request)
AmazonSecurityLake
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.
createAwsLogSource
in interface AmazonSecurityLake
public CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest request)
AmazonSecurityLake
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.
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 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.
createDatalake
in interface AmazonSecurityLake
public CreateDatalakeAutoEnableResult createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest request)
AmazonSecurityLake
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.
createDatalakeAutoEnable
in interface AmazonSecurityLake
public CreateDatalakeDelegatedAdminResult createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest request)
AmazonSecurityLake
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.
createDatalakeDelegatedAdmin
in interface AmazonSecurityLake
public CreateDatalakeExceptionsSubscriptionResult createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Creates the specified notification subscription in Security Lake. Creates the specified subscription notifications in the specified organization.
createDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)
AmazonSecurityLake
Creates a subscription permission for accounts that are already enabled in Security Lake.
createSubscriber
in interface AmazonSecurityLake
public CreateSubscriptionNotificationConfigurationResult createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Creates the specified notification subscription in Security Lake. Creates the specified subscription notifications from the specified organization.
createSubscriptionNotificationConfiguration
in interface AmazonSecurityLake
public DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest request)
AmazonSecurityLake
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.
deleteAwsLogSource
in interface AmazonSecurityLake
public DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest request)
AmazonSecurityLake
Removes a custom log source from 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 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.
deleteDatalake
in interface AmazonSecurityLake
public DeleteDatalakeAutoEnableResult deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest request)
AmazonSecurityLake
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.
deleteDatalakeAutoEnable
in interface AmazonSecurityLake
public DeleteDatalakeDelegatedAdminResult deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest request)
AmazonSecurityLake
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.
deleteDatalakeDelegatedAdmin
in interface AmazonSecurityLake
public DeleteDatalakeExceptionsSubscriptionResult deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Security Lake. Deletes the specified subscription notifications in the specified organization.
deleteDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)
AmazonSecurityLake
Deletes the specified subscription permissions to Security Lake. Deletes the specified subscription permissions from the specified organization.
deleteSubscriber
in interface AmazonSecurityLake
public DeleteSubscriptionNotificationConfigurationResult deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Security Lake. Deletes the specified subscription notifications from the specified organization.
deleteSubscriptionNotificationConfiguration
in interface AmazonSecurityLake
public GetDatalakeResult getDatalake(GetDatalakeRequest request)
AmazonSecurityLake
Retrieve the Security Lake configuration object for the specified account ID. 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 on boarded 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 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.
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
Retrieve the Security Lake configuration object for the specified account ID. This API does not take input parameters.
getDatalakeStatus
in interface AmazonSecurityLake
public GetSubscriberResult getSubscriber(GetSubscriberRequest request)
AmazonSecurityLake
Retrieves subscription information for the specified subscription ID.
getSubscriber
in interface AmazonSecurityLake
public ListDatalakeExceptionsResult listDatalakeExceptions(ListDatalakeExceptionsRequest request)
AmazonSecurityLake
List 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
Lists the log sources in the current region.
listLogSources
in interface AmazonSecurityLake
public ListSubscribersResult listSubscribers(ListSubscribersRequest request)
AmazonSecurityLake
List all subscribers for the specific Security Lake account ID.
listSubscribers
in interface AmazonSecurityLake
public UpdateDatalakeResult updateDatalake(UpdateDatalakeRequest request)
AmazonSecurityLake
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.
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 a 2 week period of time from when a record was created in Security Lake.
updateDatalakeExceptionsExpiry
in interface AmazonSecurityLake
public UpdateDatalakeExceptionsSubscriptionResult updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest request)
AmazonSecurityLake
Update the subscription notification for exception notification.
updateDatalakeExceptionsSubscription
in interface AmazonSecurityLake
public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)
AmazonSecurityLake
Update the subscription permission for the given Security Lake account ID.
updateSubscriber
in interface AmazonSecurityLake
public UpdateSubscriptionNotificationConfigurationResult updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest request)
AmazonSecurityLake
Create a new subscription notification or add the existing subscription notification setting for the specified subscription ID.
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.