Overview

This document provides an overview of APIs and SDK code samples related to log management.

Setting Log Management

Feature description

This API (PUT Bucket logging) is used to enable logging for the source bucket and store its access logs in a specified destination bucket.

Method prototype

put_bucket_logging(Bucket, BucketLoggingStatus={}, **kwargs):

Sample request

response = client.put_bucket_logging(
    Bucket='examplebucket-1250000000',
    BucketLoggingStatus={
        'LoggingEnabled': {
            'TargetBucket': 'logging-bucket-1250000000',
            'TargetPrefix': 'string'
        }
    }
)

Parameter description

Returned result description

The returned value of this method is None.

Querying Log Management

Feature description

This API (GET Bucket logging) is used to query the log configuration information of a specified bucket.

Method prototype

get_bucket_logging(Bucket, **kwargs):

Sample request

response = client.get_bucket_logging(
    Bucket='examplebucket-1250000000'
)

Parameter description

Returned result description

Log management configuration of the bucket in dict type.

{
    'LoggingEnabled': {
        'TargetBucket': 'logging-bucket-1250000000',
        'TargetPrefix': 'string'
    }
}