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.AccountNotFoundException,
client.exceptions.BucketNotFoundException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.ConflictException,
client.exceptions.ConflictSourceNamesException,
client.exceptions.ConflictSubscriptionException,
client.exceptions.EventBridgeException,
client.exceptions.InternalServerException,
client.exceptions.InvalidInputException,
client.exceptions.ResourceNotFoundException,
client.exceptions.S3Exception,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) 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,
*,
inputOrder: Sequence[DimensionType], # (1)
enableAllDimensions: Mapping[str, Mapping[str, Sequence[str]]] = ...,
enableSingleDimension: Sequence[str] = ...,
enableTwoDimensions: Mapping[str, Sequence[str]] = ...,
) -> CreateAwsLogSourceResponseTypeDef: # (2)
...
# create_aws_log_source method usage example with argument unpacking
kwargs: CreateAwsLogSourceRequestRequestTypeDef = { # (1)
"inputOrder": ...,
}
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,
*,
customSourceName: str,
eventClass: OcsfEventClassType, # (1)
glueInvocationRoleArn: str,
logProviderAccountId: str,
) -> CreateCustomLogSourceResponseTypeDef: # (2)
...
# create_custom_log_source method usage example with argument unpacking
kwargs: CreateCustomLogSourceRequestRequestTypeDef = { # (1)
"customSourceName": ...,
"eventClass": ...,
"glueInvocationRoleArn": ...,
"logProviderAccountId": ...,
}
parent.create_custom_log_source(**kwargs)
create_datalake
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
Type annotations and code completion for boto3.client("securitylake").create_datalake
method.
boto3 documentation
# create_datalake method definition
def create_datalake(
self,
*,
configurations: Mapping[RegionType, LakeConfigurationRequestTypeDef] = ..., # (1)
enableAll: bool = ...,
metaStoreManagerRoleArn: str = ...,
regions: Sequence[RegionType] = ..., # (2)
) -> Dict[str, Any]:
...
# create_datalake method usage example with argument unpacking
kwargs: CreateDatalakeRequestRequestTypeDef = { # (1)
"configurations": ...,
}
parent.create_datalake(**kwargs)
create_datalake_auto_enable
Automatically enables Amazon Security Lake for new member accounts in your organization.
Type annotations and code completion for boto3.client("securitylake").create_datalake_auto_enable
method.
boto3 documentation
# create_datalake_auto_enable method definition
def create_datalake_auto_enable(
self,
*,
configurationForNewAccounts: Sequence[AutoEnableNewRegionConfigurationTypeDef], # (1)
) -> Dict[str, Any]:
...
# create_datalake_auto_enable method usage example with argument unpacking
kwargs: CreateDatalakeAutoEnableRequestRequestTypeDef = { # (1)
"configurationForNewAccounts": ...,
}
parent.create_datalake_auto_enable(**kwargs)
create_datalake_delegated_admin
Designates the Amazon Security Lake delegated administrator account for the organization.
Type annotations and code completion for boto3.client("securitylake").create_datalake_delegated_admin
method.
boto3 documentation
# create_datalake_delegated_admin method definition
def create_datalake_delegated_admin(
self,
*,
account: str,
) -> Dict[str, Any]:
...
# create_datalake_delegated_admin method usage example with argument unpacking
kwargs: CreateDatalakeDelegatedAdminRequestRequestTypeDef = { # (1)
"account": ...,
}
parent.create_datalake_delegated_admin(**kwargs)
create_datalake_exceptions_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_datalake_exceptions_subscription
method.
boto3 documentation
# create_datalake_exceptions_subscription method definition
def create_datalake_exceptions_subscription(
self,
*,
notificationEndpoint: str,
subscriptionProtocol: SubscriptionProtocolTypeType, # (1)
) -> Dict[str, Any]:
...
# create_datalake_exceptions_subscription method usage example with argument unpacking
kwargs: CreateDatalakeExceptionsSubscriptionRequestRequestTypeDef = { # (1)
"notificationEndpoint": ...,
"subscriptionProtocol": ...,
}
parent.create_datalake_exceptions_subscription(**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,
*,
accountId: str,
externalId: str,
sourceTypes: Sequence[SourceTypeTypeDef], # (1)
subscriberName: str,
accessTypes: Sequence[AccessTypeType] = ..., # (2)
subscriberDescription: str = ...,
) -> CreateSubscriberResponseTypeDef: # (3)
...
# create_subscriber method usage example with argument unpacking
kwargs: CreateSubscriberRequestRequestTypeDef = { # (1)
"accountId": ...,
"externalId": ...,
"sourceTypes": ...,
"subscriberName": ...,
}
parent.create_subscriber(**kwargs)
create_subscription_notification_configuration
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_subscription_notification_configuration
method.
boto3 documentation
# create_subscription_notification_configuration method definition
def create_subscription_notification_configuration(
self,
*,
subscriptionId: str,
createSqs: bool = ...,
httpsApiKeyName: str = ...,
httpsApiKeyValue: str = ...,
httpsMethod: HttpsMethodType = ..., # (1)
roleArn: str = ...,
subscriptionEndpoint: str = ...,
) -> CreateSubscriptionNotificationConfigurationResponseTypeDef: # (2)
...
# create_subscription_notification_configuration method usage example with argument unpacking
kwargs: CreateSubscriptionNotificationConfigurationRequestRequestTypeDef = { # (1)
"subscriptionId": ...,
}
parent.create_subscription_notification_configuration(**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,
*,
inputOrder: Sequence[DimensionType], # (1)
disableAllDimensions: Mapping[str, Mapping[str, Sequence[str]]] = ...,
disableSingleDimension: Sequence[str] = ...,
disableTwoDimensions: Mapping[str, Sequence[str]] = ...,
) -> DeleteAwsLogSourceResponseTypeDef: # (2)
...
# delete_aws_log_source method usage example with argument unpacking
kwargs: DeleteAwsLogSourceRequestRequestTypeDef = { # (1)
"inputOrder": ...,
}
parent.delete_aws_log_source(**kwargs)
delete_custom_log_source
Removes a custom log source from Amazon 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,
*,
customSourceName: str,
) -> DeleteCustomLogSourceResponseTypeDef: # (1)
...
# delete_custom_log_source method usage example with argument unpacking
kwargs: DeleteCustomLogSourceRequestRequestTypeDef = { # (1)
"customSourceName": ...,
}
parent.delete_custom_log_source(**kwargs)
delete_datalake
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions.
Type annotations and code completion for boto3.client("securitylake").delete_datalake
method.
boto3 documentation
# delete_datalake method definition
def delete_datalake(
self,
) -> Dict[str, Any]:
...
delete_datalake_auto_enable
DeleteDatalakeAutoEnable
removes automatic enablement of configuration
settings for new member accounts (but keeps settings for the delegated
administrator) from Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").delete_datalake_auto_enable
method.
boto3 documentation
# delete_datalake_auto_enable method definition
def delete_datalake_auto_enable(
self,
*,
removeFromConfigurationForNewAccounts: Sequence[AutoEnableNewRegionConfigurationTypeDef], # (1)
) -> Dict[str, Any]:
...
# delete_datalake_auto_enable method usage example with argument unpacking
kwargs: DeleteDatalakeAutoEnableRequestRequestTypeDef = { # (1)
"removeFromConfigurationForNewAccounts": ...,
}
parent.delete_datalake_auto_enable(**kwargs)
delete_datalake_delegated_admin
Deletes the Amazon Security Lake delegated administrator account for the organization.
Type annotations and code completion for boto3.client("securitylake").delete_datalake_delegated_admin
method.
boto3 documentation
# delete_datalake_delegated_admin method definition
def delete_datalake_delegated_admin(
self,
*,
account: str,
) -> Dict[str, Any]:
...
# delete_datalake_delegated_admin method usage example with argument unpacking
kwargs: DeleteDatalakeDelegatedAdminRequestRequestTypeDef = { # (1)
"account": ...,
}
parent.delete_datalake_delegated_admin(**kwargs)
delete_datalake_exceptions_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_datalake_exceptions_subscription
method.
boto3 documentation
# delete_datalake_exceptions_subscription method definition
def delete_datalake_exceptions_subscription(
self,
) -> DeleteDatalakeExceptionsSubscriptionResponseTypeDef: # (1)
...
delete_subscriber
Deletes the subscription permission 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,
*,
id: str,
) -> Dict[str, Any]:
...
# delete_subscriber method usage example with argument unpacking
kwargs: DeleteSubscriberRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_subscriber(**kwargs)
delete_subscription_notification_configuration
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
Type annotations and code completion for boto3.client("securitylake").delete_subscription_notification_configuration
method.
boto3 documentation
# delete_subscription_notification_configuration method definition
def delete_subscription_notification_configuration(
self,
*,
subscriptionId: str,
) -> Dict[str, Any]:
...
# delete_subscription_notification_configuration method usage example with argument unpacking
kwargs: DeleteSubscriptionNotificationConfigurationRequestRequestTypeDef = { # (1)
"subscriptionId": ...,
}
parent.delete_subscription_notification_configuration(**kwargs)
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_datalake
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID.
Type annotations and code completion for boto3.client("securitylake").get_datalake
method.
boto3 documentation
# get_datalake method definition
def get_datalake(
self,
) -> GetDatalakeResponseTypeDef: # (1)
...
get_datalake_auto_enable
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_datalake_auto_enable
method.
boto3 documentation
# get_datalake_auto_enable method definition
def get_datalake_auto_enable(
self,
) -> GetDatalakeAutoEnableResponseTypeDef: # (1)
...
get_datalake_exceptions_expiry
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain.
Type annotations and code completion for boto3.client("securitylake").get_datalake_exceptions_expiry
method.
boto3 documentation
# get_datalake_exceptions_expiry method definition
def get_datalake_exceptions_expiry(
self,
) -> GetDatalakeExceptionsExpiryResponseTypeDef: # (1)
...
get_datalake_exceptions_subscription
Retrieves the details of exception notifications for the account in Amazon Security Lake.
Type annotations and code completion for boto3.client("securitylake").get_datalake_exceptions_subscription
method.
boto3 documentation
# get_datalake_exceptions_subscription method definition
def get_datalake_exceptions_subscription(
self,
) -> GetDatalakeExceptionsSubscriptionResponseTypeDef: # (1)
...
get_datalake_status
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_datalake_status
method.
boto3 documentation
# get_datalake_status method definition
def get_datalake_status(
self,
*,
accountSet: Sequence[str] = ...,
maxAccountResults: int = ...,
nextToken: str = ...,
) -> GetDatalakeStatusResponseTypeDef: # (1)
...
# get_datalake_status method usage example with argument unpacking
kwargs: GetDatalakeStatusRequestRequestTypeDef = { # (1)
"accountSet": ...,
}
parent.get_datalake_status(**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,
*,
id: str,
) -> GetSubscriberResponseTypeDef: # (1)
...
# get_subscriber method usage example with argument unpacking
kwargs: GetSubscriberRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_subscriber(**kwargs)
list_datalake_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_datalake_exceptions
method.
boto3 documentation
# list_datalake_exceptions method definition
def list_datalake_exceptions(
self,
*,
maxFailures: int = ...,
nextToken: str = ...,
regionSet: Sequence[RegionType] = ..., # (1)
) -> ListDatalakeExceptionsResponseTypeDef: # (2)
...
# list_datalake_exceptions method usage example with argument unpacking
kwargs: ListDatalakeExceptionsRequestRequestTypeDef = { # (1)
"maxFailures": ...,
}
parent.list_datalake_exceptions(**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,
*,
inputOrder: Sequence[DimensionType] = ..., # (1)
listAllDimensions: Mapping[str, Mapping[str, Sequence[str]]] = ...,
listSingleDimension: Sequence[str] = ...,
listTwoDimensions: Mapping[str, Sequence[str]] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListLogSourcesResponseTypeDef: # (2)
...
# list_log_sources method usage example with argument unpacking
kwargs: ListLogSourcesRequestRequestTypeDef = { # (1)
"inputOrder": ...,
}
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)
update_datalake
Specifies where to store your security data and for how long.
Type annotations and code completion for boto3.client("securitylake").update_datalake
method.
boto3 documentation
# update_datalake method definition
def update_datalake(
self,
*,
configurations: Mapping[RegionType, LakeConfigurationRequestTypeDef], # (1)
) -> Dict[str, Any]:
...
# update_datalake method usage example with argument unpacking
kwargs: UpdateDatalakeRequestRequestTypeDef = { # (1)
"configurations": ...,
}
parent.update_datalake(**kwargs)
update_datalake_exceptions_expiry
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.
Type annotations and code completion for boto3.client("securitylake").update_datalake_exceptions_expiry
method.
boto3 documentation
# update_datalake_exceptions_expiry method definition
def update_datalake_exceptions_expiry(
self,
*,
exceptionMessageExpiry: int,
) -> Dict[str, Any]:
...
# update_datalake_exceptions_expiry method usage example with argument unpacking
kwargs: UpdateDatalakeExceptionsExpiryRequestRequestTypeDef = { # (1)
"exceptionMessageExpiry": ...,
}
parent.update_datalake_exceptions_expiry(**kwargs)
update_datalake_exceptions_subscription
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
Type annotations and code completion for boto3.client("securitylake").update_datalake_exceptions_subscription
method.
boto3 documentation
# update_datalake_exceptions_subscription method definition
def update_datalake_exceptions_subscription(
self,
*,
notificationEndpoint: str,
subscriptionProtocol: SubscriptionProtocolTypeType, # (1)
) -> Dict[str, Any]:
...
# update_datalake_exceptions_subscription method usage example with argument unpacking
kwargs: UpdateDatalakeExceptionsSubscriptionRequestRequestTypeDef = { # (1)
"notificationEndpoint": ...,
"subscriptionProtocol": ...,
}
parent.update_datalake_exceptions_subscription(**kwargs)
update_subscriber
Updates an existing subscription for the given Amazon Security Lake account ID.
Type annotations and code completion for boto3.client("securitylake").update_subscriber
method.
boto3 documentation
# update_subscriber method definition
def update_subscriber(
self,
*,
id: str,
sourceTypes: Sequence[SourceTypeTypeDef], # (1)
externalId: str = ...,
subscriberDescription: str = ...,
subscriberName: str = ...,
) -> UpdateSubscriberResponseTypeDef: # (2)
...
# update_subscriber method usage example with argument unpacking
kwargs: UpdateSubscriberRequestRequestTypeDef = { # (1)
"id": ...,
"sourceTypes": ...,
}
parent.update_subscriber(**kwargs)
update_subscription_notification_configuration
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
Type annotations and code completion for boto3.client("securitylake").update_subscription_notification_configuration
method.
boto3 documentation
# update_subscription_notification_configuration method definition
def update_subscription_notification_configuration(
self,
*,
subscriptionId: str,
createSqs: bool = ...,
httpsApiKeyName: str = ...,
httpsApiKeyValue: str = ...,
httpsMethod: HttpsMethodType = ..., # (1)
roleArn: str = ...,
subscriptionEndpoint: str = ...,
) -> UpdateSubscriptionNotificationConfigurationResponseTypeDef: # (2)
...
# update_subscription_notification_configuration method usage example with argument unpacking
kwargs: UpdateSubscriptionNotificationConfigurationRequestRequestTypeDef = { # (1)
"subscriptionId": ...,
}
parent.update_subscription_notification_configuration(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("securitylake").get_paginator
method with overloads.
client.get_paginator("get_datalake_status")
-> GetDatalakeStatusPaginatorclient.get_paginator("list_datalake_exceptions")
-> ListDatalakeExceptionsPaginatorclient.get_paginator("list_log_sources")
-> ListLogSourcesPaginatorclient.get_paginator("list_subscribers")
-> ListSubscribersPaginator