SecurityLake / Paginator / GetDatalakeStatus

GetDatalakeStatus

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.