Class GetBucketPolicyCommandProtected

Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following action is related to GetBucketPolicy:

• GetObject

Example

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

import { S3Client, GetBucketPolicyCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketPolicyCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const command = new GetBucketPolicyCommand(input);
const response = await client.send(command);

Param

GetBucketPolicyCommandInput

Returns

GetBucketPolicyCommandOutput

See

• GetBucketPolicyCommandInput for command's input shape.
• GetBucketPolicyCommandOutput for command's response shape.
• config for S3Client's config shape.

Example

To get bucket policy

// The following example returns bucket policy associated with a bucket.
const input = {
  "Bucket": "examplebucket"
};
const command = new GetBucketPolicyCommand(input);
const response = await client.send(command);
/* response ==
{
  "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}"
}
*/
// example id: to-get-bucket-policy-1481595098424