Class: Aws::SecurityLake::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SecurityLake::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb
Overview
An API client for SecurityLake. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SecurityLake::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_aws_log_source(params = {}) ⇒ Types::CreateAwsLogSourceResponse
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
-
#create_custom_log_source(params = {}) ⇒ Types::CreateCustomLogSourceResponse
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source.
-
#create_data_lake(params = {}) ⇒ Types::CreateDataLakeResponse
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
-
#create_data_lake_exception_subscription(params = {}) ⇒ Struct
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
-
#create_data_lake_organization_configuration(params = {}) ⇒ Struct
Automatically enables Amazon Security Lake for new member accounts in your organization.
-
#create_subscriber(params = {}) ⇒ Types::CreateSubscriberResponse
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
-
#create_subscriber_notification(params = {}) ⇒ Types::CreateSubscriberNotificationResponse
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
-
#delete_aws_log_source(params = {}) ⇒ Types::DeleteAwsLogSourceResponse
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
-
#delete_custom_log_source(params = {}) ⇒ Struct
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
-
#delete_data_lake(params = {}) ⇒ Struct
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.
-
#delete_data_lake_exception_subscription(params = {}) ⇒ Struct
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
-
#delete_data_lake_organization_configuration(params = {}) ⇒ Struct
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations.
-
#delete_subscriber(params = {}) ⇒ Struct
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake.
-
#delete_subscriber_notification(params = {}) ⇒ Struct
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
-
#deregister_data_lake_delegated_administrator(params = {}) ⇒ Struct
Deletes the Amazon Security Lake delegated administrator account for the organization.
-
#get_data_lake_exception_subscription(params = {}) ⇒ Types::GetDataLakeExceptionSubscriptionResponse
Retrieves the details of exception notifications for the account in Amazon Security Lake.
-
#get_data_lake_organization_configuration(params = {}) ⇒ Types::GetDataLakeOrganizationConfigurationResponse
Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake.
-
#get_data_lake_sources(params = {}) ⇒ Types::GetDataLakeSourcesResponse
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.
-
#get_subscriber(params = {}) ⇒ Types::GetSubscriberResponse
Retrieves the subscription information for the specified subscription ID.
-
#list_data_lake_exceptions(params = {}) ⇒ Types::ListDataLakeExceptionsResponse
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
-
#list_data_lakes(params = {}) ⇒ Types::ListDataLakesResponse
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
-
#list_log_sources(params = {}) ⇒ Types::ListLogSourcesResponse
Retrieves the log sources in the current Amazon Web Services Region.
-
#list_subscribers(params = {}) ⇒ Types::ListSubscribersResponse
List all subscribers for the specific Amazon Security Lake account ID.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
-
#register_data_lake_delegated_administrator(params = {}) ⇒ Struct
Designates the Amazon Security Lake delegated administrator account for the organization.
-
#tag_resource(params = {}) ⇒ Struct
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.
-
#untag_resource(params = {}) ⇒ Struct
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.
-
#update_data_lake(params = {}) ⇒ Types::UpdateDataLakeResponse
Specifies where to store your security data and for how long.
-
#update_data_lake_exception_subscription(params = {}) ⇒ Struct
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
-
#update_subscriber(params = {}) ⇒ Types::UpdateSubscriberResponse
Updates an existing subscription for the given Amazon Security Lake account ID.
-
#update_subscriber_notification(params = {}) ⇒ Types::UpdateSubscriberNotificationResponse
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_aws_log_source(params = {}) ⇒ Types::CreateAwsLogSourceResponse
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.
433 434 435 436 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 433 def create_aws_log_source(params = {}, = {}) req = build_request(:create_aws_log_source, params) req.send_request() end |
#create_custom_log_source(params = {}) ⇒ Types::CreateCustomLogSourceResponse
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.
557 558 559 560 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 557 def create_custom_log_source(params = {}, = {}) req = build_request(:create_custom_log_source, params) req.send_request() end |
#create_data_lake(params = {}) ⇒ Types::CreateDataLakeResponse
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.
662 663 664 665 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 662 def create_data_lake(params = {}, = {}) req = build_request(:create_data_lake, params) req.send_request() end |
#create_data_lake_exception_subscription(params = {}) ⇒ Struct
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
694 695 696 697 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 694 def create_data_lake_exception_subscription(params = {}, = {}) req = build_request(:create_data_lake_exception_subscription, params) req.send_request() end |
#create_data_lake_organization_configuration(params = {}) ⇒ Struct
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.
729 730 731 732 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 729 def create_data_lake_organization_configuration(params = {}, = {}) req = build_request(:create_data_lake_organization_configuration, params) req.send_request() end |
#create_subscriber(params = {}) ⇒ Types::CreateSubscriberResponse
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.
836 837 838 839 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 836 def create_subscriber(params = {}, = {}) req = build_request(:create_subscriber, params) req.send_request() end |
#create_subscriber_notification(params = {}) ⇒ Types::CreateSubscriberNotificationResponse
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.
881 882 883 884 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 881 def create_subscriber_notification(params = {}, = {}) req = build_request(:create_subscriber_notification, params) req.send_request() end |
#delete_aws_log_source(params = {}) ⇒ Types::DeleteAwsLogSourceResponse
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.
928 929 930 931 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 928 def delete_aws_log_source(params = {}, = {}) req = build_request(:delete_aws_log_source, params) req.send_request() end |
#delete_custom_log_source(params = {}) ⇒ Struct
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
956 957 958 959 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 956 def delete_custom_log_source(params = {}, = {}) req = build_request(:delete_custom_log_source, params) req.send_request() end |
#delete_data_lake(params = {}) ⇒ Struct
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.
993 994 995 996 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 993 def delete_data_lake(params = {}, = {}) req = build_request(:delete_data_lake, params) req.send_request() end |
#delete_data_lake_exception_subscription(params = {}) ⇒ Struct
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
1007 1008 1009 1010 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1007 def delete_data_lake_exception_subscription(params = {}, = {}) req = build_request(:delete_data_lake_exception_subscription, params) req.send_request() end |
#delete_data_lake_organization_configuration(params = {}) ⇒ Struct
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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1045 def delete_data_lake_organization_configuration(params = {}, = {}) req = build_request(:delete_data_lake_organization_configuration, params) req.send_request() end |
#delete_subscriber(params = {}) ⇒ Struct
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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1073 def delete_subscriber(params = {}, = {}) req = build_request(:delete_subscriber, params) req.send_request() end |
#delete_subscriber_notification(params = {}) ⇒ Struct
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1096 def delete_subscriber_notification(params = {}, = {}) req = build_request(:delete_subscriber_notification, params) req.send_request() end |
#deregister_data_lake_delegated_administrator(params = {}) ⇒ Struct
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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1112 def deregister_data_lake_delegated_administrator(params = {}, = {}) req = build_request(:deregister_data_lake_delegated_administrator, params) req.send_request() end |
#get_data_lake_exception_subscription(params = {}) ⇒ Types::GetDataLakeExceptionSubscriptionResponse
Retrieves the details of exception notifications for the account in Amazon Security Lake.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1136 def get_data_lake_exception_subscription(params = {}, = {}) req = build_request(:get_data_lake_exception_subscription, params) req.send_request() end |
#get_data_lake_organization_configuration(params = {}) ⇒ Types::GetDataLakeOrganizationConfigurationResponse
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.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1162 def get_data_lake_organization_configuration(params = {}, = {}) req = build_request(:get_data_lake_organization_configuration, params) req.send_request() end |
#get_data_lake_sources(params = {}) ⇒ Types::GetDataLakeSourcesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1223 def get_data_lake_sources(params = {}, = {}) req = build_request(:get_data_lake_sources, params) req.send_request() end |
#get_subscriber(params = {}) ⇒ Types::GetSubscriberResponse
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1278 def get_subscriber(params = {}, = {}) req = build_request(:get_subscriber, params) req.send_request() end |
#list_data_lake_exceptions(params = {}) ⇒ Types::ListDataLakeExceptionsResponse
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1329 def list_data_lake_exceptions(params = {}, = {}) req = build_request(:list_data_lake_exceptions, params) req.send_request() end |
#list_data_lakes(params = {}) ⇒ Types::ListDataLakesResponse
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.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1375 def list_data_lakes(params = {}, = {}) req = build_request(:list_data_lakes, params) req.send_request() end |
#list_log_sources(params = {}) ⇒ Types::ListLogSourcesResponse
Retrieves the log sources in the current Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1458 1459 1460 1461 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1458 def list_log_sources(params = {}, = {}) req = build_request(:list_log_sources, params) req.send_request() end |
#list_subscribers(params = {}) ⇒ Types::ListSubscribersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1524 1525 1526 1527 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1524 def list_subscribers(params = {}, = {}) req = build_request(:list_subscribers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1558 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_data_lake_delegated_administrator(params = {}) ⇒ Struct
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.
1584 1585 1586 1587 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1584 def register_data_lake_delegated_administrator(params = {}, = {}) req = build_request(:register_data_lake_delegated_administrator, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1634 1635 1636 1637 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1634 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1666 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_data_lake(params = {}) ⇒ Types::UpdateDataLakeResponse
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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1741 def update_data_lake(params = {}, = {}) req = build_request(:update_data_lake, params) req.send_request() end |
#update_data_lake_exception_subscription(params = {}) ⇒ Struct
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1772 def update_data_lake_exception_subscription(params = {}, = {}) req = build_request(:update_data_lake_exception_subscription, params) req.send_request() end |
#update_subscriber(params = {}) ⇒ Types::UpdateSubscriberResponse
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.
1873 1874 1875 1876 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1873 def update_subscriber(params = {}, = {}) req = build_request(:update_subscriber, params) req.send_request() end |
#update_subscriber_notification(params = {}) ⇒ Types::UpdateSubscriberNotificationResponse
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-securitylake/lib/aws-sdk-securitylake/client.rb', line 1918 def update_subscriber_notification(params = {}, = {}) req = build_request(:update_subscriber_notification, params) req.send_request() end |