// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package s3
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/checksum"
"github.com/aws/aws-sdk-go-v2/private/protocol"
"github.com/aws/aws-sdk-go-v2/private/protocol/restxml"
"github.com/aws/aws-sdk-go-v2/service/s3/internal/arn"
)
type PutBucketAclInput struct {
_ struct{} `type:"structure" payload:"AccessControlPolicy"`
// The canned ACL to apply to the bucket.
ACL BucketCannedACL `location:"header" locationName:"x-amz-acl" type:"string" enum:"true"`
// Contains the elements that set the ACL permissions for an object per grantee.
AccessControlPolicy *AccessControlPolicy `locationName:"AccessControlPolicy" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`
// The bucket to which to apply the ACL.
//
// Bucket is a required field
Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
// Allows grantee the read, write, read ACP, and write ACP permissions on the
// bucket.
GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`
// Allows grantee to list the objects in the bucket.
GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`
// Allows grantee to read the bucket ACL.
GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`
// Allows grantee to create, overwrite, and delete any object in the bucket.
GrantWrite *string `location:"header" locationName:"x-amz-grant-write" type:"string"`
// Allows grantee to write the ACL for the applicable bucket.
GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
}
// String returns the string representation
func (s PutBucketAclInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PutBucketAclInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "PutBucketAclInput"}
if s.Bucket == nil {
invalidParams.Add(aws.NewErrParamRequired("Bucket"))
}
if s.AccessControlPolicy != nil {
if err := s.AccessControlPolicy.Validate(); err != nil {
invalidParams.AddNested("AccessControlPolicy", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
func (s *PutBucketAclInput) getBucket() (v string) {
if s.Bucket == nil {
return v
}
return *s.Bucket
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s PutBucketAclInput) MarshalFields(e protocol.FieldEncoder) error {
if len(s.ACL) > 0 {
v := s.ACL
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-acl", v, metadata)
}
if s.GrantFullControl != nil {
v := *s.GrantFullControl
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-grant-full-control", protocol.StringValue(v), metadata)
}
if s.GrantRead != nil {
v := *s.GrantRead
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-grant-read", protocol.StringValue(v), metadata)
}
if s.GrantReadACP != nil {
v := *s.GrantReadACP
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-grant-read-acp", protocol.StringValue(v), metadata)
}
if s.GrantWrite != nil {
v := *s.GrantWrite
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-grant-write", protocol.StringValue(v), metadata)
}
if s.GrantWriteACP != nil {
v := *s.GrantWriteACP
metadata := protocol.Metadata{}
e.SetValue(protocol.HeaderTarget, "x-amz-grant-write-acp", protocol.StringValue(v), metadata)
}
if s.Bucket != nil {
v := *s.Bucket
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "Bucket", protocol.StringValue(v), metadata)
}
if s.AccessControlPolicy != nil {
v := s.AccessControlPolicy
metadata := protocol.Metadata{XMLNamespaceURI: "http://s3.amazonaws.com/doc/2006-03-01/"}
e.SetFields(protocol.PayloadTarget, "AccessControlPolicy", v, metadata)
}
return nil
}
func (s *PutBucketAclInput) getEndpointARN() (arn.Resource, error) {
if s.Bucket == nil {
return nil, fmt.Errorf("member Bucket is nil")
}
return parseEndpointARN(*s.Bucket)
}
func (s *PutBucketAclInput) hasEndpointARN() bool {
if s.Bucket == nil {
return false
}
return arn.IsARN(*s.Bucket)
}
type PutBucketAclOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s PutBucketAclOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s PutBucketAclOutput) MarshalFields(e protocol.FieldEncoder) error {
return nil
}
const opPutBucketAcl = "PutBucketAcl"
// PutBucketAclRequest returns a request value for making API operation for
// Amazon Simple Storage Service.
//
// Sets the permissions on an existing bucket using access control lists (ACL).
// For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
// 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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
//
// * 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 (AWS
// 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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
// 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 AWS account uri – if you are granting permissions to a predefined
// group emailAddress – if the value specified is the email address of
// an AWS account Using email addresses to specify a grantee is only supported
// in the following AWS 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
// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
// the AWS 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 AWS 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 AWS 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 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
// in the AWS General Reference.
//
// Related Resources
//
// * CreateBucket
//
// * DeleteBucket
//
// * GetObjectAcl
//
// // Example sending a request using PutBucketAclRequest.
// req := client.PutBucketAclRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl
func (c *Client) PutBucketAclRequest(input *PutBucketAclInput) PutBucketAclRequest {
op := &aws.Operation{
Name: opPutBucketAcl,
HTTPMethod: "PUT",
HTTPPath: "/{Bucket}?acl",
}
if input == nil {
input = &PutBucketAclInput{}
}
req := c.newRequest(op, input, &PutBucketAclOutput{})
req.Handlers.Unmarshal.Remove(restxml.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
req.Handlers.Build.PushBackNamed(aws.NamedHandler{
Name: "contentMd5Handler",
Fn: checksum.AddBodyContentMD5Handler,
})
return PutBucketAclRequest{Request: req, Input: input, Copy: c.PutBucketAclRequest}
}
// PutBucketAclRequest is the request type for the
// PutBucketAcl API operation.
type PutBucketAclRequest struct {
*aws.Request
Input *PutBucketAclInput
Copy func(*PutBucketAclInput) PutBucketAclRequest
}
// Send marshals and sends the PutBucketAcl API request.
func (r PutBucketAclRequest) Send(ctx context.Context) (*PutBucketAclResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &PutBucketAclResponse{
PutBucketAclOutput: r.Request.Data.(*PutBucketAclOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// PutBucketAclResponse is the response type for the
// PutBucketAcl API operation.
type PutBucketAclResponse struct {
*PutBucketAclOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// PutBucketAcl request.
func (r *PutBucketAclResponse) SDKResponseMetdata() *aws.Response {
return r.response
}