@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SecurityLakeAsyncClient extends SdkClient
builder() method.
Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms("Betas and Previews").
Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SecurityLakeAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SecurityLakeAsyncClient. |
static SecurityLakeAsyncClient |
create()
Create a
SecurityLakeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAwsLogSourceResponse> |
createAwsLogSource(Consumer<CreateAwsLogSourceRequest.Builder> createAwsLogSourceRequest)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
|
default CompletableFuture<CreateAwsLogSourceResponse> |
createAwsLogSource(CreateAwsLogSourceRequest createAwsLogSourceRequest)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
|
default CompletableFuture<CreateCustomLogSourceResponse> |
createCustomLogSource(Consumer<CreateCustomLogSourceRequest.Builder> createCustomLogSourceRequest)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to
create a custom source.
|
default CompletableFuture<CreateCustomLogSourceResponse> |
createCustomLogSource(CreateCustomLogSourceRequest createCustomLogSourceRequest)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to
create a custom source.
|
default CompletableFuture<CreateDatalakeResponse> |
createDatalake(Consumer<CreateDatalakeRequest.Builder> createDatalakeRequest)
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
|
default CompletableFuture<CreateDatalakeResponse> |
createDatalake(CreateDatalakeRequest createDatalakeRequest)
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
|
default CompletableFuture<CreateDatalakeAutoEnableResponse> |
createDatalakeAutoEnable(Consumer<CreateDatalakeAutoEnableRequest.Builder> createDatalakeAutoEnableRequest)
Automatically enables Amazon Security Lake for new member accounts in your organization.
|
default CompletableFuture<CreateDatalakeAutoEnableResponse> |
createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest createDatalakeAutoEnableRequest)
Automatically enables Amazon Security Lake for new member accounts in your organization.
|
default CompletableFuture<CreateDatalakeDelegatedAdminResponse> |
createDatalakeDelegatedAdmin(Consumer<CreateDatalakeDelegatedAdminRequest.Builder> createDatalakeDelegatedAdminRequest)
Designates the Amazon Security Lake delegated administrator account for the organization.
|
default CompletableFuture<CreateDatalakeDelegatedAdminResponse> |
createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest createDatalakeDelegatedAdminRequest)
Designates the Amazon Security Lake delegated administrator account for the organization.
|
default CompletableFuture<CreateDatalakeExceptionsSubscriptionResponse> |
createDatalakeExceptionsSubscription(Consumer<CreateDatalakeExceptionsSubscriptionRequest.Builder> createDatalakeExceptionsSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<CreateDatalakeExceptionsSubscriptionResponse> |
createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest createDatalakeExceptionsSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<CreateSubscriberResponse> |
createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
|
default CompletableFuture<CreateSubscriberResponse> |
createSubscriber(CreateSubscriberRequest createSubscriberRequest)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
|
default CompletableFuture<CreateSubscriptionNotificationConfigurationResponse> |
createSubscriptionNotificationConfiguration(Consumer<CreateSubscriptionNotificationConfigurationRequest.Builder> createSubscriptionNotificationConfigurationRequest)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in
Security Lake.
|
default CompletableFuture<CreateSubscriptionNotificationConfigurationResponse> |
createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest createSubscriptionNotificationConfigurationRequest)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in
Security Lake.
|
default CompletableFuture<DeleteAwsLogSourceResponse> |
deleteAwsLogSource(Consumer<DeleteAwsLogSourceRequest.Builder> deleteAwsLogSourceRequest)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
|
default CompletableFuture<DeleteAwsLogSourceResponse> |
deleteAwsLogSource(DeleteAwsLogSourceRequest deleteAwsLogSourceRequest)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
|
default CompletableFuture<DeleteCustomLogSourceResponse> |
deleteCustomLogSource(Consumer<DeleteCustomLogSourceRequest.Builder> deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake.
|
default CompletableFuture<DeleteCustomLogSourceResponse> |
deleteCustomLogSource(DeleteCustomLogSourceRequest deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake.
|
default CompletableFuture<DeleteDatalakeResponse> |
deleteDatalake(Consumer<DeleteDatalakeRequest.Builder> deleteDatalakeRequest)
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services
Regions.
|
default CompletableFuture<DeleteDatalakeResponse> |
deleteDatalake(DeleteDatalakeRequest deleteDatalakeRequest)
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services
Regions.
|
default CompletableFuture<DeleteDatalakeAutoEnableResponse> |
deleteDatalakeAutoEnable(Consumer<DeleteDatalakeAutoEnableRequest.Builder> deleteDatalakeAutoEnableRequest)
Automatically deletes Amazon Security Lake to stop collecting security data.
|
default CompletableFuture<DeleteDatalakeAutoEnableResponse> |
deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest deleteDatalakeAutoEnableRequest)
Automatically deletes Amazon Security Lake to stop collecting security data.
|
default CompletableFuture<DeleteDatalakeDelegatedAdminResponse> |
deleteDatalakeDelegatedAdmin(Consumer<DeleteDatalakeDelegatedAdminRequest.Builder> deleteDatalakeDelegatedAdminRequest)
Deletes the Amazon Security Lake delegated administrator account for the organization.
|
default CompletableFuture<DeleteDatalakeDelegatedAdminResponse> |
deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest deleteDatalakeDelegatedAdminRequest)
Deletes the Amazon Security Lake delegated administrator account for the organization.
|
default CompletableFuture<DeleteDatalakeExceptionsSubscriptionResponse> |
deleteDatalakeExceptionsSubscription(Consumer<DeleteDatalakeExceptionsSubscriptionRequest.Builder> deleteDatalakeExceptionsSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<DeleteDatalakeExceptionsSubscriptionResponse> |
deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest deleteDatalakeExceptionsSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<DeleteSubscriberResponse> |
deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest)
Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake.
|
default CompletableFuture<DeleteSubscriberResponse> |
deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake.
|
default CompletableFuture<DeleteSubscriptionNotificationConfigurationResponse> |
deleteSubscriptionNotificationConfiguration(Consumer<DeleteSubscriptionNotificationConfigurationRequest.Builder> deleteSubscriptionNotificationConfigurationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<DeleteSubscriptionNotificationConfigurationResponse> |
deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest deleteSubscriptionNotificationConfigurationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<GetDatalakeResponse> |
getDatalake(Consumer<GetDatalakeRequest.Builder> getDatalakeRequest)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID.
|
default CompletableFuture<GetDatalakeResponse> |
getDatalake(GetDatalakeRequest getDatalakeRequest)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID.
|
default CompletableFuture<GetDatalakeAutoEnableResponse> |
getDatalakeAutoEnable(Consumer<GetDatalakeAutoEnableRequest.Builder> getDatalakeAutoEnableRequest)
Retrieves the configuration that will be automatically set up for accounts added to the organization after the
organization has onboarded to Amazon Security Lake.
|
default CompletableFuture<GetDatalakeAutoEnableResponse> |
getDatalakeAutoEnable(GetDatalakeAutoEnableRequest getDatalakeAutoEnableRequest)
Retrieves the configuration that will be automatically set up for accounts added to the organization after the
organization has onboarded to Amazon Security Lake.
|
default CompletableFuture<GetDatalakeExceptionsExpiryResponse> |
getDatalakeExceptionsExpiry(Consumer<GetDatalakeExceptionsExpiryRequest.Builder> getDatalakeExceptionsExpiryRequest)
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain.
|
default CompletableFuture<GetDatalakeExceptionsExpiryResponse> |
getDatalakeExceptionsExpiry(GetDatalakeExceptionsExpiryRequest getDatalakeExceptionsExpiryRequest)
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain.
|
default CompletableFuture<GetDatalakeExceptionsSubscriptionResponse> |
getDatalakeExceptionsSubscription(Consumer<GetDatalakeExceptionsSubscriptionRequest.Builder> getDatalakeExceptionsSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
|
default CompletableFuture<GetDatalakeExceptionsSubscriptionResponse> |
getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest getDatalakeExceptionsSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
|
default CompletableFuture<GetDatalakeStatusResponse> |
getDatalakeStatus(Consumer<GetDatalakeStatusRequest.Builder> getDatalakeStatusRequest)
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.
|
default CompletableFuture<GetDatalakeStatusResponse> |
getDatalakeStatus(GetDatalakeStatusRequest getDatalakeStatusRequest)
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.
|
default GetDatalakeStatusPublisher |
getDatalakeStatusPaginator(Consumer<GetDatalakeStatusRequest.Builder> getDatalakeStatusRequest)
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.
|
default GetDatalakeStatusPublisher |
getDatalakeStatusPaginator(GetDatalakeStatusRequest getDatalakeStatusRequest)
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.
|
default CompletableFuture<GetSubscriberResponse> |
getSubscriber(Consumer<GetSubscriberRequest.Builder> getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID.
|
default CompletableFuture<GetSubscriberResponse> |
getSubscriber(GetSubscriberRequest getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID.
|
default CompletableFuture<ListDatalakeExceptionsResponse> |
listDatalakeExceptions(Consumer<ListDatalakeExceptionsRequest.Builder> listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
default CompletableFuture<ListDatalakeExceptionsResponse> |
listDatalakeExceptions(ListDatalakeExceptionsRequest listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
default ListDatalakeExceptionsPublisher |
listDatalakeExceptionsPaginator(Consumer<ListDatalakeExceptionsRequest.Builder> listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
default ListDatalakeExceptionsPublisher |
listDatalakeExceptionsPaginator(ListDatalakeExceptionsRequest listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
default CompletableFuture<ListLogSourcesResponse> |
listLogSources(Consumer<ListLogSourcesRequest.Builder> listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
|
default CompletableFuture<ListLogSourcesResponse> |
listLogSources(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
|
default ListLogSourcesPublisher |
listLogSourcesPaginator(Consumer<ListLogSourcesRequest.Builder> listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
|
default ListLogSourcesPublisher |
listLogSourcesPaginator(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
|
default CompletableFuture<ListSubscribersResponse> |
listSubscribers(Consumer<ListSubscribersRequest.Builder> listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID.
|
default CompletableFuture<ListSubscribersResponse> |
listSubscribers(ListSubscribersRequest listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID.
|
default ListSubscribersPublisher |
listSubscribersPaginator(Consumer<ListSubscribersRequest.Builder> listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID.
|
default ListSubscribersPublisher |
listSubscribersPaginator(ListSubscribersRequest listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID.
|
default CompletableFuture<UpdateDatalakeResponse> |
updateDatalake(Consumer<UpdateDatalakeRequest.Builder> updateDatalakeRequest)
Specifies where to store your security data and for how long.
|
default CompletableFuture<UpdateDatalakeResponse> |
updateDatalake(UpdateDatalakeRequest updateDatalakeRequest)
Specifies where to store your security data and for how long.
|
default CompletableFuture<UpdateDatalakeExceptionsExpiryResponse> |
updateDatalakeExceptionsExpiry(Consumer<UpdateDatalakeExceptionsExpiryRequest.Builder> updateDatalakeExceptionsExpiryRequest)
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.
|
default CompletableFuture<UpdateDatalakeExceptionsExpiryResponse> |
updateDatalakeExceptionsExpiry(UpdateDatalakeExceptionsExpiryRequest updateDatalakeExceptionsExpiryRequest)
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.
|
default CompletableFuture<UpdateDatalakeExceptionsSubscriptionResponse> |
updateDatalakeExceptionsSubscription(Consumer<UpdateDatalakeExceptionsSubscriptionRequest.Builder> updateDatalakeExceptionsSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<UpdateDatalakeExceptionsSubscriptionResponse> |
updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest updateDatalakeExceptionsSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
default CompletableFuture<UpdateSubscriberResponse> |
updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest)
Updates an existing subscription for the given Amazon Security Lake account ID.
|
default CompletableFuture<UpdateSubscriberResponse> |
updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
Updates an existing subscription for the given Amazon Security Lake account ID.
|
default CompletableFuture<UpdateSubscriptionNotificationConfigurationResponse> |
updateSubscriptionNotificationConfiguration(Consumer<UpdateSubscriptionNotificationConfigurationRequest.Builder> updateSubscriptionNotificationConfigurationRequest)
Creates a new subscription notification or adds the existing subscription notification setting for the specified
subscription ID.
|
default CompletableFuture<UpdateSubscriptionNotificationConfigurationResponse> |
updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest updateSubscriptionNotificationConfigurationRequest)
Creates a new subscription notification or adds the existing subscription notification setting for the specified
subscription ID.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SecurityLakeAsyncClient create()
SecurityLakeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SecurityLakeAsyncClientBuilder builder()
SecurityLakeAsyncClient.default CompletableFuture<CreateAwsLogSourceResponse> createAwsLogSource(CreateAwsLogSourceRequest createAwsLogSourceRequest)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. 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.
createAwsLogSourceRequest - default CompletableFuture<CreateAwsLogSourceResponse> createAwsLogSource(Consumer<CreateAwsLogSourceRequest.Builder> createAwsLogSourceRequest)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. 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.
This is a convenience which creates an instance of the CreateAwsLogSourceRequest.Builder avoiding the
need to create one manually via CreateAwsLogSourceRequest.builder()
createAwsLogSourceRequest - A Consumer that will call methods on CreateAwsLogSourceRequest.Builder to create a
request.default CompletableFuture<CreateCustomLogSourceResponse> createCustomLogSource(CreateCustomLogSourceRequest createCustomLogSourceRequest)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source in addition to an associated Glue table and an Glue crawler.
createCustomLogSourceRequest - default CompletableFuture<CreateCustomLogSourceResponse> createCustomLogSource(Consumer<CreateCustomLogSourceRequest.Builder> createCustomLogSourceRequest)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source in addition to an associated Glue table and an Glue crawler.
This is a convenience which creates an instance of the CreateCustomLogSourceRequest.Builder avoiding the
need to create one manually via CreateCustomLogSourceRequest.builder()
createCustomLogSourceRequest - A Consumer that will call methods on CreateCustomLogSourceRequest.Builder to create a
request.default CompletableFuture<CreateDatalakeResponse> createDatalake(CreateDatalakeRequest createDatalakeRequest)
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable
Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions.
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.
createDatalakeRequest - default CompletableFuture<CreateDatalakeResponse> createDatalake(Consumer<CreateDatalakeRequest.Builder> createDatalakeRequest)
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable
Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions.
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.
This is a convenience which creates an instance of the CreateDatalakeRequest.Builder avoiding the need to
create one manually via CreateDatalakeRequest.builder()
createDatalakeRequest - A Consumer that will call methods on CreateDatalakeRequest.Builder to create a request.default CompletableFuture<CreateDatalakeAutoEnableResponse> createDatalakeAutoEnable(CreateDatalakeAutoEnableRequest createDatalakeAutoEnableRequest)
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.
createDatalakeAutoEnableRequest - default CompletableFuture<CreateDatalakeAutoEnableResponse> createDatalakeAutoEnable(Consumer<CreateDatalakeAutoEnableRequest.Builder> createDatalakeAutoEnableRequest)
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.
This is a convenience which creates an instance of the CreateDatalakeAutoEnableRequest.Builder avoiding
the need to create one manually via CreateDatalakeAutoEnableRequest.builder()
createDatalakeAutoEnableRequest - A Consumer that will call methods on CreateDatalakeAutoEnableRequest.Builder to create a
request.default CompletableFuture<CreateDatalakeDelegatedAdminResponse> createDatalakeDelegatedAdmin(CreateDatalakeDelegatedAdminRequest createDatalakeDelegatedAdminRequest)
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.
createDatalakeDelegatedAdminRequest - default CompletableFuture<CreateDatalakeDelegatedAdminResponse> createDatalakeDelegatedAdmin(Consumer<CreateDatalakeDelegatedAdminRequest.Builder> createDatalakeDelegatedAdminRequest)
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.
This is a convenience which creates an instance of the CreateDatalakeDelegatedAdminRequest.Builder
avoiding the need to create one manually via CreateDatalakeDelegatedAdminRequest.builder()
createDatalakeDelegatedAdminRequest - A Consumer that will call methods on CreateDatalakeDelegatedAdminRequest.Builder to create
a request.default CompletableFuture<CreateDatalakeExceptionsSubscriptionResponse> createDatalakeExceptionsSubscription(CreateDatalakeExceptionsSubscriptionRequest createDatalakeExceptionsSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
createDatalakeExceptionsSubscriptionRequest - default CompletableFuture<CreateDatalakeExceptionsSubscriptionResponse> createDatalakeExceptionsSubscription(Consumer<CreateDatalakeExceptionsSubscriptionRequest.Builder> createDatalakeExceptionsSubscriptionRequest)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
This is a convenience which creates an instance of the
CreateDatalakeExceptionsSubscriptionRequest.Builder avoiding the need to create one manually via
CreateDatalakeExceptionsSubscriptionRequest.builder()
createDatalakeExceptionsSubscriptionRequest - A Consumer that will call methods on CreateDatalakeExceptionsSubscriptionRequest.Builder
to create a request.default CompletableFuture<CreateSubscriberResponse> createSubscriber(CreateSubscriberRequest createSubscriberRequest)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
createSubscriberRequest - default CompletableFuture<CreateSubscriberResponse> createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
This is a convenience which creates an instance of the CreateSubscriberRequest.Builder avoiding the need
to create one manually via CreateSubscriberRequest.builder()
createSubscriberRequest - A Consumer that will call methods on CreateSubscriberRequest.Builder to create a request.default CompletableFuture<CreateSubscriptionNotificationConfigurationResponse> createSubscriptionNotificationConfiguration(CreateSubscriptionNotificationConfigurationRequest createSubscriptionNotificationConfigurationRequest)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
createSubscriptionNotificationConfigurationRequest - default CompletableFuture<CreateSubscriptionNotificationConfigurationResponse> createSubscriptionNotificationConfiguration(Consumer<CreateSubscriptionNotificationConfigurationRequest.Builder> createSubscriptionNotificationConfigurationRequest)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
This is a convenience which creates an instance of the
CreateSubscriptionNotificationConfigurationRequest.Builder avoiding the need to create one manually via
CreateSubscriptionNotificationConfigurationRequest.builder()
createSubscriptionNotificationConfigurationRequest - A Consumer that will call methods on
CreateSubscriptionNotificationConfigurationRequest.Builder to create a request.default CompletableFuture<DeleteAwsLogSourceResponse> deleteAwsLogSource(DeleteAwsLogSourceRequest deleteAwsLogSourceRequest)
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.
deleteAwsLogSourceRequest - default CompletableFuture<DeleteAwsLogSourceResponse> deleteAwsLogSource(Consumer<DeleteAwsLogSourceRequest.Builder> deleteAwsLogSourceRequest)
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.
This is a convenience which creates an instance of the DeleteAwsLogSourceRequest.Builder avoiding the
need to create one manually via DeleteAwsLogSourceRequest.builder()
deleteAwsLogSourceRequest - A Consumer that will call methods on DeleteAwsLogSourceRequest.Builder to create a
request.default CompletableFuture<DeleteCustomLogSourceResponse> deleteCustomLogSource(DeleteCustomLogSourceRequest deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake.
deleteCustomLogSourceRequest - default CompletableFuture<DeleteCustomLogSourceResponse> deleteCustomLogSource(Consumer<DeleteCustomLogSourceRequest.Builder> deleteCustomLogSourceRequest)
Removes a custom log source from Amazon Security Lake.
This is a convenience which creates an instance of the DeleteCustomLogSourceRequest.Builder avoiding the
need to create one manually via DeleteCustomLogSourceRequest.builder()
deleteCustomLogSourceRequest - A Consumer that will call methods on DeleteCustomLogSourceRequest.Builder to create a
request.default CompletableFuture<DeleteDatalakeResponse> deleteDatalake(DeleteDatalakeRequest deleteDatalakeRequest)
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.
deleteDatalakeRequest - default CompletableFuture<DeleteDatalakeResponse> deleteDatalake(Consumer<DeleteDatalakeRequest.Builder> deleteDatalakeRequest)
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.
This is a convenience which creates an instance of the DeleteDatalakeRequest.Builder avoiding the need to
create one manually via DeleteDatalakeRequest.builder()
deleteDatalakeRequest - A Consumer that will call methods on DeleteDatalakeRequest.Builder to create a request.default CompletableFuture<DeleteDatalakeAutoEnableResponse> deleteDatalakeAutoEnable(DeleteDatalakeAutoEnableRequest deleteDatalakeAutoEnableRequest)
Automatically deletes Amazon Security Lake to stop collecting security data. When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data
accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or
maintains for your Amazon Web Services account in the current Region, including security log and event data. The
DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web
Services account. For more information, see the Amazon Security Lake
User Guide.
deleteDatalakeAutoEnableRequest - default CompletableFuture<DeleteDatalakeAutoEnableResponse> deleteDatalakeAutoEnable(Consumer<DeleteDatalakeAutoEnableRequest.Builder> deleteDatalakeAutoEnableRequest)
Automatically deletes Amazon Security Lake to stop collecting security data. When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data
accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or
maintains for your Amazon Web Services account in the current Region, including security log and event data. The
DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web
Services account. For more information, see the Amazon Security Lake
User Guide.
This is a convenience which creates an instance of the DeleteDatalakeAutoEnableRequest.Builder avoiding
the need to create one manually via DeleteDatalakeAutoEnableRequest.builder()
deleteDatalakeAutoEnableRequest - A Consumer that will call methods on DeleteDatalakeAutoEnableRequest.Builder to create a
request.default CompletableFuture<DeleteDatalakeDelegatedAdminResponse> deleteDatalakeDelegatedAdmin(DeleteDatalakeDelegatedAdminRequest deleteDatalakeDelegatedAdminRequest)
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.
deleteDatalakeDelegatedAdminRequest - default CompletableFuture<DeleteDatalakeDelegatedAdminResponse> deleteDatalakeDelegatedAdmin(Consumer<DeleteDatalakeDelegatedAdminRequest.Builder> deleteDatalakeDelegatedAdminRequest)
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.
This is a convenience which creates an instance of the DeleteDatalakeDelegatedAdminRequest.Builder
avoiding the need to create one manually via DeleteDatalakeDelegatedAdminRequest.builder()
deleteDatalakeDelegatedAdminRequest - A Consumer that will call methods on DeleteDatalakeDelegatedAdminRequest.Builder to create
a request.default CompletableFuture<DeleteDatalakeExceptionsSubscriptionResponse> deleteDatalakeExceptionsSubscription(DeleteDatalakeExceptionsSubscriptionRequest deleteDatalakeExceptionsSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteDatalakeExceptionsSubscriptionRequest - default CompletableFuture<DeleteDatalakeExceptionsSubscriptionResponse> deleteDatalakeExceptionsSubscription(Consumer<DeleteDatalakeExceptionsSubscriptionRequest.Builder> deleteDatalakeExceptionsSubscriptionRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
This is a convenience which creates an instance of the
DeleteDatalakeExceptionsSubscriptionRequest.Builder avoiding the need to create one manually via
DeleteDatalakeExceptionsSubscriptionRequest.builder()
deleteDatalakeExceptionsSubscriptionRequest - A Consumer that will call methods on DeleteDatalakeExceptionsSubscriptionRequest.Builder
to create a request.default CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
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.
deleteSubscriberRequest - default CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest)
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.
This is a convenience which creates an instance of the DeleteSubscriberRequest.Builder avoiding the need
to create one manually via DeleteSubscriberRequest.builder()
deleteSubscriberRequest - A Consumer that will call methods on DeleteSubscriberRequest.Builder to create a request.default CompletableFuture<DeleteSubscriptionNotificationConfigurationResponse> deleteSubscriptionNotificationConfiguration(DeleteSubscriptionNotificationConfigurationRequest deleteSubscriptionNotificationConfigurationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteSubscriptionNotificationConfigurationRequest - default CompletableFuture<DeleteSubscriptionNotificationConfigurationResponse> deleteSubscriptionNotificationConfiguration(Consumer<DeleteSubscriptionNotificationConfigurationRequest.Builder> deleteSubscriptionNotificationConfigurationRequest)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
This is a convenience which creates an instance of the
DeleteSubscriptionNotificationConfigurationRequest.Builder avoiding the need to create one manually via
DeleteSubscriptionNotificationConfigurationRequest.builder()
deleteSubscriptionNotificationConfigurationRequest - A Consumer that will call methods on
DeleteSubscriptionNotificationConfigurationRequest.Builder to create a request.default CompletableFuture<GetDatalakeResponse> getDatalake(GetDatalakeRequest getDatalakeRequest)
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.
getDatalakeRequest - default CompletableFuture<GetDatalakeResponse> getDatalake(Consumer<GetDatalakeRequest.Builder> getDatalakeRequest)
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.
This is a convenience which creates an instance of the GetDatalakeRequest.Builder avoiding the need to
create one manually via GetDatalakeRequest.builder()
getDatalakeRequest - A Consumer that will call methods on GetDatalakeRequest.Builder to create a request.default CompletableFuture<GetDatalakeAutoEnableResponse> getDatalakeAutoEnable(GetDatalakeAutoEnableRequest getDatalakeAutoEnableRequest)
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.
getDatalakeAutoEnableRequest - default CompletableFuture<GetDatalakeAutoEnableResponse> getDatalakeAutoEnable(Consumer<GetDatalakeAutoEnableRequest.Builder> getDatalakeAutoEnableRequest)
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.
This is a convenience which creates an instance of the GetDatalakeAutoEnableRequest.Builder avoiding the
need to create one manually via GetDatalakeAutoEnableRequest.builder()
getDatalakeAutoEnableRequest - A Consumer that will call methods on GetDatalakeAutoEnableRequest.Builder to create a
request.default CompletableFuture<GetDatalakeExceptionsExpiryResponse> getDatalakeExceptionsExpiry(GetDatalakeExceptionsExpiryRequest getDatalakeExceptionsExpiryRequest)
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.
getDatalakeExceptionsExpiryRequest - default CompletableFuture<GetDatalakeExceptionsExpiryResponse> getDatalakeExceptionsExpiry(Consumer<GetDatalakeExceptionsExpiryRequest.Builder> getDatalakeExceptionsExpiryRequest)
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.
This is a convenience which creates an instance of the GetDatalakeExceptionsExpiryRequest.Builder
avoiding the need to create one manually via GetDatalakeExceptionsExpiryRequest.builder()
getDatalakeExceptionsExpiryRequest - A Consumer that will call methods on GetDatalakeExceptionsExpiryRequest.Builder to create
a request.default CompletableFuture<GetDatalakeExceptionsSubscriptionResponse> getDatalakeExceptionsSubscription(GetDatalakeExceptionsSubscriptionRequest getDatalakeExceptionsSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
getDatalakeExceptionsSubscriptionRequest - default CompletableFuture<GetDatalakeExceptionsSubscriptionResponse> getDatalakeExceptionsSubscription(Consumer<GetDatalakeExceptionsSubscriptionRequest.Builder> getDatalakeExceptionsSubscriptionRequest)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
This is a convenience which creates an instance of the GetDatalakeExceptionsSubscriptionRequest.Builder
avoiding the need to create one manually via GetDatalakeExceptionsSubscriptionRequest.builder()
getDatalakeExceptionsSubscriptionRequest - A Consumer that will call methods on GetDatalakeExceptionsSubscriptionRequest.Builder to
create a request.default CompletableFuture<GetDatalakeStatusResponse> getDatalakeStatus(GetDatalakeStatusRequest getDatalakeStatusRequest)
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.
getDatalakeStatusRequest - default CompletableFuture<GetDatalakeStatusResponse> getDatalakeStatus(Consumer<GetDatalakeStatusRequest.Builder> getDatalakeStatusRequest)
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.
This is a convenience which creates an instance of the GetDatalakeStatusRequest.Builder avoiding the need
to create one manually via GetDatalakeStatusRequest.builder()
getDatalakeStatusRequest - A Consumer that will call methods on GetDatalakeStatusRequest.Builder to create a request.default GetDatalakeStatusPublisher getDatalakeStatusPaginator(GetDatalakeStatusRequest getDatalakeStatusRequest)
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.
This is a variant of
getDatalakeStatus(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.GetDatalakeStatusPublisher publisher = client.getDatalakeStatusPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.GetDatalakeStatusPublisher publisher = client.getDatalakeStatusPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxAccountResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDatalakeStatus(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusRequest)
operation.
getDatalakeStatusRequest - default GetDatalakeStatusPublisher getDatalakeStatusPaginator(Consumer<GetDatalakeStatusRequest.Builder> getDatalakeStatusRequest)
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.
This is a variant of
getDatalakeStatus(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.GetDatalakeStatusPublisher publisher = client.getDatalakeStatusPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.GetDatalakeStatusPublisher publisher = client.getDatalakeStatusPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxAccountResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDatalakeStatus(software.amazon.awssdk.services.securitylake.model.GetDatalakeStatusRequest)
operation.
This is a convenience which creates an instance of the GetDatalakeStatusRequest.Builder avoiding the need
to create one manually via GetDatalakeStatusRequest.builder()
getDatalakeStatusRequest - A Consumer that will call methods on GetDatalakeStatusRequest.Builder to create a request.default CompletableFuture<GetSubscriberResponse> getSubscriber(GetSubscriberRequest getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
getSubscriberRequest - default CompletableFuture<GetSubscriberResponse> getSubscriber(Consumer<GetSubscriberRequest.Builder> getSubscriberRequest)
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
This is a convenience which creates an instance of the GetSubscriberRequest.Builder avoiding the need to
create one manually via GetSubscriberRequest.builder()
getSubscriberRequest - A Consumer that will call methods on GetSubscriberRequest.Builder to create a request.default CompletableFuture<ListDatalakeExceptionsResponse> listDatalakeExceptions(ListDatalakeExceptionsRequest listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
listDatalakeExceptionsRequest - default CompletableFuture<ListDatalakeExceptionsResponse> listDatalakeExceptions(Consumer<ListDatalakeExceptionsRequest.Builder> listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
This is a convenience which creates an instance of the ListDatalakeExceptionsRequest.Builder avoiding the
need to create one manually via ListDatalakeExceptionsRequest.builder()
listDatalakeExceptionsRequest - A Consumer that will call methods on ListDatalakeExceptionsRequest.Builder to create a
request.default ListDatalakeExceptionsPublisher listDatalakeExceptionsPaginator(ListDatalakeExceptionsRequest listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
This is a variant of
listDatalakeExceptions(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListDatalakeExceptionsPublisher publisher = client.listDatalakeExceptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListDatalakeExceptionsPublisher publisher = client.listDatalakeExceptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxFailures won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatalakeExceptions(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsRequest)
operation.
listDatalakeExceptionsRequest - default ListDatalakeExceptionsPublisher listDatalakeExceptionsPaginator(Consumer<ListDatalakeExceptionsRequest.Builder> listDatalakeExceptionsRequest)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
This is a variant of
listDatalakeExceptions(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListDatalakeExceptionsPublisher publisher = client.listDatalakeExceptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListDatalakeExceptionsPublisher publisher = client.listDatalakeExceptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxFailures won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatalakeExceptions(software.amazon.awssdk.services.securitylake.model.ListDatalakeExceptionsRequest)
operation.
This is a convenience which creates an instance of the ListDatalakeExceptionsRequest.Builder avoiding the
need to create one manually via ListDatalakeExceptionsRequest.builder()
listDatalakeExceptionsRequest - A Consumer that will call methods on ListDatalakeExceptionsRequest.Builder to create a
request.default CompletableFuture<ListLogSourcesResponse> listLogSources(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
listLogSourcesRequest - default CompletableFuture<ListLogSourcesResponse> listLogSources(Consumer<ListLogSourcesRequest.Builder> listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
This is a convenience which creates an instance of the ListLogSourcesRequest.Builder avoiding the need to
create one manually via ListLogSourcesRequest.builder()
listLogSourcesRequest - A Consumer that will call methods on ListLogSourcesRequest.Builder to create a request.default ListLogSourcesPublisher listLogSourcesPaginator(ListLogSourcesRequest listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
This is a variant of
listLogSources(software.amazon.awssdk.services.securitylake.model.ListLogSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListLogSourcesPublisher publisher = client.listLogSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListLogSourcesPublisher publisher = client.listLogSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListLogSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListLogSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLogSources(software.amazon.awssdk.services.securitylake.model.ListLogSourcesRequest) operation.
listLogSourcesRequest - default ListLogSourcesPublisher listLogSourcesPaginator(Consumer<ListLogSourcesRequest.Builder> listLogSourcesRequest)
Retrieves the log sources in the current Amazon Web Services Region.
This is a variant of
listLogSources(software.amazon.awssdk.services.securitylake.model.ListLogSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListLogSourcesPublisher publisher = client.listLogSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListLogSourcesPublisher publisher = client.listLogSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListLogSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListLogSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLogSources(software.amazon.awssdk.services.securitylake.model.ListLogSourcesRequest) operation.
This is a convenience which creates an instance of the ListLogSourcesRequest.Builder avoiding the need to
create one manually via ListLogSourcesRequest.builder()
listLogSourcesRequest - A Consumer that will call methods on ListLogSourcesRequest.Builder to create a request.default CompletableFuture<ListSubscribersResponse> listSubscribers(ListSubscribersRequest listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
listSubscribersRequest - default CompletableFuture<ListSubscribersResponse> listSubscribers(Consumer<ListSubscribersRequest.Builder> listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
This is a convenience which creates an instance of the ListSubscribersRequest.Builder avoiding the need
to create one manually via ListSubscribersRequest.builder()
listSubscribersRequest - A Consumer that will call methods on ListSubscribersRequest.Builder to create a request.default ListSubscribersPublisher listSubscribersPaginator(ListSubscribersRequest listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
This is a variant of
listSubscribers(software.amazon.awssdk.services.securitylake.model.ListSubscribersRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListSubscribersPublisher publisher = client.listSubscribersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListSubscribersPublisher publisher = client.listSubscribersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListSubscribersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListSubscribersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscribers(software.amazon.awssdk.services.securitylake.model.ListSubscribersRequest)
operation.
listSubscribersRequest - default ListSubscribersPublisher listSubscribersPaginator(Consumer<ListSubscribersRequest.Builder> listSubscribersRequest)
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
This is a variant of
listSubscribers(software.amazon.awssdk.services.securitylake.model.ListSubscribersRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.securitylake.paginators.ListSubscribersPublisher publisher = client.listSubscribersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.securitylake.paginators.ListSubscribersPublisher publisher = client.listSubscribersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securitylake.model.ListSubscribersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.securitylake.model.ListSubscribersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscribers(software.amazon.awssdk.services.securitylake.model.ListSubscribersRequest)
operation.
This is a convenience which creates an instance of the ListSubscribersRequest.Builder avoiding the need
to create one manually via ListSubscribersRequest.builder()
listSubscribersRequest - A Consumer that will call methods on ListSubscribersRequest.Builder to create a request.default CompletableFuture<UpdateDatalakeResponse> updateDatalake(UpdateDatalakeRequest updateDatalakeRequest)
Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
updateDatalakeRequest - default CompletableFuture<UpdateDatalakeResponse> updateDatalake(Consumer<UpdateDatalakeRequest.Builder> updateDatalakeRequest)
Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
This is a convenience which creates an instance of the UpdateDatalakeRequest.Builder avoiding the need to
create one manually via UpdateDatalakeRequest.builder()
updateDatalakeRequest - A Consumer that will call methods on UpdateDatalakeRequest.Builder to create a request.default CompletableFuture<UpdateDatalakeExceptionsExpiryResponse> updateDatalakeExceptionsExpiry(UpdateDatalakeExceptionsExpiryRequest updateDatalakeExceptionsExpiryRequest)
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.
updateDatalakeExceptionsExpiryRequest - default CompletableFuture<UpdateDatalakeExceptionsExpiryResponse> updateDatalakeExceptionsExpiry(Consumer<UpdateDatalakeExceptionsExpiryRequest.Builder> updateDatalakeExceptionsExpiryRequest)
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.
This is a convenience which creates an instance of the UpdateDatalakeExceptionsExpiryRequest.Builder
avoiding the need to create one manually via UpdateDatalakeExceptionsExpiryRequest.builder()
updateDatalakeExceptionsExpiryRequest - A Consumer that will call methods on UpdateDatalakeExceptionsExpiryRequest.Builder to
create a request.default CompletableFuture<UpdateDatalakeExceptionsSubscriptionResponse> updateDatalakeExceptionsSubscription(UpdateDatalakeExceptionsSubscriptionRequest updateDatalakeExceptionsSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
updateDatalakeExceptionsSubscriptionRequest - default CompletableFuture<UpdateDatalakeExceptionsSubscriptionResponse> updateDatalakeExceptionsSubscription(Consumer<UpdateDatalakeExceptionsSubscriptionRequest.Builder> updateDatalakeExceptionsSubscriptionRequest)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
This is a convenience which creates an instance of the
UpdateDatalakeExceptionsSubscriptionRequest.Builder avoiding the need to create one manually via
UpdateDatalakeExceptionsSubscriptionRequest.builder()
updateDatalakeExceptionsSubscriptionRequest - A Consumer that will call methods on UpdateDatalakeExceptionsSubscriptionRequest.Builder
to create a request.default CompletableFuture<UpdateSubscriberResponse> updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
updateSubscriberRequest - default CompletableFuture<UpdateSubscriberResponse> updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest)
Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
This is a convenience which creates an instance of the UpdateSubscriberRequest.Builder avoiding the need
to create one manually via UpdateSubscriberRequest.builder()
updateSubscriberRequest - A Consumer that will call methods on UpdateSubscriberRequest.Builder to create a request.default CompletableFuture<UpdateSubscriptionNotificationConfigurationResponse> updateSubscriptionNotificationConfiguration(UpdateSubscriptionNotificationConfigurationRequest updateSubscriptionNotificationConfigurationRequest)
Creates a new subscription notification or adds the existing subscription notification setting for the specified subscription ID.
updateSubscriptionNotificationConfigurationRequest - default CompletableFuture<UpdateSubscriptionNotificationConfigurationResponse> updateSubscriptionNotificationConfiguration(Consumer<UpdateSubscriptionNotificationConfigurationRequest.Builder> updateSubscriptionNotificationConfigurationRequest)
Creates a new subscription notification or adds the existing subscription notification setting for the specified subscription ID.
This is a convenience which creates an instance of the
UpdateSubscriptionNotificationConfigurationRequest.Builder avoiding the need to create one manually via
UpdateSubscriptionNotificationConfigurationRequest.builder()
updateSubscriptionNotificationConfigurationRequest - A Consumer that will call methods on
UpdateSubscriptionNotificationConfigurationRequest.Builder to create a request.Copyright © 2023. All rights reserved.