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

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.

Usage example

client = boto3.client("securitylake")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.AccountNotFoundException,
    client.BucketNotFoundException,
    client.ClientError,
    client.ConcurrentModificationException,
    client.ConflictException,
    client.ConflictSourceNamesException,
    client.ConflictSubscriptionException,
    client.EventBridgeException,
    client.InternalServerException,
    client.InvalidInputException,
    client.ResourceNotFoundException,
    client.S3Exception,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

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

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

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)
    ...

1. See DimensionType
2. See CreateAwsLogSourceResponseTypeDef

Usage example with kwargs

kwargs: CreateAwsLogSourceRequestRequestTypeDef = {  # (1)
    "inputOrder": ...,
}

parent.create_aws_log_source(**kwargs)

1. See CreateAwsLogSourceRequestRequestTypeDef

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

Method definition

def create_custom_log_source(
    self,
    *,
    customSourceName: str,
    eventClass: OcsfEventClassType,  # (1)
    glueInvocationRoleArn: str,
    logProviderAccountId: str,
) -> CreateCustomLogSourceResponseTypeDef:  # (2)
    ...

1. See OcsfEventClassType
2. See CreateCustomLogSourceResponseTypeDef

Usage example with kwargs

kwargs: CreateCustomLogSourceRequestRequestTypeDef = {  # (1)
    "customSourceName": ...,
    "eventClass": ...,
    "glueInvocationRoleArn": ...,
    "logProviderAccountId": ...,
}

parent.create_custom_log_source(**kwargs)

1. See CreateCustomLogSourceRequestRequestTypeDef

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

Method definition

def create_datalake(
    self,
    *,
    configurations: Mapping[RegionType, LakeConfigurationRequestTypeDef] = ...,  # (1)
    enableAll: bool = ...,
    metaStoreManagerRoleArn: str = ...,
    regions: Sequence[RegionType] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See RegionType LakeConfigurationRequestTypeDef
2. See RegionType

Usage example with kwargs

kwargs: CreateDatalakeRequestRequestTypeDef = {  # (1)
    "configurations": ...,
}

parent.create_datalake(**kwargs)

1. See CreateDatalakeRequestRequestTypeDef

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

Method definition

def create_datalake_auto_enable(
    self,
    *,
    configurationForNewAccounts: Sequence[AutoEnableNewRegionConfigurationTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See AutoEnableNewRegionConfigurationTypeDef

Usage example with kwargs

kwargs: CreateDatalakeAutoEnableRequestRequestTypeDef = {  # (1)
    "configurationForNewAccounts": ...,
}

parent.create_datalake_auto_enable(**kwargs)

1. See CreateDatalakeAutoEnableRequestRequestTypeDef

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

Method definition

def create_datalake_delegated_admin(
    self,
    *,
    account: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: CreateDatalakeDelegatedAdminRequestRequestTypeDef = {  # (1)
    "account": ...,
}

parent.create_datalake_delegated_admin(**kwargs)

1. See CreateDatalakeDelegatedAdminRequestRequestTypeDef

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

Method definition

def create_datalake_exceptions_subscription(
    self,
    *,
    notificationEndpoint: str,
    subscriptionProtocol: SubscriptionProtocolTypeType,  # (1)
) -> Dict[str, Any]:
    ...

1. See SubscriptionProtocolTypeType

Usage example with kwargs

kwargs: CreateDatalakeExceptionsSubscriptionRequestRequestTypeDef = {  # (1)
    "notificationEndpoint": ...,
    "subscriptionProtocol": ...,
}

parent.create_datalake_exceptions_subscription(**kwargs)

1. See CreateDatalakeExceptionsSubscriptionRequestRequestTypeDef

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

Method definition

def create_subscriber(
    self,
    *,
    accountId: str,
    externalId: str,
    sourceTypes: Sequence[SourceTypeTypeDef],  # (1)
    subscriberName: str,
    accessTypes: Sequence[AccessTypeType] = ...,  # (2)
    subscriberDescription: str = ...,
) -> CreateSubscriberResponseTypeDef:  # (3)
    ...

1. See SourceTypeTypeDef
2. See AccessTypeType
3. See CreateSubscriberResponseTypeDef

Usage example with kwargs

kwargs: CreateSubscriberRequestRequestTypeDef = {  # (1)
    "accountId": ...,
    "externalId": ...,
    "sourceTypes": ...,
    "subscriberName": ...,
}

parent.create_subscriber(**kwargs)

1. See CreateSubscriberRequestRequestTypeDef

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

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)
    ...

1. See HttpsMethodType
2. See CreateSubscriptionNotificationConfigurationResponseTypeDef

Usage example with kwargs

kwargs: CreateSubscriptionNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "subscriptionId": ...,
}

parent.create_subscription_notification_configuration(**kwargs)

1. See CreateSubscriptionNotificationConfigurationRequestRequestTypeDef

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

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)
    ...

1. See DimensionType
2. See DeleteAwsLogSourceResponseTypeDef

Usage example with kwargs

kwargs: DeleteAwsLogSourceRequestRequestTypeDef = {  # (1)
    "inputOrder": ...,
}

parent.delete_aws_log_source(**kwargs)

1. See DeleteAwsLogSourceRequestRequestTypeDef

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

Method definition

def delete_custom_log_source(
    self,
    *,
    customSourceName: str,
) -> DeleteCustomLogSourceResponseTypeDef:  # (1)
    ...

1. See DeleteCustomLogSourceResponseTypeDef

Usage example with kwargs

kwargs: DeleteCustomLogSourceRequestRequestTypeDef = {  # (1)
    "customSourceName": ...,
}

parent.delete_custom_log_source(**kwargs)

1. See DeleteCustomLogSourceRequestRequestTypeDef

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

Method definition

def delete_datalake(
    self,
) -> Dict[str, Any]:
    ...

delete_datalake_auto_enable

Automatically deletes Amazon Security Lake to stop collecting security data.

Type annotations and code completion for boto3.client("securitylake").delete_datalake_auto_enable method. boto3 documentation

Method definition

def delete_datalake_auto_enable(
    self,
    *,
    removeFromConfigurationForNewAccounts: Sequence[AutoEnableNewRegionConfigurationTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See AutoEnableNewRegionConfigurationTypeDef

Usage example with kwargs

kwargs: DeleteDatalakeAutoEnableRequestRequestTypeDef = {  # (1)
    "removeFromConfigurationForNewAccounts": ...,
}

parent.delete_datalake_auto_enable(**kwargs)

1. See DeleteDatalakeAutoEnableRequestRequestTypeDef

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

Method definition

def delete_datalake_delegated_admin(
    self,
    *,
    account: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteDatalakeDelegatedAdminRequestRequestTypeDef = {  # (1)
    "account": ...,
}

parent.delete_datalake_delegated_admin(**kwargs)

1. See DeleteDatalakeDelegatedAdminRequestRequestTypeDef

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

Method definition

def delete_datalake_exceptions_subscription(
    self,
) -> DeleteDatalakeExceptionsSubscriptionResponseTypeDef:  # (1)
    ...

1. See DeleteDatalakeExceptionsSubscriptionResponseTypeDef

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

Method definition

def delete_subscriber(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteSubscriberRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_subscriber(**kwargs)

1. See DeleteSubscriberRequestRequestTypeDef

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

Method definition

def delete_subscription_notification_configuration(
    self,
    *,
    subscriptionId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteSubscriptionNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "subscriptionId": ...,
}

parent.delete_subscription_notification_configuration(**kwargs)

1. See DeleteSubscriptionNotificationConfigurationRequestRequestTypeDef

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

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

Method definition

def get_datalake(
    self,
) -> GetDatalakeResponseTypeDef:  # (1)
    ...

1. See GetDatalakeResponseTypeDef

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

Method definition

def get_datalake_auto_enable(
    self,
) -> GetDatalakeAutoEnableResponseTypeDef:  # (1)
    ...

1. See GetDatalakeAutoEnableResponseTypeDef

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

Method definition

def get_datalake_exceptions_expiry(
    self,
) -> GetDatalakeExceptionsExpiryResponseTypeDef:  # (1)
    ...

1. See GetDatalakeExceptionsExpiryResponseTypeDef

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

Method definition

def get_datalake_exceptions_subscription(
    self,
) -> GetDatalakeExceptionsSubscriptionResponseTypeDef:  # (1)
    ...

1. See GetDatalakeExceptionsSubscriptionResponseTypeDef

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

Method definition

def get_datalake_status(
    self,
    *,
    accountSet: Sequence[str] = ...,
    maxAccountResults: int = ...,
    nextToken: str = ...,
) -> GetDatalakeStatusResponseTypeDef:  # (1)
    ...

1. See GetDatalakeStatusResponseTypeDef

Usage example with kwargs

kwargs: GetDatalakeStatusRequestRequestTypeDef = {  # (1)
    "accountSet": ...,
}

parent.get_datalake_status(**kwargs)

1. See GetDatalakeStatusRequestRequestTypeDef

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

Method definition

def get_subscriber(
    self,
    *,
    id: str,
) -> GetSubscriberResponseTypeDef:  # (1)
    ...

1. See GetSubscriberResponseTypeDef

Usage example with kwargs

kwargs: GetSubscriberRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_subscriber(**kwargs)

1. See GetSubscriberRequestRequestTypeDef

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

Method definition

def list_datalake_exceptions(
    self,
    *,
    maxFailures: int = ...,
    nextToken: str = ...,
    regionSet: Sequence[RegionType] = ...,  # (1)
) -> ListDatalakeExceptionsResponseTypeDef:  # (2)
    ...

1. See RegionType
2. See ListDatalakeExceptionsResponseTypeDef

Usage example with kwargs

kwargs: ListDatalakeExceptionsRequestRequestTypeDef = {  # (1)
    "maxFailures": ...,
}

parent.list_datalake_exceptions(**kwargs)

1. See ListDatalakeExceptionsRequestRequestTypeDef

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

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)
    ...

1. See DimensionType
2. See ListLogSourcesResponseTypeDef

Usage example with kwargs

kwargs: ListLogSourcesRequestRequestTypeDef = {  # (1)
    "inputOrder": ...,
}

parent.list_log_sources(**kwargs)

1. See ListLogSourcesRequestRequestTypeDef

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

Method definition

def list_subscribers(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSubscribersResponseTypeDef:  # (1)
    ...

1. See ListSubscribersResponseTypeDef

Usage example with kwargs

kwargs: ListSubscribersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_subscribers(**kwargs)

1. See ListSubscribersRequestRequestTypeDef

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

Method definition

def update_datalake(
    self,
    *,
    configurations: Mapping[RegionType, LakeConfigurationRequestTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See RegionType LakeConfigurationRequestTypeDef

Usage example with kwargs

kwargs: UpdateDatalakeRequestRequestTypeDef = {  # (1)
    "configurations": ...,
}

parent.update_datalake(**kwargs)

1. See UpdateDatalakeRequestRequestTypeDef

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

Method definition

def update_datalake_exceptions_expiry(
    self,
    *,
    exceptionMessageExpiry: int,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateDatalakeExceptionsExpiryRequestRequestTypeDef = {  # (1)
    "exceptionMessageExpiry": ...,
}

parent.update_datalake_exceptions_expiry(**kwargs)

1. See UpdateDatalakeExceptionsExpiryRequestRequestTypeDef

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

Method definition

def update_datalake_exceptions_subscription(
    self,
    *,
    notificationEndpoint: str,
    subscriptionProtocol: SubscriptionProtocolTypeType,  # (1)
) -> Dict[str, Any]:
    ...

1. See SubscriptionProtocolTypeType

Usage example with kwargs

kwargs: UpdateDatalakeExceptionsSubscriptionRequestRequestTypeDef = {  # (1)
    "notificationEndpoint": ...,
    "subscriptionProtocol": ...,
}

parent.update_datalake_exceptions_subscription(**kwargs)

1. See UpdateDatalakeExceptionsSubscriptionRequestRequestTypeDef

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

Method definition

def update_subscriber(
    self,
    *,
    id: str,
    sourceTypes: Sequence[SourceTypeTypeDef],  # (1)
    externalId: str = ...,
    subscriberDescription: str = ...,
    subscriberName: str = ...,
) -> UpdateSubscriberResponseTypeDef:  # (2)
    ...

1. See SourceTypeTypeDef
2. See UpdateSubscriberResponseTypeDef

Usage example with kwargs

kwargs: UpdateSubscriberRequestRequestTypeDef = {  # (1)
    "id": ...,
    "sourceTypes": ...,
}

parent.update_subscriber(**kwargs)

1. See UpdateSubscriberRequestRequestTypeDef

update_subscription_notification_configuration

Creates a new subscription notification or adds the existing subscription notification setting for the specified subscription ID.

Type annotations and code completion for boto3.client("securitylake").update_subscription_notification_configuration method. boto3 documentation

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)
    ...

1. See HttpsMethodType
2. See UpdateSubscriptionNotificationConfigurationResponseTypeDef

Usage example with kwargs

kwargs: UpdateSubscriptionNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "subscriptionId": ...,
}

parent.update_subscription_notification_configuration(**kwargs)

1. See UpdateSubscriptionNotificationConfigurationRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("securitylake").get_paginator method with overloads.

• client.get_paginator("get_datalake_status") -> GetDatalakeStatusPaginator
• client.get_paginator("list_datalake_exceptions") -> ListDatalakeExceptionsPaginator
• client.get_paginator("list_log_sources") -> ListLogSourcesPaginator
• client.get_paginator("list_subscribers") -> ListSubscribersPaginator