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.
To ensure that bucket owners don't inadvertently lock themselves out of their own
buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
GetBucketPolicy, PutBucketPolicy, and
DeleteBucketPolicy API actions, even if their bucket policy explicitly
denies the root principal's access. Bucket owner root principals can only be blocked
from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
policies.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned.
For more information about InvalidAccessPointAliasError, see List of
Error Codes.
Base exception class for all service exceptions from S3 service.
Example
To get bucket policy
// The following example returns bucket policy associated with a bucket. constinput = { "Bucket":"examplebucket" }; constcommand = newGetBucketPolicyCommand(input); constresponse = awaitclient.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
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 a403 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 a405 Method Not Allowed
error.To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
GetBucketPolicy
,PutBucketPolicy
, andDeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information aboutInvalidAccessPointAliasError
, see List of Error Codes.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.
Param
GetBucketPolicyCommandInput
Returns
GetBucketPolicyCommandOutput
See
input
shape.response
shape.config
shape.Throws
S3ServiceException
Base exception class for all service exceptions from S3 service.
Example
To get bucket policy