Class GetBucketEncryptionCommandProtected

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:

• PutBucketEncryption

• DeleteBucketEncryption

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketEncryptionRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketEncryptionCommand(input);
const response = await client.send(command);
// { // GetBucketEncryptionOutput
//   ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
//     Rules: [ // ServerSideEncryptionRules // required
//       { // ServerSideEncryptionRule
//         ApplyServerSideEncryptionByDefault: { // ServerSideEncryptionByDefault
//           SSEAlgorithm: "AES256" || "aws:kms" || "aws:kms:dsse", // required
//           KMSMasterKeyID: "STRING_VALUE",
//         },
//         BucketKeyEnabled: true || false,
//       },
//     ],
//   },
// };

Param

GetBucketEncryptionCommandInput

Returns

GetBucketEncryptionCommandOutput

See

• GetBucketEncryptionCommandInput for command's input shape.
• GetBucketEncryptionCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.