@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSecurityLake extends Object implements AmazonSecurityLake
AmazonSecurityLake
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateAwsLogSourceResult |
createAwsLogSource(CreateAwsLogSourceRequest request)
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
|
CreateCustomLogSourceResult |
createCustomLogSource(CreateCustomLogSourceRequest request)
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to
create a custom source.
|
CreateDataLakeResult |
createDataLake(CreateDataLakeRequest request)
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
|
CreateDataLakeExceptionSubscriptionResult |
createDataLakeExceptionSubscription(CreateDataLakeExceptionSubscriptionRequest request)
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
CreateDataLakeOrganizationConfigurationResult |
createDataLakeOrganizationConfiguration(CreateDataLakeOrganizationConfigurationRequest request)
Automatically enables Amazon Security Lake for new member accounts in your organization.
|
CreateSubscriberResult |
createSubscriber(CreateSubscriberRequest request)
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
|
CreateSubscriberNotificationResult |
createSubscriberNotification(CreateSubscriberNotificationRequest request)
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in
Security Lake.
|
DeleteAwsLogSourceResult |
deleteAwsLogSource(DeleteAwsLogSourceRequest request)
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
|
DeleteCustomLogSourceResult |
deleteCustomLogSource(DeleteCustomLogSourceRequest request)
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security
Lake.
|
DeleteDataLakeResult |
deleteDataLake(DeleteDataLakeRequest request)
When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services
Regions and it stops collecting data from your sources.
|
DeleteDataLakeExceptionSubscriptionResult |
deleteDataLakeExceptionSubscription(DeleteDataLakeExceptionSubscriptionRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
DeleteDataLakeOrganizationConfigurationResult |
deleteDataLakeOrganizationConfiguration(DeleteDataLakeOrganizationConfigurationRequest request)
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in
Organizations.
|
DeleteSubscriberResult |
deleteSubscriber(DeleteSubscriberRequest request)
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon
Security Lake.
|
DeleteSubscriberNotificationResult |
deleteSubscriberNotification(DeleteSubscriberNotificationRequest request)
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
|
DeregisterDataLakeDelegatedAdministratorResult |
deregisterDataLakeDelegatedAdministrator(DeregisterDataLakeDelegatedAdministratorRequest request)
Deletes the Amazon Security Lake delegated administrator account for the organization.
|
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.
|
GetDataLakeExceptionSubscriptionResult |
getDataLakeExceptionSubscription(GetDataLakeExceptionSubscriptionRequest request)
Retrieves the details of exception notifications for the account in Amazon Security Lake.
|
GetDataLakeOrganizationConfigurationResult |
getDataLakeOrganizationConfiguration(GetDataLakeOrganizationConfigurationRequest request)
Retrieves the configuration that will be automatically set up for accounts added to the organization after the
organization has onboarded to Amazon Security Lake.
|
GetDataLakeSourcesResult |
getDataLakeSources(GetDataLakeSourcesRequest request)
Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts
and which sources Security Lake is collecting data from.
|
GetSubscriberResult |
getSubscriber(GetSubscriberRequest request)
Retrieves the subscription information for the specified subscription ID.
|
ListDataLakeExceptionsResult |
listDataLakeExceptions(ListDataLakeExceptionsRequest request)
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
|
ListDataLakesResult |
listDataLakes(ListDataLakesRequest request)
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
|
ListLogSourcesResult |
listLogSources(ListLogSourcesRequest request)
Retrieves the log sources in the current Amazon Web Services Region.
|
ListSubscribersResult |
listSubscribers(ListSubscribersRequest request)
List all subscribers for the specific Amazon Security Lake account ID.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or
the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
|
RegisterDataLakeDelegatedAdministratorResult |
registerDataLakeDelegatedAdministrator(RegisterDataLakeDelegatedAdministratorRequest request)
Designates the Amazon Security Lake delegated administrator account for the organization.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the
data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake
configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
|
UpdateDataLakeResult |
updateDataLake(UpdateDataLakeRequest request)
Specifies where to store your security data and for how long.
|
UpdateDataLakeExceptionSubscriptionResult |
updateDataLakeExceptionSubscription(UpdateDataLakeExceptionSubscriptionRequest request)
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
|
UpdateSubscriberResult |
updateSubscriber(UpdateSubscriberRequest request)
Updates an existing subscription for the given Amazon Security Lake account ID.
|
UpdateSubscriberNotificationResult |
updateSubscriberNotification(UpdateSubscriberNotificationRequest request)
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification
subscription endpoint for a subscriber.
|
public CreateAwsLogSourceResult createAwsLogSource(CreateAwsLogSourceRequest request)
AmazonSecurityLake
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it.
You can use this API only to enable natively supported Amazon Web Services as a source. Use
CreateCustomLogSource
to enable data collection from a custom source.
createAwsLogSource
in interface AmazonSecurityLake
public CreateCustomLogSourceResult createCustomLogSource(CreateCustomLogSourceRequest request)
AmazonSecurityLake
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.
createCustomLogSource
in interface AmazonSecurityLake
public CreateDataLakeResult createDataLake(CreateDataLakeRequest request)
AmazonSecurityLake
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable
Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions.
To specify particular Regions, configure these Regions using the configurations
parameter. If you
have already enabled Security Lake in a Region when you call this command, the command will update the Region if
you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you
call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource
call.
This includes ingesting security data from sources, storing data, and making data accessible to subscribers.
Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon
Web Services account in the current Region, including security log and event data. For more information, see the
Amazon Security
Lake User Guide.
createDataLake
in interface AmazonSecurityLake
public CreateDataLakeExceptionSubscriptionResult createDataLakeExceptionSubscription(CreateDataLakeExceptionSubscriptionRequest request)
AmazonSecurityLake
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
createDataLakeExceptionSubscription
in interface AmazonSecurityLake
public CreateDataLakeOrganizationConfigurationResult createDataLakeOrganizationConfiguration(CreateDataLakeOrganizationConfigurationRequest request)
AmazonSecurityLake
Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
createDataLakeOrganizationConfiguration
in interface AmazonSecurityLake
public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)
AmazonSecurityLake
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
createSubscriber
in interface AmazonSecurityLake
public CreateSubscriberNotificationResult createSubscriberNotification(CreateSubscriberNotificationRequest request)
AmazonSecurityLake
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
createSubscriberNotification
in interface AmazonSecurityLake
public DeleteAwsLogSourceResult deleteAwsLogSource(DeleteAwsLogSourceRequest request)
AmazonSecurityLake
Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal.
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.
deleteAwsLogSource
in interface AmazonSecurityLake
public DeleteCustomLogSourceResult deleteCustomLogSource(DeleteCustomLogSourceRequest request)
AmazonSecurityLake
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
deleteCustomLogSource
in interface AmazonSecurityLake
public DeleteDataLakeResult deleteDataLake(DeleteDataLakeRequest request)
AmazonSecurityLake
When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region.
The DeleteDataLake
operation does not delete the data that is stored in your Amazon S3 bucket, which
is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake
User Guide.
deleteDataLake
in interface AmazonSecurityLake
public DeleteDataLakeExceptionSubscriptionResult deleteDataLakeExceptionSubscription(DeleteDataLakeExceptionSubscriptionRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteDataLakeExceptionSubscription
in interface AmazonSecurityLake
public DeleteDataLakeOrganizationConfigurationResult deleteDataLakeOrganizationConfiguration(DeleteDataLakeOrganizationConfigurationRequest request)
AmazonSecurityLake
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
deleteDataLakeOrganizationConfiguration
in interface AmazonSecurityLake
public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)
AmazonSecurityLake
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon
Security Lake. When you run DeleteSubscriber
, the subscriber will no longer consume data from
Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in
the current Amazon Web Services Region.
deleteSubscriber
in interface AmazonSecurityLake
public DeleteSubscriberNotificationResult deleteSubscriberNotification(DeleteSubscriberNotificationRequest request)
AmazonSecurityLake
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
deleteSubscriberNotification
in interface AmazonSecurityLake
public DeregisterDataLakeDelegatedAdministratorResult deregisterDataLakeDelegatedAdministrator(DeregisterDataLakeDelegatedAdministratorRequest request)
AmazonSecurityLake
Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
deregisterDataLakeDelegatedAdministrator
in interface AmazonSecurityLake
public GetDataLakeExceptionSubscriptionResult getDataLakeExceptionSubscription(GetDataLakeExceptionSubscriptionRequest request)
AmazonSecurityLake
Retrieves the details of exception notifications for the account in Amazon Security Lake.
getDataLakeExceptionSubscription
in interface AmazonSecurityLake
public GetDataLakeOrganizationConfigurationResult getDataLakeOrganizationConfiguration(GetDataLakeOrganizationConfigurationRequest request)
AmazonSecurityLake
Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
getDataLakeOrganizationConfiguration
in interface AmazonSecurityLake
public GetDataLakeSourcesResult getDataLakeSources(GetDataLakeSourcesRequest request)
AmazonSecurityLake
Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
getDataLakeSources
in interface AmazonSecurityLake
public GetSubscriberResult getSubscriber(GetSubscriberRequest request)
AmazonSecurityLake
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
getSubscriber
in interface AmazonSecurityLake
public ListDataLakeExceptionsResult listDataLakeExceptions(ListDataLakeExceptionsRequest request)
AmazonSecurityLake
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
listDataLakeExceptions
in interface AmazonSecurityLake
public ListDataLakesResult listDataLakes(ListDataLakesRequest request)
AmazonSecurityLake
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.
listDataLakes
in interface AmazonSecurityLake
public ListLogSourcesResult listLogSources(ListLogSourcesRequest request)
AmazonSecurityLake
Retrieves the log sources in the current Amazon Web Services Region.
listLogSources
in interface AmazonSecurityLake
public ListSubscribersResult listSubscribers(ListSubscribersRequest request)
AmazonSecurityLake
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
listSubscribers
in interface AmazonSecurityLake
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonSecurityLake
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
listTagsForResource
in interface AmazonSecurityLake
public RegisterDataLakeDelegatedAdministratorResult registerDataLakeDelegatedAdministrator(RegisterDataLakeDelegatedAdministratorRequest request)
AmazonSecurityLake
Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
registerDataLakeDelegatedAdministrator
in interface AmazonSecurityLake
public TagResourceResult tagResource(TagResourceRequest request)
AmazonSecurityLake
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
tagResource
in interface AmazonSecurityLake
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonSecurityLake
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
untagResource
in interface AmazonSecurityLake
public UpdateDataLakeResult updateDataLake(UpdateDataLakeRequest request)
AmazonSecurityLake
Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
updateDataLake
in interface AmazonSecurityLake
public UpdateDataLakeExceptionSubscriptionResult updateDataLakeExceptionSubscription(UpdateDataLakeExceptionSubscriptionRequest request)
AmazonSecurityLake
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
updateDataLakeExceptionSubscription
in interface AmazonSecurityLake
public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)
AmazonSecurityLake
Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
updateSubscriber
in interface AmazonSecurityLake
public UpdateSubscriberNotificationResult updateSubscriberNotification(UpdateSubscriberNotificationRequest request)
AmazonSecurityLake
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
updateSubscriberNotification
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.