SecurityLake / Client / get_datalake

get_datalake

SecurityLake.Client.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'
            },
            'updateStatus': {
                'lastUpdateFailure': {
                    'code': 'string',
                    'reason': 'string'
                },
                'lastUpdateRequestId': 'string',
                'lastUpdateStatus': 'INITIALIZED'|'PENDING'|'COMPLETED'|'FAILED'
            }
        }
    }
}

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

        • updateStatus (dict) –

          The status of the last UpdateDatalake ``or ``DeleteDatalake API request.

          • lastUpdateFailure (dict) –

            The details of the last UpdateDatalake``or ``DeleteDatalake API request which failed.

            • code (string) –

              The reason code for the failure of the last UpdateDatalake or DeleteDatalake API request.

            • reason (string) –

              The reason for the failure of the last UpdateDatalake``or ``DeleteDatalake API request.

          • lastUpdateRequestId (string) –

            The unique ID for the UpdateDatalake or DeleteDatalake API request.

          • lastUpdateStatus (string) –

            The status of the last UpdateDatalake or DeleteDatalake API request that was requested.

Exceptions

• SecurityLake.Client.exceptions.InternalServerException

• SecurityLake.Client.exceptions.ValidationException

• SecurityLake.Client.exceptions.AccessDeniedException

• SecurityLake.Client.exceptions.ResourceNotFoundException

• SecurityLake.Client.exceptions.AccountNotFoundException