Skip to content

Type definitions#

Index > SecurityLake > Type definitions

Auto-generated documentation for SecurityLake type annotations stubs module mypy-boto3-securitylake.

AwsIdentityTypeDef#

# AwsIdentityTypeDef definition

class AwsIdentityTypeDef(TypedDict):
    externalId: str,
    principal: str,

AwsLogSourceConfigurationTypeDef#

# AwsLogSourceConfigurationTypeDef definition

class AwsLogSourceConfigurationTypeDef(TypedDict):
    regions: Sequence[str],
    sourceName: AwsLogSourceNameType,  # (1)
    accounts: NotRequired[Sequence[str]],
    sourceVersion: NotRequired[str],
  1. See AwsLogSourceNameType

AwsLogSourceResourceTypeDef#

# AwsLogSourceResourceTypeDef definition

class AwsLogSourceResourceTypeDef(TypedDict):
    sourceName: NotRequired[AwsLogSourceNameType],  # (1)
    sourceVersion: NotRequired[str],
  1. See AwsLogSourceNameType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateDataLakeExceptionSubscriptionRequestRequestTypeDef#

# CreateDataLakeExceptionSubscriptionRequestRequestTypeDef definition

class CreateDataLakeExceptionSubscriptionRequestRequestTypeDef(TypedDict):
    notificationEndpoint: str,
    subscriptionProtocol: str,
    exceptionTimeToLive: NotRequired[int],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

CustomLogSourceAttributesTypeDef#

# CustomLogSourceAttributesTypeDef definition

class CustomLogSourceAttributesTypeDef(TypedDict):
    crawlerArn: NotRequired[str],
    databaseArn: NotRequired[str],
    tableArn: NotRequired[str],

CustomLogSourceCrawlerConfigurationTypeDef#

# CustomLogSourceCrawlerConfigurationTypeDef definition

class CustomLogSourceCrawlerConfigurationTypeDef(TypedDict):
    roleArn: str,

CustomLogSourceProviderTypeDef#

# CustomLogSourceProviderTypeDef definition

class CustomLogSourceProviderTypeDef(TypedDict):
    location: NotRequired[str],
    roleArn: NotRequired[str],

DataLakeEncryptionConfigurationTypeDef#

# DataLakeEncryptionConfigurationTypeDef definition

class DataLakeEncryptionConfigurationTypeDef(TypedDict):
    kmsKeyId: NotRequired[str],

DataLakeReplicationConfigurationTypeDef#

# DataLakeReplicationConfigurationTypeDef definition

class DataLakeReplicationConfigurationTypeDef(TypedDict):
    regions: NotRequired[Sequence[str]],
    roleArn: NotRequired[str],

DataLakeExceptionTypeDef#

# DataLakeExceptionTypeDef definition

class DataLakeExceptionTypeDef(TypedDict):
    exception: NotRequired[str],
    region: NotRequired[str],
    remediation: NotRequired[str],
    timestamp: NotRequired[datetime],

DataLakeLifecycleExpirationTypeDef#

# DataLakeLifecycleExpirationTypeDef definition

class DataLakeLifecycleExpirationTypeDef(TypedDict):
    days: NotRequired[int],

DataLakeLifecycleTransitionTypeDef#

# DataLakeLifecycleTransitionTypeDef definition

class DataLakeLifecycleTransitionTypeDef(TypedDict):
    days: NotRequired[int],
    storageClass: NotRequired[str],

DataLakeSourceStatusTypeDef#

# DataLakeSourceStatusTypeDef definition

class DataLakeSourceStatusTypeDef(TypedDict):
    resource: NotRequired[str],
    status: NotRequired[SourceCollectionStatusType],  # (1)
  1. See SourceCollectionStatusType

DataLakeUpdateExceptionTypeDef#

# DataLakeUpdateExceptionTypeDef definition

class DataLakeUpdateExceptionTypeDef(TypedDict):
    code: NotRequired[str],
    reason: NotRequired[str],

DeleteCustomLogSourceRequestRequestTypeDef#

# DeleteCustomLogSourceRequestRequestTypeDef definition

class DeleteCustomLogSourceRequestRequestTypeDef(TypedDict):
    sourceName: str,
    sourceVersion: NotRequired[str],

DeleteDataLakeRequestRequestTypeDef#

# DeleteDataLakeRequestRequestTypeDef definition

class DeleteDataLakeRequestRequestTypeDef(TypedDict):
    regions: Sequence[str],

DeleteSubscriberNotificationRequestRequestTypeDef#

# DeleteSubscriberNotificationRequestRequestTypeDef definition

class DeleteSubscriberNotificationRequestRequestTypeDef(TypedDict):
    subscriberId: str,

DeleteSubscriberRequestRequestTypeDef#

# DeleteSubscriberRequestRequestTypeDef definition

class DeleteSubscriberRequestRequestTypeDef(TypedDict):
    subscriberId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetDataLakeSourcesRequestRequestTypeDef#

# GetDataLakeSourcesRequestRequestTypeDef definition

class GetDataLakeSourcesRequestRequestTypeDef(TypedDict):
    accounts: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetSubscriberRequestRequestTypeDef#

# GetSubscriberRequestRequestTypeDef definition

class GetSubscriberRequestRequestTypeDef(TypedDict):
    subscriberId: str,

HttpsNotificationConfigurationTypeDef#

# HttpsNotificationConfigurationTypeDef definition

class HttpsNotificationConfigurationTypeDef(TypedDict):
    endpoint: str,
    targetRoleArn: str,
    authorizationApiKeyName: NotRequired[str],
    authorizationApiKeyValue: NotRequired[str],
    httpMethod: NotRequired[HttpMethodType],  # (1)
  1. See HttpMethodType

ListDataLakeExceptionsRequestRequestTypeDef#

# ListDataLakeExceptionsRequestRequestTypeDef definition

class ListDataLakeExceptionsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    regions: NotRequired[Sequence[str]],

ListDataLakesRequestRequestTypeDef#

# ListDataLakesRequestRequestTypeDef definition

class ListDataLakesRequestRequestTypeDef(TypedDict):
    regions: NotRequired[Sequence[str]],

ListSubscribersRequestRequestTypeDef#

# ListSubscribersRequestRequestTypeDef definition

class ListSubscribersRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

RegisterDataLakeDelegatedAdministratorRequestRequestTypeDef#

# RegisterDataLakeDelegatedAdministratorRequestRequestTypeDef definition

class RegisterDataLakeDelegatedAdministratorRequestRequestTypeDef(TypedDict):
    accountId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateDataLakeExceptionSubscriptionRequestRequestTypeDef#

# UpdateDataLakeExceptionSubscriptionRequestRequestTypeDef definition

class UpdateDataLakeExceptionSubscriptionRequestRequestTypeDef(TypedDict):
    notificationEndpoint: str,
    subscriptionProtocol: str,
    exceptionTimeToLive: NotRequired[int],

CreateAwsLogSourceRequestRequestTypeDef#

# CreateAwsLogSourceRequestRequestTypeDef definition

class CreateAwsLogSourceRequestRequestTypeDef(TypedDict):
    sources: Sequence[AwsLogSourceConfigurationTypeDef],  # (1)
  1. See AwsLogSourceConfigurationTypeDef

DeleteAwsLogSourceRequestRequestTypeDef#

# DeleteAwsLogSourceRequestRequestTypeDef definition

class DeleteAwsLogSourceRequestRequestTypeDef(TypedDict):
    sources: Sequence[AwsLogSourceConfigurationTypeDef],  # (1)
  1. See AwsLogSourceConfigurationTypeDef

DataLakeAutoEnableNewAccountConfigurationTypeDef#

# DataLakeAutoEnableNewAccountConfigurationTypeDef definition

class DataLakeAutoEnableNewAccountConfigurationTypeDef(TypedDict):
    region: str,
    sources: Sequence[AwsLogSourceResourceTypeDef],  # (1)
  1. See AwsLogSourceResourceTypeDef

CreateAwsLogSourceResponseTypeDef#

# CreateAwsLogSourceResponseTypeDef definition

class CreateAwsLogSourceResponseTypeDef(TypedDict):
    failed: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSubscriberNotificationResponseTypeDef#

# CreateSubscriberNotificationResponseTypeDef definition

class CreateSubscriberNotificationResponseTypeDef(TypedDict):
    subscriberEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteAwsLogSourceResponseTypeDef#

# DeleteAwsLogSourceResponseTypeDef definition

class DeleteAwsLogSourceResponseTypeDef(TypedDict):
    failed: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDataLakeExceptionSubscriptionResponseTypeDef#

# GetDataLakeExceptionSubscriptionResponseTypeDef definition

class GetDataLakeExceptionSubscriptionResponseTypeDef(TypedDict):
    exceptionTimeToLive: int,
    notificationEndpoint: str,
    subscriptionProtocol: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSubscriberNotificationResponseTypeDef#

# UpdateSubscriberNotificationResponseTypeDef definition

class UpdateSubscriberNotificationResponseTypeDef(TypedDict):
    subscriberEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CustomLogSourceConfigurationTypeDef#

# CustomLogSourceConfigurationTypeDef definition

class CustomLogSourceConfigurationTypeDef(TypedDict):
    crawlerConfiguration: CustomLogSourceCrawlerConfigurationTypeDef,  # (1)
    providerIdentity: AwsIdentityTypeDef,  # (2)
  1. See CustomLogSourceCrawlerConfigurationTypeDef
  2. See AwsIdentityTypeDef

CustomLogSourceResourceTypeDef#

# CustomLogSourceResourceTypeDef definition

class CustomLogSourceResourceTypeDef(TypedDict):
    attributes: NotRequired[CustomLogSourceAttributesTypeDef],  # (1)
    provider: NotRequired[CustomLogSourceProviderTypeDef],  # (2)
    sourceName: NotRequired[str],
    sourceVersion: NotRequired[str],
  1. See CustomLogSourceAttributesTypeDef
  2. See CustomLogSourceProviderTypeDef

ListDataLakeExceptionsResponseTypeDef#

# ListDataLakeExceptionsResponseTypeDef definition

class ListDataLakeExceptionsResponseTypeDef(TypedDict):
    exceptions: List[DataLakeExceptionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeExceptionTypeDef
  2. See ResponseMetadataTypeDef

DataLakeLifecycleConfigurationTypeDef#

# DataLakeLifecycleConfigurationTypeDef definition

class DataLakeLifecycleConfigurationTypeDef(TypedDict):
    expiration: NotRequired[DataLakeLifecycleExpirationTypeDef],  # (1)
    transitions: NotRequired[Sequence[DataLakeLifecycleTransitionTypeDef]],  # (2)
  1. See DataLakeLifecycleExpirationTypeDef
  2. See DataLakeLifecycleTransitionTypeDef

DataLakeSourceTypeDef#

# DataLakeSourceTypeDef definition

class DataLakeSourceTypeDef(TypedDict):
    account: NotRequired[str],
    eventClasses: NotRequired[List[str]],
    sourceName: NotRequired[str],
    sourceStatuses: NotRequired[List[DataLakeSourceStatusTypeDef]],  # (1)
  1. See DataLakeSourceStatusTypeDef

DataLakeUpdateStatusTypeDef#

# DataLakeUpdateStatusTypeDef definition

class DataLakeUpdateStatusTypeDef(TypedDict):
    exception: NotRequired[DataLakeUpdateExceptionTypeDef],  # (1)
    requestId: NotRequired[str],
    status: NotRequired[DataLakeStatusType],  # (2)
  1. See DataLakeUpdateExceptionTypeDef
  2. See DataLakeStatusType

GetDataLakeSourcesRequestGetDataLakeSourcesPaginateTypeDef#

# GetDataLakeSourcesRequestGetDataLakeSourcesPaginateTypeDef definition

class GetDataLakeSourcesRequestGetDataLakeSourcesPaginateTypeDef(TypedDict):
    accounts: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDataLakeExceptionsRequestListDataLakeExceptionsPaginateTypeDef#

# ListDataLakeExceptionsRequestListDataLakeExceptionsPaginateTypeDef definition

class ListDataLakeExceptionsRequestListDataLakeExceptionsPaginateTypeDef(TypedDict):
    regions: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSubscribersRequestListSubscribersPaginateTypeDef#

# ListSubscribersRequestListSubscribersPaginateTypeDef definition

class ListSubscribersRequestListSubscribersPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

NotificationConfigurationTypeDef#

# NotificationConfigurationTypeDef definition

class NotificationConfigurationTypeDef(TypedDict):
    httpsNotificationConfiguration: NotRequired[HttpsNotificationConfigurationTypeDef],  # (1)
    sqsNotificationConfiguration: NotRequired[Mapping[str, Any]],
  1. See HttpsNotificationConfigurationTypeDef

CreateDataLakeOrganizationConfigurationRequestRequestTypeDef#

# CreateDataLakeOrganizationConfigurationRequestRequestTypeDef definition

class CreateDataLakeOrganizationConfigurationRequestRequestTypeDef(TypedDict):
    autoEnableNewAccount: NotRequired[Sequence[DataLakeAutoEnableNewAccountConfigurationTypeDef]],  # (1)
  1. See DataLakeAutoEnableNewAccountConfigurationTypeDef

DeleteDataLakeOrganizationConfigurationRequestRequestTypeDef#

# DeleteDataLakeOrganizationConfigurationRequestRequestTypeDef definition

class DeleteDataLakeOrganizationConfigurationRequestRequestTypeDef(TypedDict):
    autoEnableNewAccount: NotRequired[Sequence[DataLakeAutoEnableNewAccountConfigurationTypeDef]],  # (1)
  1. See DataLakeAutoEnableNewAccountConfigurationTypeDef

GetDataLakeOrganizationConfigurationResponseTypeDef#

# GetDataLakeOrganizationConfigurationResponseTypeDef definition

class GetDataLakeOrganizationConfigurationResponseTypeDef(TypedDict):
    autoEnableNewAccount: List[DataLakeAutoEnableNewAccountConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeAutoEnableNewAccountConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateCustomLogSourceRequestRequestTypeDef#

# CreateCustomLogSourceRequestRequestTypeDef definition

class CreateCustomLogSourceRequestRequestTypeDef(TypedDict):
    configuration: CustomLogSourceConfigurationTypeDef,  # (1)
    sourceName: str,
    eventClasses: NotRequired[Sequence[str]],
    sourceVersion: NotRequired[str],
  1. See CustomLogSourceConfigurationTypeDef

CreateCustomLogSourceResponseTypeDef#

# CreateCustomLogSourceResponseTypeDef definition

class CreateCustomLogSourceResponseTypeDef(TypedDict):
    source: CustomLogSourceResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomLogSourceResourceTypeDef
  2. See ResponseMetadataTypeDef

LogSourceResourceTypeDef#

# LogSourceResourceTypeDef definition

class LogSourceResourceTypeDef(TypedDict):
    awsLogSource: NotRequired[AwsLogSourceResourceTypeDef],  # (1)
    customLogSource: NotRequired[CustomLogSourceResourceTypeDef],  # (2)
  1. See AwsLogSourceResourceTypeDef
  2. See CustomLogSourceResourceTypeDef

DataLakeConfigurationTypeDef#

# DataLakeConfigurationTypeDef definition

class DataLakeConfigurationTypeDef(TypedDict):
    region: str,
    encryptionConfiguration: NotRequired[DataLakeEncryptionConfigurationTypeDef],  # (1)
    lifecycleConfiguration: NotRequired[DataLakeLifecycleConfigurationTypeDef],  # (2)
    replicationConfiguration: NotRequired[DataLakeReplicationConfigurationTypeDef],  # (3)
  1. See DataLakeEncryptionConfigurationTypeDef
  2. See DataLakeLifecycleConfigurationTypeDef
  3. See DataLakeReplicationConfigurationTypeDef

GetDataLakeSourcesResponseTypeDef#

# GetDataLakeSourcesResponseTypeDef definition

class GetDataLakeSourcesResponseTypeDef(TypedDict):
    dataLakeArn: str,
    dataLakeSources: List[DataLakeSourceTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeSourceTypeDef
  2. See ResponseMetadataTypeDef

DataLakeResourceTypeDef#

# DataLakeResourceTypeDef definition

class DataLakeResourceTypeDef(TypedDict):
    dataLakeArn: str,
    region: str,
    createStatus: NotRequired[DataLakeStatusType],  # (1)
    encryptionConfiguration: NotRequired[DataLakeEncryptionConfigurationTypeDef],  # (2)
    lifecycleConfiguration: NotRequired[DataLakeLifecycleConfigurationTypeDef],  # (3)
    replicationConfiguration: NotRequired[DataLakeReplicationConfigurationTypeDef],  # (4)
    s3BucketArn: NotRequired[str],
    updateStatus: NotRequired[DataLakeUpdateStatusTypeDef],  # (5)
  1. See DataLakeStatusType
  2. See DataLakeEncryptionConfigurationTypeDef
  3. See DataLakeLifecycleConfigurationTypeDef
  4. See DataLakeReplicationConfigurationTypeDef
  5. See DataLakeUpdateStatusTypeDef

CreateSubscriberNotificationRequestRequestTypeDef#

# CreateSubscriberNotificationRequestRequestTypeDef definition

class CreateSubscriberNotificationRequestRequestTypeDef(TypedDict):
    configuration: NotificationConfigurationTypeDef,  # (1)
    subscriberId: str,
  1. See NotificationConfigurationTypeDef

UpdateSubscriberNotificationRequestRequestTypeDef#

# UpdateSubscriberNotificationRequestRequestTypeDef definition

class UpdateSubscriberNotificationRequestRequestTypeDef(TypedDict):
    configuration: NotificationConfigurationTypeDef,  # (1)
    subscriberId: str,
  1. See NotificationConfigurationTypeDef

CreateSubscriberRequestRequestTypeDef#

# CreateSubscriberRequestRequestTypeDef definition

class CreateSubscriberRequestRequestTypeDef(TypedDict):
    sources: Sequence[LogSourceResourceTypeDef],  # (1)
    subscriberIdentity: AwsIdentityTypeDef,  # (2)
    subscriberName: str,
    accessTypes: NotRequired[Sequence[AccessTypeType]],  # (3)
    subscriberDescription: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See LogSourceResourceTypeDef
  2. See AwsIdentityTypeDef
  3. See AccessTypeType
  4. See <