Get Bucket Encryption

s3_get_bucket_encryption

R Documentation

This operation is not supported by directory buckets

Description

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 get_bucket_encryption:

• put_bucket_encryption

• delete_bucket_encryption

Usage

s3_get_bucket_encryption(Bucket, ExpectedBucketOwner)

Arguments

Bucket

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

ExpectedBucketOwner

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

Value

A list with the following syntax:

list(
  ServerSideEncryptionConfiguration = list(
    Rules = list(
      list(
        ApplyServerSideEncryptionByDefault = list(
          SSEAlgorithm = "AES256"|"aws:kms"|"aws:kms:dsse",
          KMSMasterKeyID = "string"
        ),
        BucketKeyEnabled = TRUE|FALSE
      )
    )
  )
)

Request syntax

svc$get_bucket_encryption(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)