SecurityLakeClient#
Index > SecurityLake > SecurityLakeClient
Auto-generated documentation for SecurityLake type annotations stubs module mypy-boto3-securitylake.
SecurityLakeClient#
Type annotations and code completion for boto3.client("securitylake").
boto3 documentation
# SecurityLakeClient usage example
from boto3.session import Session
from mypy_boto3_securitylake.client import SecurityLakeClient
def get_securitylake_client() -> SecurityLakeClient:
return Session().client("securitylake")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("securitylake").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("securitylake")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_securitylake.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("securitylake").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("securitylake").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_aws_log_source#
Adds a natively supported Amazon Web Service as an Amazon Security Lake source.
Type annotations and code completion for boto3.client("securitylake").create_aws_log_source method.
boto3 documentation
# create_aws_log_source method definition
def create_aws_log_source(
self,
*,
sources: Sequence[AwsLogSourceConfigurationTypeDef], # (1)
) -> CreateAwsLogSourceResponseTypeDef: # (2)
...# create_aws_log_source method usage example with argument unpacking
kwargs: CreateAwsLogSourceRequestRequestTypeDef = { # (1)
"sources": ...,
}
parent.create_aws_log_source(**kwargs)create_custom_log_source#
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source.
Type annotations and code completion for boto3.client("securitylake").create_custom_log_source method.
boto3 documentation
# create_custom_log_source method definition
def create_custom_log_source(
self,
*,
sourceName: str,
configuration: CustomLogSourceConfigurationTypeDef = ..., # (1)
eventClasses: Sequence[str] = ...,
sourceVersion: str = ...,
) -> CreateCustomLogSourceResponseTypeDef: # (2)
...# create_custom_log_source method usage example with argument unpacking
kwargs: CreateCustomLogSourceRequestRequestTypeDef = { # (1)
"sourceName": ...,
}
parent.create_custom_log_source(**kwargs)create_data_lake#
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
Type annotations and code completion for boto3.client("securitylake").create_data_lake method.
boto3 documentation
# create_data_lake method definition
def create_data_lake(
self,
*,
configurations: Sequence[DataLakeConfigurationTypeDef], # (1)
metaStoreManagerRoleArn: str,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDataLakeResponseTypeDef: # (3)
...# create_data_lake method usage example with argument unpacking
kwargs: CreateDataLakeRequestRequestTypeDef = { # (1)
"configurations": ...,
"metaStoreManagerRoleArn": ...,
}
parent.create_data_lake(**kwargs)create_data_lake_exception_subscription#
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
Type annotations and code completion for boto3.client("securitylake").create_data_lake_exception_subscription method.
boto3 documentation
# create_data_lake_exception_subscription method definition
def create_data_lake_exception_subscription(
self,
*,
notificationEndpoint: str,
subscriptionProtocol: str,
exceptionTimeToLive: int = ...,
) -> Dict[str, Any]:
...# create_data_lake_exception_subscription method usage example with argument unpacking
kwargs: CreateDataLakeExceptionSubscriptionRequestRequestTypeDef = { # (1)
"notificationEndpoint": ...,
"subscriptionProtocol": ...,
}
parent.create_data_lake_exception_subscription(**kwargs)create_data_lake_organization_configuration#
Automatically enables Amazon Security Lake for new member accounts in your organization.
Type annotations and code completion for boto3.client("securitylake").create_data_lake_organization_configuration method.
boto3 documentation
# create_data_lake_organization_configuration method definition
def create_data_lake_organization_configuration(
self,
*,
autoEnableNewAccount: Sequence[DataLakeAutoEnableNewAccountConfigurationTypeDef], # (1)
) -> Dict[str, Any]:
...# create_data_lake_organization_configuration method usage example with argument unpacking
kwargs: CreateDataLakeOrganizationConfigurationRequestRequestTypeDef = { # (1)
"autoEnableNewAccount": ...,
}
parent.create_data_lake_organization_configuration(**kwargs)create_subscriber#
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").create_subscriber method.
boto3 documentation
# create_subscriber method definition
def create_subscriber(
self,
*,
sources: Sequence[LogSourceResourceTypeDef], # (1)
subscriberIdentity: AwsIdentityTypeDef, # (2)
subscriberName: str,
accessTypes: Sequence[AccessTypeType] = ..., # (3)
subscriberDescription: str = ...,
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateSubscriberResponseTypeDef: # (5)
...- See LogSourceResourceTypeDef
- See AwsIdentityTypeDef
- See AccessTypeType
- See TagTypeDef
- See CreateSubscriberResponseTypeDef
# create_subscriber method usage example with argument unpacking
kwargs: CreateSubscriberRequestRequestTypeDef = { # (1)
"sources": ...,
"subscriberIdentity": ...,
"subscriberName": ...,
}
parent.create_subscriber(**kwargs)create_subscriber_notification#
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
Type annotations and code completion for boto3.client("securitylake").create_subscriber_notification method.
boto3 documentation
# create_subscriber_notification method definition
def create_subscriber_notification(
self,
*,
configuration: NotificationConfigurationTypeDef, # (1)
subscriberId: str,
) -> CreateSubscriberNotificationResponseTypeDef: # (2)
...# create_subscriber_notification method usage example with argument unpacking
kwargs: CreateSubscriberNotificationRequestRequestTypeDef = { # (1)
"configuration": ...,
"subscriberId": ...,
}
parent.create_subscriber_notification(**kwargs)delete_aws_log_source#
Removes a natively supported Amazon Web Service as an Amazon Security Lake source.
Type annotations and code completion for boto3.client("securitylake").delete_aws_log_source method.
boto3 documentation
# delete_aws_log_source method definition
def delete_aws_log_source(
self,
*,
sources: Sequence[AwsLogSourceConfigurationTypeDef], # (1)
) -> DeleteAwsLogSourceResponseTypeDef: # (2)
...# delete_aws_log_source method usage example with argument unpacking
kwargs: DeleteAwsLogSourceRequestRequestTypeDef = { # (1)
"sources": ...,
}
parent.delete_aws_log_source(**kwargs)delete_custom_log_source#
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
Type annotations and code completion for boto3.client("securitylake").delete_custom_log_source method.
boto3 documentation
# delete_custom_log_source method definition
def delete_custom_log_source(
self,
*,
sourceName: str,
sourceVersion: str = ...,
) -> Dict[str, Any]:
...# delete_custom_log_source method usage example with argument unpacking
kwargs: DeleteCustomLogSourceRequestRequestTypeDef = { # (1)
"sourceName": ...,
}
parent.delete_custom_log_source(**kwargs)delete_data_lake#
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.
Type annotations and code completion for boto3.client("securitylake").delete_data_lake method.
boto3 documentation
# delete_data_lake method definition
def delete_data_lake(
self,
*,
regions: Sequence[str],
) -> Dict[str, Any]:
...# delete_data_lake method usage example with argument unpacking
kwargs: DeleteDataLakeRequestRequestTypeDef = { # (1)
"regions": ...,
}
parent.delete_data_lake(**kwargs)delete_data_lake_exception_subscription#
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
Type annotations and code completion for boto3.client("securitylake").delete_data_lake_exception_subscription method.
boto3 documentation
# delete_data_lake_exception_subscription method definition
def delete_data_lake_exception_subscription(
self,
) -> Dict[str, Any]:
...delete_data_lake_organization_configuration#
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations.
Type annotations and code completion for boto3.client("securitylake").delete_data_lake_organization_configuration method.
boto3 documentation
# delete_data_lake_organization_configuration method definition
def delete_data_lake_organization_configuration(
self,
*,
autoEnableNewAccount: Sequence[DataLakeAutoEnableNewAccountConfigurationTypeDef], # (1)
) -> Dict[str, Any]:
...# delete_data_lake_organization_configuration method usage example with argument unpacking
kwargs: DeleteDataLakeOrganizationConfigurationRequestRequestTypeDef = { # (1)
"autoEnableNewAccount": ...,
}
parent.delete_data_lake_organization_configuration(**kwargs)delete_subscriber#
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").delete_subscriber method.
boto3 documentation
# delete_subscriber method definition
def delete_subscriber(
self,
*,
subscriberId: str,
) -> Dict[str, Any]:
...# delete_subscriber method usage example with argument unpacking
kwargs: DeleteSubscriberRequestRequestTypeDef = { # (1)
"subscriberId": ...,
}
parent.delete_subscriber(**kwargs)delete_subscriber_notification#
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
Type annotations and code completion for boto3.client("securitylake").delete_subscriber_notification method.
boto3 documentation
# delete_subscriber_notification method definition
def delete_subscriber_notification(
self,
*,
subscriberId: str,
) -> Dict[str, Any]:
...# delete_subscriber_notification method usage example with argument unpacking
kwargs: DeleteSubscriberNotificationRequestRequestTypeDef = { # (1)
"subscriberId": ...,
}
parent.delete_subscriber_notification(**kwargs)deregister_data_lake_delegated_administrator#
Deletes the Amazon Security Lake delegated administrator account for the organization.
Type annotations and code completion for boto3.client("securitylake").deregister_data_lake_delegated_administrator method.
boto3 documentation
# deregister_data_lake_delegated_administrator method definition
def deregister_data_lake_delegated_administrator(
self,
) -> Dict[str, Any]:
...generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("securitylake").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_data_lake_exception_subscription#
Retrieves the details of exception notifications for the account in Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").get_data_lake_exception_subscription method.
boto3 documentation
# get_data_lake_exception_subscription method definition
def get_data_lake_exception_subscription(
self,
) -> GetDataLakeExceptionSubscriptionResponseTypeDef: # (1)
...get_data_lake_organization_configuration#
Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").get_data_lake_organization_configuration method.
boto3 documentation
# get_data_lake_organization_configuration method definition
def get_data_lake_organization_configuration(
self,
) -> GetDataLakeOrganizationConfigurationResponseTypeDef: # (1)
...get_data_lake_sources#
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.
Type annotations and code completion for boto3.client("securitylake").get_data_lake_sources method.
boto3 documentation
# get_data_lake_sources method definition
def get_data_lake_sources(
self,
*,
accounts: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> GetDataLakeSourcesResponseTypeDef: # (1)
...# get_data_lake_sources method usage example with argument unpacking
kwargs: GetDataLakeSourcesRequestRequestTypeDef = { # (1)
"accounts": ...,
}
parent.get_data_lake_sources(**kwargs)get_subscriber#
Retrieves the subscription information for the specified subscription ID.
Type annotations and code completion for boto3.client("securitylake").get_subscriber method.
boto3 documentation
# get_subscriber method definition
def get_subscriber(
self,
*,
subscriberId: str,
) -> GetSubscriberResponseTypeDef: # (1)
...# get_subscriber method usage example with argument unpacking
kwargs: GetSubscriberRequestRequestTypeDef = { # (1)
"subscriberId": ...,
}
parent.get_subscriber(**kwargs)list_data_lake_exceptions#
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
Type annotations and code completion for boto3.client("securitylake").list_data_lake_exceptions method.
boto3 documentation
# list_data_lake_exceptions method definition
def list_data_lake_exceptions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
regions: Sequence[str] = ...,
) -> ListDataLakeExceptionsResponseTypeDef: # (1)
...# list_data_lake_exceptions method usage example with argument unpacking
kwargs: ListDataLakeExceptionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_data_lake_exceptions(**kwargs)list_data_lakes#
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
Type annotations and code completion for boto3.client("securitylake").list_data_lakes method.
boto3 documentation
# list_data_lakes method definition
def list_data_lakes(
self,
*,
regions: Sequence[str] = ...,
) -> ListDataLakesResponseTypeDef: # (1)
...# list_data_lakes method usage example with argument unpacking
kwargs: ListDataLakesRequestRequestTypeDef = { # (1)
"regions": ...,
}
parent.list_data_lakes(**kwargs)list_log_sources#
Retrieves the log sources in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("securitylake").list_log_sources method.
boto3 documentation
# list_log_sources method definition
def list_log_sources(
self,
*,
accounts: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
regions: Sequence[str] = ...,
sources: Sequence[LogSourceResourceTypeDef] = ..., # (1)
) -> ListLogSourcesResponseTypeDef: # (2)
...# list_log_sources method usage example with argument unpacking
kwargs: ListLogSourcesRequestRequestTypeDef = { # (1)
"accounts": ...,
}
parent.list_log_sources(**kwargs)list_subscribers#
List all subscribers for the specific Amazon Security Lake account ID.
Type annotations and code completion for boto3.client("securitylake").list_subscribers method.
boto3 documentation
# list_subscribers method definition
def list_subscribers(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSubscribersResponseTypeDef: # (1)
...# list_subscribers method usage example with argument unpacking
kwargs: ListSubscribersRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_subscribers(**kwargs)list_tags_for_resource#
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.
Type annotations and code completion for boto3.client("securitylake").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)register_data_lake_delegated_administrator#
Designates the Amazon Security Lake delegated administrator account for the organization.
Type annotations and code completion for boto3.client("securitylake").register_data_lake_delegated_administrator method.
boto3 documentation
# register_data_lake_delegated_administrator method definition
def register_data_lake_delegated_administrator(
self,
*,
accountId: str,
) -> Dict[str, Any]:
...# register_data_lake_delegated_administrator method usage example with argument unpacking
kwargs: RegisterDataLakeDelegatedAdministratorRequestRequestTypeDef = { # (1)
"accountId": ...,
}
parent.register_data_lake_delegated_administrator(**kwargs)tag_resource#
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.
Type annotations and code completion for boto3.client("securitylake").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
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.
Type annotations and code completion for boto3.client("securitylake").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_data_lake#
Specifies where to store your security data and for how long.
Type annotations and code completion for boto3.client("securitylake").update_data_lake method.
</