Struct aws_sdk_s3::client::fluent_builders::PutBucketAcl

pub struct PutBucketAcl<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to PutBucketAcl.

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

• Specify the ACL in the request body

• Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Access Permissions

You can set access permissions using one of the following methods:

• Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.

• Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

  You specify each grantee as a type=value pair, where the type is one of the following:

  • id – if the value specified is the canonical user ID of an Amazon Web Services account

  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

  For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

  x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

• By the person's ID:

  <>ID<><>GranteesEmail<>

  DisplayName is optional and ignored in the request

• By URI:

  <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>

• By Email address:

  <>Grantees@email.com<>lt;/Grantee>

  The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

  Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

  For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

Related Resources

• CreateBucket

• DeleteBucket

• GetObjectAcl

Implementations

impl<C, M, R> PutBucketAcl<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<PutBucketAclOutput, SdkError<PutBucketAclError>> where
    R::Policy: SmithyRetryPolicy<PutBucketAclInputOperationOutputAlias, PutBucketAclOutput, PutBucketAclError, PutBucketAclInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn acl(self, inp: BucketCannedAcl) -> Self

The canned ACL to apply to the bucket.

pub fn set_acl(self, input: Option<BucketCannedAcl>) -> Self

The canned ACL to apply to the bucket.

pub fn access_control_policy(self, inp: AccessControlPolicy) -> Self

Contains the elements that set the ACL permissions for an object per grantee.

pub fn set_access_control_policy(
    self,
    input: Option<AccessControlPolicy>
) -> Self

Contains the elements that set the ACL permissions for an object per grantee.

pub fn bucket(self, inp: impl Into<String>) -> Self

The bucket to which to apply the ACL.

pub fn set_bucket(self, input: Option<String>) -> Self

The bucket to which to apply the ACL.

pub fn content_md5(self, inp: impl Into<String>) -> Self

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

pub fn set_content_md5(self, input: Option<String>) -> Self

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

pub fn grant_full_control(self, inp: impl Into<String>) -> Self

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

pub fn set_grant_full_control(self, input: Option<String>) -> Self

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

pub fn grant_read(self, inp: impl Into<String>) -> Self

Allows grantee to list the objects in the bucket.

pub fn set_grant_read(self, input: Option<String>) -> Self

Allows grantee to list the objects in the bucket.

pub fn grant_read_acp(self, inp: impl Into<String>) -> Self

Allows grantee to read the bucket ACL.

pub fn set_grant_read_acp(self, input: Option<String>) -> Self

Allows grantee to read the bucket ACL.

pub fn grant_write(self, inp: impl Into<String>) -> Self

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

pub fn set_grant_write(self, input: Option<String>) -> Self

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

pub fn grant_write_acp(self, inp: impl Into<String>) -> Self

Allows grantee to write the ACL for the applicable bucket.

pub fn set_grant_write_acp(self, input: Option<String>) -> Self

Allows grantee to write the ACL for the applicable bucket.

pub fn expected_bucket_owner(self, inp: impl Into<String>) -> Self

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.

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for PutBucketAcl<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.