get_bucket_policy {aws.s3}

Bucket policies

Description

Get/Put/Delete the bucket access policy for a bucket.

Usage

get_bucket_policy(bucket, parse_response = TRUE, ...)

put_bucket_policy(bucket, policy, ...)

delete_bucket_policy(bucket, ...)

Arguments

bucket

Character string with the name of the bucket, or an object of class “s3_bucket”.

parse_response

A logical indicating whether to return the response as is, or parse and return as a list. Default is FALSE.

...

Additional arguments passed to s3HTTP.

policy

A character string containing a bucket policy.

Details

Bucket policies regulate who has what access to a bucket and its contents. The header argument can beused to specify “canned” policies and put_bucket_policy can be used to specify a more complex policy. The AWS Policy Generator can be useful for creating the appropriate JSON policy structure.

Value

For get_policy: A character string containing the JSON representation of the policy, if one has been set. For delete_policy and put_policy: TRUE if successful, FALSE otherwise.

References

API Documentation API Documentation AWS Policy Generator