s3_get_bucket_policy: Returns the policy of a specified bucket

Description Usage Arguments Value Request syntax Examples

View source: R/s3_operations.R

Description

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

If you don't have get_bucket_policy 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 AWS 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 operation is related to get_bucket_policy:

Usage

1
s3_get_bucket_policy(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] The bucket name for which to get the bucket policy.

ExpectedBucketOwner

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Value

A list with the following syntax:

1
2
3
list(
  Policy = "string"
)

Request syntax

1
2
3
4
svc$get_bucket_policy(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

1
2
3
4
5
6
7
## Not run: 
# The following example returns bucket policy associated with a bucket.
svc$get_bucket_policy(
  Bucket = "examplebucket"
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.