S3 / Client / get_bucket_encryption

get_bucket_encryption#

S3.Client.get_bucket_encryption(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

See also: AWS API Documentation

Request Syntax

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

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket from which the server-side encryption configuration is retrieved.

  • 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

{
    'ServerSideEncryptionConfiguration': {
        'Rules': [
            {
                'ApplyServerSideEncryptionByDefault': {
                    'SSEAlgorithm': 'AES256'|'aws:kms'|'aws:kms:dsse',
                    'KMSMasterKeyID': 'string'
                },
                'BucketKeyEnabled': True|False
            },
        ]
    }
}

Response Structure

  • (dict) –

    • ServerSideEncryptionConfiguration (dict) –

      Specifies the default server-side-encryption configuration.

      • Rules (list) –

        Container for information about a particular server-side encryption configuration rule.

        • (dict) –

          Specifies the default server-side encryption configuration.

          Note

          If you’re specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that’s encrypted with a KMS key that belongs to the requester, and not the bucket owner.

          • ApplyServerSideEncryptionByDefault (dict) –

            Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn’t specify any server-side encryption, this default encryption will be applied.

            • SSEAlgorithm (string) –

              Server-side encryption algorithm to use for the default encryption.

            • KMSMasterKeyID (string) –

              Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.

              You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

              • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

              • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

              • Key Alias: alias/alias-name

              If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

              If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

              Warning

              Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

          • BucketKeyEnabled (boolean) –

            Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

            For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.