S3 / Client / get_bucket_logging

get_bucket_logging#

S3.Client.get_bucket_logging(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_logging(
    Bucket='string',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The bucket name for which to get the logging information.

  • ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type:

dict

Returns:

Response Syntax

{
    'LoggingEnabled': {
        'TargetBucket': 'string',
        'TargetGrants': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'EmailAddress': 'string',
                    'ID': 'string',
                    'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
            },
        ],
        'TargetPrefix': 'string',
        'TargetObjectKeyFormat': {
            'SimplePrefix': {},
            'PartitionedPrefix': {
                'PartitionDateSource': 'EventTime'|'DeliveryTime'
            }
        }
    }
}

Response Structure

  • (dict) –

    • LoggingEnabled (dict) –

      Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

      • TargetBucket (string) –

        Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

      • TargetGrants (list) –

        Container for granting information.

        Buckets that use the bucket owner enforced setting for Object Ownership don’t support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

        • (dict) –

          Container for granting information.

          Buckets that use the bucket owner enforced setting for Object Ownership don’t support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide.

          • Grantee (dict) –

            Container for the person being granted permissions.

            • DisplayName (string) –

              Screen name of the grantee.

            • EmailAddress (string) –

              Email address of the grantee.

              Note

              Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

              • US East (N. Virginia)

              • US West (N. California)

              • US West (Oregon)

              • Asia Pacific (Singapore)

              • Asia Pacific (Sydney)

              • Asia Pacific (Tokyo)

              • Europe (Ireland)

              • South America (São Paulo)

              For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

            • ID (string) –

              The canonical user ID of the grantee.

            • Type (string) –

              Type of grantee

            • URI (string) –

              URI of the grantee group.

          • Permission (string) –

            Logging permissions assigned to the grantee for the bucket.

      • TargetPrefix (string) –

        A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

      • TargetObjectKeyFormat (dict) –

        Amazon S3 key format for log objects.

        • SimplePrefix (dict) –

          To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.

        • PartitionedPrefix (dict) –

          Partitioned S3 key for log objects.

          • PartitionDateSource (string) –

            Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

            For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

            For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.