Class: Aws::S3::Types::PutBucketRequestPaymentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutBucketRequestPaymentRequest data as a hash:

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  request_payment_configuration: { # required
    payer: "Requester", # required, accepts Requester, BucketOwner
  },
  expected_bucket_owner: "AccountId",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name.

Returns:

  • (String) 


12609
12610
12611
12612
12613
12614
12615
12616
12617
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12609

class PutBucketRequestPaymentRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :request_payment_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

  • (String) 


12609
12610
12611
12612
12613
12614
12615
12616
12617
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12609

class PutBucketRequestPaymentRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :request_payment_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ String

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

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

Returns:

  • (String) 


12609
12610
12611
12612
12613
12614
12615
12616
12617
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12609

class PutBucketRequestPaymentRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :request_payment_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

  • (String) 


12609
12610
12611
12612
12613
12614
12615
12616
12617
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12609

class PutBucketRequestPaymentRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :request_payment_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#request_payment_configuration ⇒ Types::RequestPaymentConfiguration

Container for Payer.

Returns:



12609
12610
12611
12612
12613
12614
12615
12616
12617
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12609

class PutBucketRequestPaymentRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :request_payment_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end