SecurityLake

Client

class SecurityLake.Client

A low-level client representing Amazon Security Lake

Note

Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms ("Betas and Previews").

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.

Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).

Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.

client = session.create_client('securitylake')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_aws_log_source(**kwargs)

Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.

You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.

See also: AWS API Documentation

Request Syntax

response = client.create_aws_log_source(
    enableAllDimensions={
        'string': {
            'string': [
                'string',
            ]
        }
    },
    enableSingleDimension=[
        'string',
    ],
    enableTwoDimensions={
        'string': [
            'string',
        ]
    },
    inputOrder=[
        'REGION'|'SOURCE_TYPE'|'MEMBER',
    ]
)
Parameters
  • enableAllDimensions (dict) --

    Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.

    • (string) --
      • (dict) --
        • (string) --
          • (list) --
            • (string) --
  • enableSingleDimension (list) --

    Enables data collection from all Amazon Web Services sources in specific accounts or Regions.

    • (string) --
  • enableTwoDimensions (dict) --

    Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.

    • (string) --
      • (list) --
        • (string) --
  • inputOrder (list) --

    [REQUIRED]

    Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'failed': [
        'string',
    ],
    'processing': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • failed (list) --

      Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.

      • (string) --
    • processing (list) --

      Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.

      • (string) --

Exceptions

create_custom_log_source(**kwargs)

Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source in addition to an associated Glue table and an Glue crawler.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_log_source(
    customSourceName='string',
    eventClass='ACCESS_ACTIVITY'|'FILE_ACTIVITY'|'KERNEL_ACTIVITY'|'KERNEL_EXTENSION'|'MEMORY_ACTIVITY'|'MODULE_ACTIVITY'|'PROCESS_ACTIVITY'|'REGISTRY_KEY_ACTIVITY'|'REGISTRY_VALUE_ACTIVITY'|'RESOURCE_ACTIVITY'|'SCHEDULED_JOB_ACTIVITY'|'SECURITY_FINDING'|'ACCOUNT_CHANGE'|'AUTHENTICATION'|'AUTHORIZATION'|'ENTITY_MANAGEMENT_AUDIT'|'DHCP_ACTIVITY'|'NETWORK_ACTIVITY'|'DNS_ACTIVITY'|'FTP_ACTIVITY'|'HTTP_ACTIVITY'|'RDP_ACTIVITY'|'SMB_ACTIVITY'|'SSH_ACTIVITY'|'CLOUD_API'|'CONTAINER_LIFECYCLE'|'DATABASE_LIFECYCLE'|'CONFIG_STATE'|'CLOUD_STORAGE'|'INVENTORY_INFO'|'RFB_ACTIVITY'|'SMTP_ACTIVITY'|'VIRTUAL_MACHINE_ACTIVITY',
    glueInvocationRoleArn='string',
    logProviderAccountId='string'
)
Parameters
  • customSourceName (string) --

    [REQUIRED]

    The name for a third-party custom source. This must be a Regionally unique value.

  • eventClass (string) --

    [REQUIRED]

    The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.

  • glueInvocationRoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:

    • The managed policy AWSGlueServiceRole
    • A custom policy granting access to your Amazon S3 Data Lake
  • logProviderAccountId (string) --

    [REQUIRED]

    The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

Return type

dict

Returns

Response Syntax

{
    'customDataLocation': 'string',
    'glueCrawlerName': 'string',
    'glueDatabaseName': 'string',
    'glueTableName': 'string',
    'logProviderAccessRoleArn': 'string'
}

Response Structure

  • (dict) --

    • customDataLocation (string) --

      The location of the partition in the Amazon S3 bucket for Security Lake.

    • glueCrawlerName (string) --

      The name of the Glue crawler.

    • glueDatabaseName (string) --

      The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/* .

    • glueTableName (string) --

      The table name of the Glue crawler.

    • logProviderAccessRoleArn (string) --

      The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.

Exceptions

create_datalake(**kwargs)

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. You can either use the enableAll parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions parameter and then configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.

When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_datalake(
    configurations={
        'string': {
            'encryptionKey': 'string',
            'replicationDestinationRegions': [
                'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            ],
            'replicationRoleArn': 'string',
            'retentionSettings': [
                {
                    'retentionPeriod': 123,
                    'storageClass': 'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER_IR'|'GLACIER'|'DEEP_ARCHIVE'|'EXPIRE'
                },
            ],
            'tagsMap': {
                'string': 'string'
            }
        }
    },
    enableAll=True|False,
    metaStoreManagerRoleArn='string',
    regions=[
        'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
    ]
)
Parameters
  • configurations (dict) --

    Specify the Region or Regions that will contribute data to the rollup region.

    • (string) --
      • (dict) --

        Provides details of Amazon Security Lake configuration object.

        • encryptionKey (string) --

          The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.

        • replicationDestinationRegions (list) --

          Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.

          Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

          • (string) --
        • replicationRoleArn (string) --

          Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

        • retentionSettings (list) --

          Retention settings for the destination Amazon S3 buckets.

          • (dict) --

            Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.

            • retentionPeriod (integer) --

              The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

            • storageClass (string) --

              The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

        • tagsMap (dict) --

          A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

          • (string) --
            • (string) --
  • enableAll (boolean) -- Enable Security Lake in all Regions.
  • metaStoreManagerRoleArn (string) -- The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
  • regions (list) --

    Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

create_datalake_auto_enable(**kwargs)

Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.

See also: AWS API Documentation

Request Syntax

response = client.create_datalake_auto_enable(
    configurationForNewAccounts=[
        {
            'region': 'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            'sources': [
                'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
            ]
        },
    ]
)
Parameters
configurationForNewAccounts (list) --

[REQUIRED]

Enable Security Lake with the specified configuration settings to begin collecting security data for new accounts in your organization.

  • (dict) --

    Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.

    • region (string) -- [REQUIRED]

      The Amazon Web Services Regions where Security Lake is automatically enabled.

    • sources (list) -- [REQUIRED]

      The Amazon Web Services sources that are automatically enabled in Security Lake.

      • (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

create_datalake_delegated_admin(**kwargs)

Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

See also: AWS API Documentation

Request Syntax

response = client.create_datalake_delegated_admin(
    account='string'
)
Parameters
account (string) --

[REQUIRED]

The Amazon Web Services account ID of the Security Lake delegated administrator.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

create_datalake_exceptions_subscription(**kwargs)

Creates the specified notification subscription in Amazon Security Lake for the organization you specify.

See also: AWS API Documentation

Request Syntax

response = client.create_datalake_exceptions_subscription(
    notificationEndpoint='string',
    subscriptionProtocol='HTTP'|'HTTPS'|'EMAIL'|'EMAIL_JSON'|'SMS'|'SQS'|'LAMBDA'|'APP'|'FIREHOSE'
)
Parameters
  • notificationEndpoint (string) --

    [REQUIRED]

    The Amazon Web Services account where you want to receive exception notifications.

  • subscriptionProtocol (string) --

    [REQUIRED]

    The subscription protocol to which exception notifications are posted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

create_subscriber(**kwargs)

Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.create_subscriber(
    accessTypes=[
        'LAKEFORMATION'|'S3',
    ],
    accountId='string',
    externalId='string',
    sourceTypes=[
        {
            'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
            'customSourceType': 'string'
        },
    ],
    subscriberDescription='string',
    subscriberName='string'
)
Parameters
  • accessTypes (list) --

    The Amazon S3 or Lake Formation access type.

    • (string) --
  • accountId (string) --

    [REQUIRED]

    The Amazon Web Services account ID used to access your data.

  • externalId (string) --

    [REQUIRED]

    The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

  • sourceTypes (list) --

    [REQUIRED]

    The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

    • (dict) --

      The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: awsSourceType, customSourceType.

      • awsSourceType (string) --

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

      • customSourceType (string) --

        Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

  • subscriberDescription (string) -- The description for your subscriber account in Security Lake.
  • subscriberName (string) --

    [REQUIRED]

    The name of your Security Lake subscriber account.

Return type

dict

Returns

Response Syntax

{
    'roleArn': 'string',
    's3BucketArn': 'string',
    'snsArn': 'string',
    'subscriptionId': 'string'
}

Response Structure

  • (dict) --

    • roleArn (string) --

      The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see IAM identifiers in the Identity and Access Management (IAM) User Guide. .

    • s3BucketArn (string) --

      The ARN for the Amazon S3 bucket.

    • snsArn (string) --

      The ARN for the Amazon Simple Notification Service.

    • subscriptionId (string) --

      The subscriptionId created by the CreateSubscriber API call.

Exceptions

create_subscription_notification_configuration(**kwargs)

Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.

See also: AWS API Documentation

Request Syntax

response = client.create_subscription_notification_configuration(
    createSqs=True|False,
    httpsApiKeyName='string',
    httpsApiKeyValue='string',
    httpsMethod='POST'|'PUT',
    roleArn='string',
    subscriptionEndpoint='string',
    subscriptionId='string'
)
Parameters
  • createSqs (boolean) -- Create an Amazon Simple Queue Service queue.
  • httpsApiKeyName (string) -- The key name for the notification subscription.
  • httpsApiKeyValue (string) -- The key value for the notification subscription.
  • httpsMethod (string) -- The HTTPS method used for the notification subscription.
  • roleArn (string) -- The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.
  • subscriptionEndpoint (string) -- The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
  • subscriptionId (string) --

    [REQUIRED]

    The subscription ID for the notification subscription/

Return type

dict

Returns

Response Syntax

{
    'queueArn': 'string'
}

Response Structure

  • (dict) --

    • queueArn (string) --

      Returns the Amazon Resource Name (ARN) of the queue.

Exceptions

delete_aws_log_source(**kwargs)

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.

You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.

When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.

See also: AWS API Documentation

Request Syntax

response = client.delete_aws_log_source(
    disableAllDimensions={
        'string': {
            'string': [
                'string',
            ]
        }
    },
    disableSingleDimension=[
        'string',
    ],
    disableTwoDimensions={
        'string': [
            'string',
        ]
    },
    inputOrder=[
        'REGION'|'SOURCE_TYPE'|'MEMBER',
    ]
)
Parameters
  • disableAllDimensions (dict) --

    Removes the specific Amazon Web Services sources from specific accounts and specific Regions.

    • (string) --
      • (dict) --
        • (string) --
          • (list) --
            • (string) --
  • disableSingleDimension (list) --

    Removes all Amazon Web Services sources from specific accounts or Regions.

    • (string) --
  • disableTwoDimensions (dict) --

    Remove a specific Amazon Web Services source from specific accounts or Regions.

    • (string) --
      • (list) --
        • (string) --
  • inputOrder (list) --

    [REQUIRED]

    This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'failed': [
        'string',
    ],
    'processing': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • failed (list) --

      Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

      • (string) --
    • processing (list) --

      Deletion of the Amazon Web Services sources is in progress.

      • (string) --

Exceptions

delete_custom_log_source(**kwargs)

Removes a custom log source from Amazon Security Lake.

See also: AWS API Documentation

Request Syntax

response = client.delete_custom_log_source(
    customSourceName='string'
)
Parameters
customSourceName (string) --

[REQUIRED]

The custom source name for the custom log source.

Return type
dict
Returns
Response Syntax
{
    'customDataLocation': 'string'
}

Response Structure

  • (dict) --
    • customDataLocation (string) --

      The location of the partition in the Amazon S3 bucket for Security Lake.

Exceptions

delete_datalake()

When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .

This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. The DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_datalake()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_datalake_auto_enable(**kwargs)

Automatically deletes Amazon Security Lake to stop collecting security data. When you delete Amazon Security Lake from your account, Security Lake is disabled in all Regions. Also, this API automatically takes steps to remove the account from Security Lake .

This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. The DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_datalake_auto_enable(
    removeFromConfigurationForNewAccounts=[
        {
            'region': 'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            'sources': [
                'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
            ]
        },
    ]
)
Parameters
removeFromConfigurationForNewAccounts (list) --

[REQUIRED]

Delete Amazon Security Lake with the specified configuration settings to stop ingesting security data for new accounts in Security Lake.

  • (dict) --

    Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.

    • region (string) -- [REQUIRED]

      The Amazon Web Services Regions where Security Lake is automatically enabled.

    • sources (list) -- [REQUIRED]

      The Amazon Web Services sources that are automatically enabled in Security Lake.

      • (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_datalake_delegated_admin(**kwargs)

Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

See also: AWS API Documentation

Request Syntax

response = client.delete_datalake_delegated_admin(
    account='string'
)
Parameters
account (string) --

[REQUIRED]

The account ID the Security Lake delegated administrator.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_datalake_exceptions_subscription()

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

See also: AWS API Documentation

Request Syntax

response = client.delete_datalake_exceptions_subscription()
Return type
dict
Returns
Response Syntax
{
    'status': 'string'
}

Response Structure

  • (dict) --
    • status (string) --

      Retrieves the status of the delete Security Lake operation for an account.

Exceptions

delete_subscriber(**kwargs)

Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.delete_subscriber(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_subscription_notification_configuration(**kwargs)

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

See also: AWS API Documentation

Request Syntax

response = client.delete_subscription_notification_configuration(
    subscriptionId='string'
)
Parameters
subscriptionId (string) --

[REQUIRED]

The ID of the Security Lake subscriber account.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_datalake()

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake API to know whether Security Lake is enabled for the current Region. This API does not take input parameters.

See also: AWS API Documentation

Request Syntax

response = client.get_datalake()
Return type
dict
Returns
Response Syntax
{
    'configurations': {
        'string': {
            'encryptionKey': 'string',
            'replicationDestinationRegions': [
                'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            ],
            'replicationRoleArn': 'string',
            'retentionSettings': [
                {
                    'retentionPeriod': 123,
                    'storageClass': 'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER_IR'|'GLACIER'|'DEEP_ARCHIVE'|'EXPIRE'
                },
            ],
            's3BucketArn': 'string',
            'status': 'INITIALIZED'|'PENDING'|'COMPLETED'|'FAILED',
            'tagsMap': {
                'string': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --
    • configurations (dict) --

      Retrieves the Security Lake configuration object.

      • (string) --
        • (dict) --

          Provides details of Amazon Security Lake lake configuration object.

          • encryptionKey (string) --

            The type of encryption key used by secure the Security Lake configuration object.

          • replicationDestinationRegions (list) --

            Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.

            Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

            • (string) --
          • replicationRoleArn (string) --

            Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.

          • retentionSettings (list) --

            Retention settings for the destination Amazon S3 buckets.

            • (dict) --

              Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.

              • retentionPeriod (integer) --

                The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

              • storageClass (string) --

                The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

          • s3BucketArn (string) --

            Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.

          • status (string) --

            Retrieves the status of the configuration operation for an account in Amazon Security Lake.

          • tagsMap (dict) --

            A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

            • (string) --
              • (string) --

Exceptions

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. This API does not take input parameters.

See also: AWS API Documentation

Request Syntax

response = client.get_datalake_auto_enable()
Return type
dict
Returns
Response Syntax
{
    'autoEnableNewAccounts': [
        {
            'region': 'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            'sources': [
                'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • autoEnableNewAccounts (list) --

      The configuration for new accounts.

      • (dict) --

        Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.

        • region (string) --

          The Amazon Web Services Regions where Security Lake is automatically enabled.

        • sources (list) --

          The Amazon Web Services sources that are automatically enabled in Security Lake.

          • (string) --

Exceptions

get_datalake_exceptions_expiry()

Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.

See also: AWS API Documentation

Request Syntax

response = client.get_datalake_exceptions_expiry()
Return type
dict
Returns
Response Syntax
{
    'exceptionMessageExpiry': 123
}

Response Structure

  • (dict) --
    • exceptionMessageExpiry (integer) --

      The expiration period and time-to-live (TTL).

Exceptions

get_datalake_exceptions_subscription()

Retrieves the details of exception notifications for the account in Amazon Security Lake.

See also: AWS API Documentation

Request Syntax

response = client.get_datalake_exceptions_subscription()
Return type
dict
Returns
Response Syntax
{
    'protocolAndNotificationEndpoint': {
        'endpoint': 'string',
        'protocol': 'string'
    }
}

Response Structure

  • (dict) --
    • protocolAndNotificationEndpoint (dict) --

      Retrieves the exception notification subscription information.

      • endpoint (string) --

        The account that is subscribed to receive exception notifications.

      • protocol (string) --

        The protocol to which notification messages are posted.

Exceptions

get_datalake_status(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_datalake_status(
    accountSet=[
        'string',
    ],
    maxAccountResults=123,
    nextToken='string'
)
Parameters
  • accountSet (list) --

    The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

    • (string) --
  • maxAccountResults (integer) -- The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
  • nextToken (string) --

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Return type

dict

Returns

Response Syntax

{
    'accountSourcesList': [
        {
            'account': 'string',
            'eventClass': 'ACCESS_ACTIVITY'|'FILE_ACTIVITY'|'KERNEL_ACTIVITY'|'KERNEL_EXTENSION'|'MEMORY_ACTIVITY'|'MODULE_ACTIVITY'|'PROCESS_ACTIVITY'|'REGISTRY_KEY_ACTIVITY'|'REGISTRY_VALUE_ACTIVITY'|'RESOURCE_ACTIVITY'|'SCHEDULED_JOB_ACTIVITY'|'SECURITY_FINDING'|'ACCOUNT_CHANGE'|'AUTHENTICATION'|'AUTHORIZATION'|'ENTITY_MANAGEMENT_AUDIT'|'DHCP_ACTIVITY'|'NETWORK_ACTIVITY'|'DNS_ACTIVITY'|'FTP_ACTIVITY'|'HTTP_ACTIVITY'|'RDP_ACTIVITY'|'SMB_ACTIVITY'|'SSH_ACTIVITY'|'CLOUD_API'|'CONTAINER_LIFECYCLE'|'DATABASE_LIFECYCLE'|'CONFIG_STATE'|'CLOUD_STORAGE'|'INVENTORY_INFO'|'RFB_ACTIVITY'|'SMTP_ACTIVITY'|'VIRTUAL_MACHINE_ACTIVITY',
            'logsStatus': [
                {
                    'healthStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING',
                    'pathToLogs': 'string'
                },
            ],
            'sourceType': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • accountSourcesList (list) --

      The list of enabled accounts and enabled sources.

      • (dict) --

        Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

        • account (string) --

          The ID of the Security Lake account for which logs are collected.

        • eventClass (string) --

          Initializes a new instance of the Event class.

        • logsStatus (list) --

          The log status for the Security Lake account.

          • (dict) --

            Retrieves the Logs status for the Amazon Security Lake account.

            • healthStatus (string) --

              The health status of services, including error codes and patterns.

            • pathToLogs (string) --

              Defines path the stored logs are available which has information on your systems, applications, and services.

        • sourceType (string) --

          The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

    • nextToken (string) --

      Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_subscriber(**kwargs)

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

See also: AWS API Documentation

Request Syntax

response = client.get_subscriber(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.

Return type
dict
Returns
Response Syntax
{
    'subscriber': {
        'accessTypes': [
            'LAKEFORMATION'|'S3',
        ],
        'accountId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'externalId': 'string',
        'roleArn': 'string',
        's3BucketArn': 'string',
        'snsArn': 'string',
        'sourceTypes': [
            {
                'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
                'customSourceType': 'string'
            },
        ],
        'subscriberDescription': 'string',
        'subscriberName': 'string',
        'subscriptionEndpoint': 'string',
        'subscriptionId': 'string',
        'subscriptionProtocol': 'HTTPS'|'SQS',
        'subscriptionStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • subscriber (dict) --

      The subscription information for the specified subscription ID.

      • accessTypes (list) --

        You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

        Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

        • (string) --
      • accountId (string) --

        The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

      • createdAt (datetime) --

        The date and time when the subscription was created.

      • externalId (string) --

        The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

      • roleArn (string) --

        The Amazon Resource Name (ARN) specifying the role of the subscriber.

      • s3BucketArn (string) --

        The ARN for the Amazon S3 bucket.

      • snsArn (string) --

        The ARN for the Amazon Simple Notification Service.

      • sourceTypes (list) --

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

        • (dict) --

          The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: awsSourceType, customSourceType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • awsSourceType (string) --

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

          • customSourceType (string) --

            Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

      • subscriberDescription (string) --

        The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriptionId .

      • subscriberName (string) --

        The name of your Amazon Security Lake subscriber account.

      • subscriptionEndpoint (string) --

        The subscription endpoint to which exception messages are posted.

      • subscriptionId (string) --

        The subscription ID of the Amazon Security Lake subscriber account.

      • subscriptionProtocol (string) --

        The subscription protocol to which exception messages are posted.

      • subscriptionStatus (string) --

        The subscription status of the Amazon Security Lake subscriber account.

      • updatedAt (datetime) --

        The date and time when the subscription was created.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_datalake_exceptions(**kwargs)

Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.

See also: AWS API Documentation

Request Syntax

response = client.list_datalake_exceptions(
    maxFailures=123,
    nextToken='string',
    regionSet=[
        'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
    ]
)
Parameters
  • maxFailures (integer) -- List the maximum number of failures in Security Lake.
  • nextToken (string) --

    List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • regionSet (list) --

    List the Amazon Web Services Regions from which exceptions are retrieved.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'nonRetryableFailures': [
        {
            'failures': [
                {
                    'exceptionMessage': 'string',
                    'remediation': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ],
            'region': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

      Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    • nonRetryableFailures (list) --

      Lists the failures that cannot be retried in the current Region.

      • (dict) --

        Response element for actions that make changes, namely create, update, or delete actions.

        • failures (list) --

          List of all failures.

          • (dict) --

            List of all failures.

            • exceptionMessage (string) --

              List of all exception messages.

            • remediation (string) --

              List of all remediation steps for failures.

            • timestamp (datetime) --

              This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.

        • region (string) --

          List of Amazon Web Services Regions where the failure occurred.

Exceptions

list_log_sources(**kwargs)

Retrieves the log sources in the current Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.list_log_sources(
    inputOrder=[
        'REGION'|'SOURCE_TYPE'|'MEMBER',
    ],
    listAllDimensions={
        'string': {
            'string': [
                'string',
            ]
        }
    },
    listSingleDimension=[
        'string',
    ],
    listTwoDimensions={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters
  • inputOrder (list) --

    Lists the log sources in input order, namely Region, source type, and member account.

    • (string) --
  • listAllDimensions (dict) --

    List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.

    • (string) --
      • (dict) --
        • (string) --
          • (list) --
            • (string) --
  • listSingleDimension (list) --

    List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.

    • (string) --
  • listTwoDimensions (dict) --

    Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.

    • (string) --
      • (list) --
        • (string) --
  • maxResults (integer) -- The maximum number of accounts for which the log sources are displayed.
  • nextToken (string) -- If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'regionSourceTypesAccountsList': [
        {
            'string': {
                'string': [
                    'string',
                ]
            }
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

    • regionSourceTypesAccountsList (list) --

      Lists the log sources by Regions for enabled Security Lake accounts.

      • (dict) --
        • (string) --
          • (dict) --
            • (string) --
              • (list) --
                • (string) --

Exceptions

list_subscribers(**kwargs)

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_subscribers(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of accounts for which the configuration is displayed.
  • nextToken (string) -- If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'subscribers': [
        {
            'accessTypes': [
                'LAKEFORMATION'|'S3',
            ],
            'accountId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'externalId': 'string',
            'roleArn': 'string',
            's3BucketArn': 'string',
            'snsArn': 'string',
            'sourceTypes': [
                {
                    'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
                    'customSourceType': 'string'
                },
            ],
            'subscriberDescription': 'string',
            'subscriberName': 'string',
            'subscriptionEndpoint': 'string',
            'subscriptionId': 'string',
            'subscriptionProtocol': 'HTTPS'|'SQS',
            'subscriptionStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

    • subscribers (list) --

      The subscribers available for the specified Security Lake account ID.

      • (dict) --

        Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

        • accessTypes (list) --

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

          • (string) --
        • accountId (string) --

          The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

        • createdAt (datetime) --

          The date and time when the subscription was created.

        • externalId (string) --

          The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

        • roleArn (string) --

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn (string) --

          The ARN for the Amazon S3 bucket.

        • snsArn (string) --

          The ARN for the Amazon Simple Notification Service.

        • sourceTypes (list) --

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • (dict) --

            The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: awsSourceType, customSourceType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            
            • awsSourceType (string) --

              Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

            • customSourceType (string) --

              Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

        • subscriberDescription (string) --

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriptionId .

        • subscriberName (string) --

          The name of your Amazon Security Lake subscriber account.

        • subscriptionEndpoint (string) --

          The subscription endpoint to which exception messages are posted.

        • subscriptionId (string) --

          The subscription ID of the Amazon Security Lake subscriber account.

        • subscriptionProtocol (string) --

          The subscription protocol to which exception messages are posted.

        • subscriptionStatus (string) --

          The subscription status of the Amazon Security Lake subscriber account.

        • updatedAt (datetime) --

          The date and time when the subscription was created.

Exceptions

update_datalake(**kwargs)

Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.

See also: AWS API Documentation

Request Syntax

response = client.update_datalake(
    configurations={
        'string': {
            'encryptionKey': 'string',
            'replicationDestinationRegions': [
                'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
            ],
            'replicationRoleArn': 'string',
            'retentionSettings': [
                {
                    'retentionPeriod': 123,
                    'storageClass': 'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER_IR'|'GLACIER'|'DEEP_ARCHIVE'|'EXPIRE'
                },
            ],
            'tagsMap': {
                'string': 'string'
            }
        }
    }
)
Parameters
configurations (dict) --

[REQUIRED]

Specify the Region or Regions that will contribute data to the rollup region.

  • (string) --
    • (dict) --

      Provides details of Amazon Security Lake configuration object.

      • encryptionKey (string) --

        The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.

      • replicationDestinationRegions (list) --

        Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.

        Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

        • (string) --
      • replicationRoleArn (string) --

        Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

      • retentionSettings (list) --

        Retention settings for the destination Amazon S3 buckets.

        • (dict) --

          Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.

          • retentionPeriod (integer) --

            The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

          • storageClass (string) --

            The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

      • tagsMap (dict) --

        A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

        • (string) --
          • (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

update_datalake_exceptions_expiry(**kwargs)

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. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.

See also: AWS API Documentation

Request Syntax

response = client.update_datalake_exceptions_expiry(
    exceptionMessageExpiry=123
)
Parameters
exceptionMessageExpiry (integer) --

[REQUIRED]

The time-to-live (TTL) for the exception message to remain.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

update_datalake_exceptions_subscription(**kwargs)

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

See also: AWS API Documentation

Request Syntax

response = client.update_datalake_exceptions_subscription(
    notificationEndpoint='string',
    subscriptionProtocol='HTTP'|'HTTPS'|'EMAIL'|'EMAIL_JSON'|'SMS'|'SQS'|'LAMBDA'|'APP'|'FIREHOSE'
)
Parameters
  • notificationEndpoint (string) --

    [REQUIRED]

    The account that is subscribed to receive exception notifications.

  • subscriptionProtocol (string) --

    [REQUIRED]

    The subscription protocol to which exception messages are posted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_subscriber(**kwargs)

Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.

See also: AWS API Documentation

Request Syntax

response = client.update_subscriber(
    externalId='string',
    id='string',
    sourceTypes=[
        {
            'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
            'customSourceType': 'string'
        },
    ],
    subscriberDescription='string',
    subscriberName='string'
)
Parameters
  • externalId (string) -- The external ID of the Security Lake account.
  • id (string) --

    [REQUIRED]

    A value created by Security Lake that uniquely identifies your subscription.

  • sourceTypes (list) --

    [REQUIRED]

    The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

    • (dict) --

      The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: awsSourceType, customSourceType.

      • awsSourceType (string) --

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

      • customSourceType (string) --

        Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

  • subscriberDescription (string) -- The description of the Security Lake account subscriber.
  • subscriberName (string) -- The name of the Security Lake account subscriber.
Return type

dict

Returns

Response Syntax

{
    'subscriber': {
        'accessTypes': [
            'LAKEFORMATION'|'S3',
        ],
        'accountId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'externalId': 'string',
        'roleArn': 'string',
        's3BucketArn': 'string',
        'snsArn': 'string',
        'sourceTypes': [
            {
                'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
                'customSourceType': 'string'
            },
        ],
        'subscriberDescription': 'string',
        'subscriberName': 'string',
        'subscriptionEndpoint': 'string',
        'subscriptionId': 'string',
        'subscriptionProtocol': 'HTTPS'|'SQS',
        'subscriptionStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • subscriber (dict) --

      The account of the subscriber.

      • accessTypes (list) --

        You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

        Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

        • (string) --
      • accountId (string) --

        The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

      • createdAt (datetime) --

        The date and time when the subscription was created.

      • externalId (string) --

        The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

      • roleArn (string) --

        The Amazon Resource Name (ARN) specifying the role of the subscriber.

      • s3BucketArn (string) --

        The ARN for the Amazon S3 bucket.

      • snsArn (string) --

        The ARN for the Amazon Simple Notification Service.

      • sourceTypes (list) --

        Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

        • (dict) --

          The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: awsSourceType, customSourceType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • awsSourceType (string) --

            Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

          • customSourceType (string) --

            Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

      • subscriberDescription (string) --

        The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriptionId .

      • subscriberName (string) --

        The name of your Amazon Security Lake subscriber account.

      • subscriptionEndpoint (string) --

        The subscription endpoint to which exception messages are posted.

      • subscriptionId (string) --

        The subscription ID of the Amazon Security Lake subscriber account.

      • subscriptionProtocol (string) --

        The subscription protocol to which exception messages are posted.

      • subscriptionStatus (string) --

        The subscription status of the Amazon Security Lake subscriber account.

      • updatedAt (datetime) --

        The date and time when the subscription was created.

Exceptions

update_subscription_notification_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_subscription_notification_configuration(
    createSqs=True|False,
    httpsApiKeyName='string',
    httpsApiKeyValue='string',
    httpsMethod='POST'|'PUT',
    roleArn='string',
    subscriptionEndpoint='string',
    subscriptionId='string'
)
Parameters
  • createSqs (boolean) -- Create a new subscription notification for the specified subscription ID in Amazon Security Lake.
  • httpsApiKeyName (string) -- The key name for the subscription notification.
  • httpsApiKeyValue (string) -- The key value for the subscription notification.
  • httpsMethod (string) -- The HTTPS method used for the subscription notification.
  • roleArn (string) -- The Amazon Resource Name (ARN) specifying the role of the subscriber.
  • subscriptionEndpoint (string) -- The subscription endpoint in Security Lake.
  • subscriptionId (string) --

    [REQUIRED]

    The subscription ID for which the subscription notification is specified.

Return type

dict

Returns

Response Syntax

{
    'queueArn': 'string'
}

Response Structure

  • (dict) --

    • queueArn (string) --

      Returns the ARN of the queue.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class SecurityLake.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.AccountNotFoundException

Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

Example

try:
  ...
except client.exceptions.AccountNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.BucketNotFoundException

Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.

Example

try:
  ...
except client.exceptions.BucketNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ConcurrentModificationException

More than one process tried to modify a resource at the same time.

Example

try:
  ...
except client.exceptions.ConcurrentModificationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    More than one process tried to modify a resource at the same time.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

    • message (string) --

    • resourceId (string) --

      A conflict occurred when prompting for the Resource ID.

    • resourceType (string) --

      The resource type.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ConflictSourceNamesException

There was a conflict when you attempted to modify a Security Lake source name.

Example

try:
  ...
except client.exceptions.ConflictSourceNamesException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict when you attempted to modify a Security Lake source name.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ConflictSubscriptionException

A conflicting subscription exception operation is in progress.

Example

try:
  ...
except client.exceptions.ConflictSubscriptionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A conflicting subscription exception operation is in progress.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.EventBridgeException

Represents an error interacting with the Amazon EventBridge service.

Example

try:
  ...
except client.exceptions.EventBridgeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Represents an error interacting with the Amazon EventBridge service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.InternalServerException

Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'retryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.

    • message (string) --

    • retryAfterSeconds (integer) --

      Retry the request after the specified time.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.InvalidInputException

The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

Example

try:
  ...
except client.exceptions.InvalidInputException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ResourceNotFoundException

The resource could not be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource could not be found.

    • message (string) --

    • resourceId (string) --

      The ID of the resource for which the type of resource could not be found.

    • resourceType (string) --

      The type of the resource that could not be found.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.S3Exception

Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.

Example

try:
  ...
except client.exceptions.S3Exception as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ServiceQuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

    • message (string) --

    • quotaCode (string) --

      That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.

    • resourceId (string) --

      The ID of the resource that exceeds the service quota.

    • resourceType (string) --

      The type of the resource that exceeds the service quota.

    • serviceCode (string) --

      The code for the service in Service Quotas.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ThrottlingException

The limit on the number of requests per second was exceeded.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'retryAfterSeconds': 123,
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The limit on the number of requests per second was exceeded.

    • message (string) --

    • quotaCode (string) --

      That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.

    • retryAfterSeconds (integer) --

      Retry the request after the specified time.

    • serviceCode (string) --

      The code for the service in Service Quotas.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SecurityLake.Client.exceptions.ValidationException

Your signing certificate could not be validated.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your signing certificate could not be validated.

    • fieldList (list) --

      The list of parameters that failed to validate.

      • (dict) --

        The input fails to meet the constraints specified in Amazon Security Lake.

        • message (string) --

          Describes the error encountered.

        • name (string) --

          Name of the validation exception.

    • message (string) --

    • reason (string) --

      The reason for the validation exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class SecurityLake.Paginator.GetDatalakeStatus
paginator = client.get_paginator('get_datalake_status')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityLake.Client.get_datalake_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    accountSet=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • accountSet (list) --

    The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'accountSourcesList': [
        {
            'account': 'string',
            'eventClass': 'ACCESS_ACTIVITY'|'FILE_ACTIVITY'|'KERNEL_ACTIVITY'|'KERNEL_EXTENSION'|'MEMORY_ACTIVITY'|'MODULE_ACTIVITY'|'PROCESS_ACTIVITY'|'REGISTRY_KEY_ACTIVITY'|'REGISTRY_VALUE_ACTIVITY'|'RESOURCE_ACTIVITY'|'SCHEDULED_JOB_ACTIVITY'|'SECURITY_FINDING'|'ACCOUNT_CHANGE'|'AUTHENTICATION'|'AUTHORIZATION'|'ENTITY_MANAGEMENT_AUDIT'|'DHCP_ACTIVITY'|'NETWORK_ACTIVITY'|'DNS_ACTIVITY'|'FTP_ACTIVITY'|'HTTP_ACTIVITY'|'RDP_ACTIVITY'|'SMB_ACTIVITY'|'SSH_ACTIVITY'|'CLOUD_API'|'CONTAINER_LIFECYCLE'|'DATABASE_LIFECYCLE'|'CONFIG_STATE'|'CLOUD_STORAGE'|'INVENTORY_INFO'|'RFB_ACTIVITY'|'SMTP_ACTIVITY'|'VIRTUAL_MACHINE_ACTIVITY',
            'logsStatus': [
                {
                    'healthStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING',
                    'pathToLogs': 'string'
                },
            ],
            'sourceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • accountSourcesList (list) --

      The list of enabled accounts and enabled sources.

      • (dict) --

        Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

        • account (string) --

          The ID of the Security Lake account for which logs are collected.

        • eventClass (string) --

          Initializes a new instance of the Event class.

        • logsStatus (list) --

          The log status for the Security Lake account.

          • (dict) --

            Retrieves the Logs status for the Amazon Security Lake account.

            • healthStatus (string) --

              The health status of services, including error codes and patterns.

            • pathToLogs (string) --

              Defines path the stored logs are available which has information on your systems, applications, and services.

        • sourceType (string) --

          The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

    • NextToken (string) --

      A token to resume pagination.

class SecurityLake.Paginator.ListDatalakeExceptions
paginator = client.get_paginator('list_datalake_exceptions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityLake.Client.list_datalake_exceptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    regionSet=[
        'us-east-1'|'us-west-2'|'eu-central-1'|'us-east-2'|'eu-west-1'|'ap-northeast-1'|'ap-southeast-2',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • regionSet (list) --

    List the Amazon Web Services Regions from which exceptions are retrieved.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'nonRetryableFailures': [
        {
            'failures': [
                {
                    'exceptionMessage': 'string',
                    'remediation': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ],
            'region': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • nonRetryableFailures (list) --

      Lists the failures that cannot be retried in the current Region.

      • (dict) --

        Response element for actions that make changes, namely create, update, or delete actions.

        • failures (list) --

          List of all failures.

          • (dict) --

            List of all failures.

            • exceptionMessage (string) --

              List of all exception messages.

            • remediation (string) --

              List of all remediation steps for failures.

            • timestamp (datetime) --

              This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.

        • region (string) --

          List of Amazon Web Services Regions where the failure occurred.

    • NextToken (string) --

      A token to resume pagination.

class SecurityLake.Paginator.ListLogSources
paginator = client.get_paginator('list_log_sources')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityLake.Client.list_log_sources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    inputOrder=[
        'REGION'|'SOURCE_TYPE'|'MEMBER',
    ],
    listAllDimensions={
        'string': {
            'string': [
                'string',
            ]
        }
    },
    listSingleDimension=[
        'string',
    ],
    listTwoDimensions={
        'string': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • inputOrder (list) --

    Lists the log sources in input order, namely Region, source type, and member account.

    • (string) --
  • listAllDimensions (dict) --

    List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.

    • (string) --
      • (dict) --
        • (string) --
          • (list) --
            • (string) --
  • listSingleDimension (list) --

    List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.

    • (string) --
  • listTwoDimensions (dict) --

    Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.

    • (string) --
      • (list) --
        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'regionSourceTypesAccountsList': [
        {
            'string': {
                'string': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • regionSourceTypesAccountsList (list) --

      Lists the log sources by Regions for enabled Security Lake accounts.

      • (dict) --
        • (string) --
          • (dict) --
            • (string) --
              • (list) --
                • (string) --
    • NextToken (string) --

      A token to resume pagination.

class SecurityLake.Paginator.ListSubscribers
paginator = client.get_paginator('list_subscribers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityLake.Client.list_subscribers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'subscribers': [
        {
            'accessTypes': [
                'LAKEFORMATION'|'S3',
            ],
            'accountId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'externalId': 'string',
            'roleArn': 'string',
            's3BucketArn': 'string',
            'snsArn': 'string',
            'sourceTypes': [
                {
                    'awsSourceType': 'ROUTE53'|'VPC_FLOW'|'CLOUD_TRAIL'|'SH_FINDINGS',
                    'customSourceType': 'string'
                },
            ],
            'subscriberDescription': 'string',
            'subscriberName': 'string',
            'subscriptionEndpoint': 'string',
            'subscriptionId': 'string',
            'subscriptionProtocol': 'HTTPS'|'SQS',
            'subscriptionStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • subscribers (list) --

      The subscribers available for the specified Security Lake account ID.

      • (dict) --

        Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

        • accessTypes (list) --

          You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

          Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

          • (string) --
        • accountId (string) --

          The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

        • createdAt (datetime) --

          The date and time when the subscription was created.

        • externalId (string) --

          The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

        • roleArn (string) --

          The Amazon Resource Name (ARN) specifying the role of the subscriber.

        • s3BucketArn (string) --

          The ARN for the Amazon S3 bucket.

        • snsArn (string) --

          The ARN for the Amazon Simple Notification Service.

        • sourceTypes (list) --

          Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

          • (dict) --

            The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: awsSourceType, customSourceType. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            
            • awsSourceType (string) --

              Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

            • customSourceType (string) --

              Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

        • subscriberDescription (string) --

          The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriptionId .

        • subscriberName (string) --

          The name of your Amazon Security Lake subscriber account.

        • subscriptionEndpoint (string) --

          The subscription endpoint to which exception messages are posted.

        • subscriptionId (string) --

          The subscription ID of the Amazon Security Lake subscriber account.

        • subscriptionProtocol (string) --

          The subscription protocol to which exception messages are posted.

        • subscriptionStatus (string) --

          The subscription status of the Amazon Security Lake subscriber account.

        • updatedAt (datetime) --

          The date and time when the subscription was created.

    • NextToken (string) --

      A token to resume pagination.