Skip to content

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)
    ...
  1. See AwsLogSourceConfigurationTypeDef
  2. See CreateAwsLogSourceResponseTypeDef
# create_aws_log_source method usage example with argument unpacking

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

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

# create_custom_log_source method definition

def create_custom_log_source(
    self,
    *,
    configuration: CustomLogSourceConfigurationTypeDef,  # (1)
    sourceName: str,
    eventClasses: Sequence[str] = ...,
    sourceVersion: str = ...,
) -> CreateCustomLogSourceResponseTypeDef:  # (2)
    ...
  1. See CustomLogSourceConfigurationTypeDef
  2. See CreateCustomLogSourceResponseTypeDef
# create_custom_log_source method usage example with argument unpacking

kwargs: CreateCustomLogSourceRequestRequestTypeDef = {  # (1)
    "configuration": ...,
    "sourceName": ...,
}

parent.create_custom_log_source(**kwargs)
  1. See CreateCustomLogSourceRequestRequestTypeDef

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)
    ...
  1. See DataLakeConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateDataLakeResponseTypeDef
# create_data_lake method usage example with argument unpacking

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

parent.create_data_lake(**kwargs)
  1. See CreateDataLakeRequestRequestTypeDef

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)
  1. See CreateDataLakeExceptionSubscriptionRequestRequestTypeDef

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[Union[DataLakeAutoEnableNewAccountConfigurationTypeDef, DataLakeAutoEnableNewAccountConfigurationOutputTypeDef]] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DataLakeAutoEnableNewAccountConfigurationTypeDef DataLakeAutoEnableNewAccountConfigurationOutputTypeDef
# create_data_lake_organization_configuration method usage example with argument unpacking

kwargs: CreateDataLakeOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "autoEnableNewAccount": ...,
}

parent.create_data_lake_organization_configuration(**kwargs)
  1. See CreateDataLakeOrganizationConfigurationRequestRequestTypeDef

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)
    ...
  1. See LogSourceResourceTypeDef
  2. See AwsIdentityTypeDef
  3. See AccessTypeType
  4. See TagTypeDef
  5. See CreateSubscriberResponseTypeDef
# create_subscriber method usage example with argument unpacking

kwargs: CreateSubscriberRequestRequestTypeDef = {  # (1)
    "sources": ...,
    "subscriberIdentity": ...,
    "subscriberName": ...,
}

parent.create_subscriber(**kwargs)
  1. See CreateSubscriberRequestRequestTypeDef

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)
    ...
  1. See NotificationConfigurationTypeDef
  2. See CreateSubscriberNotificationResponseTypeDef
# create_subscriber_notification method usage example with argument unpacking

kwargs: CreateSubscriberNotificationRequestRequestTypeDef = {  # (1)
    "configuration": ...,
    "subscriberId": ...,
}

parent.create_subscriber_notification(**kwargs)
  1. See CreateSubscriberNotificationRequestRequestTypeDef

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)
    ...
  1. See AwsLogSourceConfigurationTypeDef
  2. See DeleteAwsLogSourceResponseTypeDef
# delete_aws_log_source method usage example with argument unpacking

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

parent.delete_aws_log_source(**kwargs)
  1. See DeleteAwsLogSourceRequestRequestTypeDef

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.