Class: Aws::S3::Types::PutObjectRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::PutObjectRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary collapse

#acl ⇒ String

The canned ACL to apply to the object.
#body ⇒ IO

Object data.
#bucket ⇒ String

The bucket name to which the PUT action was initiated.
#bucket_key_enabled ⇒ Boolean

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).
#cache_control ⇒ String

Can be used to specify caching behavior along the request/reply chain.
#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when you use the SDK.
#checksum_crc32 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_crc32c ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_sha1 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_sha256 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#content_disposition ⇒ String

Specifies presentational information for the object.
#content_encoding ⇒ String

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
#content_language ⇒ String

The language the content is in.
#content_length ⇒ Integer

Size of the body in bytes.
#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864.
#content_type ⇒ String

A standard MIME type describing the format of the contents.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.
#expires ⇒ Time

The date and time at which the object is no longer cacheable.
#grant_full_control ⇒ String

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
#grant_read ⇒ String

Allows grantee to read the object data and its metadata.
#grant_read_acp ⇒ String

Allows grantee to read the object ACL.
#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable object.
#if_match ⇒ String

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3.
#if_none_match ⇒ String

Uploads the object only if the object key name does not already exist in the bucket specified.
#key ⇒ String

Object key for which the PUT action was initiated.
#metadata ⇒ Hash<String,String>

A map of metadata to store with the object in S3.
#object_lock_legal_hold_status ⇒ String

Specifies whether a legal hold will be applied to this object.
#object_lock_mode ⇒ String

The Object Lock mode that you want to apply to this object.
#object_lock_retain_until_date ⇒ Time

The date and time when you want this object’s Object Lock to expire.
#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request.
#server_side_encryption ⇒ String

The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`, `aws:kms:dsse`).
#sse_customer_algorithm ⇒ String

Specifies the algorithm to use when encrypting the object (for example, ‘AES256`).
#sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
#sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
#ssekms_encryption_context ⇒ String

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption.
#ssekms_key_id ⇒ String

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.
#storage_class ⇒ String

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
#tagging ⇒ String

The tag-set for the object.
#website_redirect_location ⇒ String

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.
#write_offset_bytes ⇒ Integer

Specifies the offset for appending data to existing objects in bytes.

Instance Attribute Details

#acl ⇒ `String`

The canned ACL to apply to the object. For more information, see

Canned ACL][1: in the *Amazon S3 User Guide*.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see

Access Control List (ACL) Overview][2: and [Managing ACLs Using the

REST API] in the *Amazon S3 User Guide*.

If the bucket that you’re uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don’t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the ‘bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a `400` error with the error code `AccessControlListNotSupported`. For more information, see [ Controlling ownership of objects and disabling ACLs] in the *Amazon S3 User Guide*.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [2]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#body ⇒ `IO`

Object data.

Returns:

(IO)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#bucket ⇒ `String`

The bucket name to which the PUT action was initiated.

**Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see

Using access points][2: in the *Amazon S3 User Guide*.

<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

</note>

**S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

What is S3 on Outposts?][3: in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#bucket_key_enabled ⇒ `Boolean`

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

**General purpose buckets** - Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

**Directory buckets** - S3 Bucket Keys are always enabled for ‘GET` and `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren’t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject], [UploadPartCopy], [the Copy operation in Batch Operations], or [the import jobs]. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job

Returns:

(Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#cache_control ⇒ `String`

Can be used to specify caching behavior along the request/reply chain. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_algorithm ⇒ `String`

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send this header, there must be a corresponding ‘x-amz-checksum-algorithm ` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`.

For the ‘x-amz-checksum-algorithm ` header, replace ` algorithm ` with the supported algorithm from the following list:

‘CRC32`
‘CRC32C`
‘SHA1`
‘SHA256`

For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

If the individual checksum value you provide through ‘x-amz-checksum-algorithm ` doesn’t match the checksum algorithm you set through ‘x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter and uses the checksum algorithm that matches the provided value in `x-amz-checksum-algorithm `.

<note markdown=“1”> The ‘Content-MD5` or `x-amz-sdk-checksum-algorithm` header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see

Uploading objects to an Object Lock enabled bucket ][2: in the

*Amazon S3 User Guide*.

</note>

For directory buckets, when you use Amazon Web Services SDKs, ‘CRC32` is the default checksum algorithm that’s used for performance.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_crc32 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_crc32c ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_sha1 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_sha256 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_disposition ⇒ `String`

Specifies presentational information for the object. For more information, see [www.rfc-editor.org/rfc/rfc6266#section-4][1].

[1]: www.rfc-editor.org/rfc/rfc6266#section-4

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_encoding ⇒ `String`

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see [www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].

[1]: www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_language ⇒ `String`

The language the content is in.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_length ⇒ `Integer`

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see [www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].

[1]: www.rfc-editor.org/rfc/rfc9110.html#name-content-length

Returns:

(Integer)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_md5 ⇒ `String`

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see [REST Authentication].

Uploading objects to an Object Lock enabled bucket ][2: in the

*Amazon S3 User Guide*.

</note>

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_type ⇒ `String`

A standard MIME type describing the format of the contents. For more information, see [www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].

[1]: www.rfc-editor.org/rfc/rfc9110.html#name-content-type

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#expected_bucket_owner ⇒ `String`

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#expires ⇒ `Time`

The date and time at which the object is no longer cacheable. For more information, see [www.rfc-editor.org/rfc/rfc7234#section-5.3][1].

[1]: www.rfc-editor.org/rfc/rfc7234#section-5.3

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_full_control ⇒ `String`

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_read ⇒ `String`

Allows grantee to read the object data and its metadata.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_read_acp ⇒ `String`

Allows grantee to read the object ACL.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_write_acp ⇒ `String`

Allows grantee to write the ACL for the applicable object.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#if_match ⇒ `String`

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a ‘412 Precondition Failed` error.

If a conflicting operation occurs during the upload S3 returns a ‘409 ConditionalRequestConflict` response. On a 409 failure you should fetch the object’s ETag and retry the upload.

Expects the ETag value as a string.

For more information about conditional requests, see [RFC 7232], or [Conditional requests] in the *Amazon S3 User Guide*.

[1]: tools.ietf.org/html/rfc7232 [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#if_none_match ⇒ `String`

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a ‘412 Precondition Failed` error.

If a conflicting operation occurs during the upload S3 returns a ‘409 ConditionalRequestConflict` response. On a 409 failure you should retry the upload.

Expects the ‘*’ (asterisk) character.

For more information about conditional requests, see [RFC 7232], or [Conditional requests] in the *Amazon S3 User Guide*.

[1]: tools.ietf.org/html/rfc7232 [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#key ⇒ `String`

Object key for which the PUT action was initiated.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#metadata ⇒ `Hash<String,String>`

A map of metadata to store with the object in S3.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_legal_hold_status ⇒ `String`

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see [Object Lock] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_mode ⇒ `String`

The Object Lock mode that you want to apply to this object.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_retain_until_date ⇒ `Time`

The date and time when you want this object’s Object Lock to expire. Must be formatted as a timestamp parameter.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#request_payer ⇒ `String`

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`, `aws:kms:dsse`).

General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see [Using Server-Side Encryption] in the *Amazon S3 User Guide*.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (‘AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We recommend that the bucket’s default encryption uses the desired encryption configuration and you don’t override the bucket default encryption in your ‘CreateSession` requests or `PUT` object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see

Protecting data with server-side encryption][2

in the *Amazon S3

User Guide*. For more information about the encryption overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object uploads].

In the Zonal endpoint API calls (except [CopyObject] and [UploadPartCopy]) using the REST API, the encryption request headers must match the encryption settings that are specified in the ‘CreateSession` request. You can’t override the values of the encryption settings (‘x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`, and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified in the `CreateSession` request. You don’t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the ‘CreateSession` request to protect new objects in the directory bucket.

<note markdown=“1”> When you use the CLI or the Amazon Web Services SDKs, for ‘CreateSession`, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket’s default encryption configuration for the ‘CreateSession` request. It’s not supported to override the encryption settings values in the ‘CreateSession` request. So in the Zonal endpoint API calls (except

CopyObject][4

and [UploadPartCopy]), the encryption request

headers must match the default encryption configuration of the directory bucket.
```
</note>
```

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

Specifies the algorithm to use when encrypting the object (for example, ‘AES256`).

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key ⇒ `String`

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ `String`

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_encryption_context ⇒ `String`

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future ‘GetObject` operations on this object.

**General purpose buckets** - This value must be explicitly added during ‘CopyObject` operations if you want an additional encryption context for your object. For more information, see [Encryption context] in the *Amazon S3 User Guide*.

**Directory buckets** - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_key_id ⇒ `String`

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn’t exist in the same account that’s issuing the command, you must use the full Key ARN not the Key ID.

**General purpose buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify `x-amz-server-side-encryption:aws:kms` or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key (`aws/s3`) to protect the data.

**Directory buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms`, the ` x-amz-server-side-encryption-aws-kms-key-id` header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that’s configured for your directory bucket’s default encryption setting. If you want to specify the ‘ x-amz-server-side-encryption-aws-kms-key-id` header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that’s configured for your directory bucket’s default encryption setting. Otherwise, you get an HTTP ‘400 Bad Request` error. Only use the key ID or key ARN. The key alias format of the KMS key isn’t supported. Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#storage_class ⇒ `String`

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see

Storage Classes][1: in the *Amazon S3 User Guide*.

<note markdown=“1”> * For directory buckets, only the S3 Express One Zone storage class

is supported to store newly created objects.

Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#tagging ⇒ `String`

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, “Key1=Value1”)

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#website_redirect_location ⇒ `String`

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see [Object Key and Metadata] in the *Amazon S3 User Guide*.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

‘x-amz-website-redirect-location: /anotherPage.html`

In the following example, the request header sets the object redirect to another website:

‘x-amz-website-redirect-location: www.example.com/`

For more information about website hosting in Amazon S3, see

Hosting Websites on Amazon S3][2: and [How to Configure Website

Page Redirects] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#write_offset_bytes ⇒ `Integer`

Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.

<note markdown=“1”> This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

</note>

Returns:

(Integer)

# File 'lib/aws-sdk-s3/types.rb', line 15404

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :checksum_algorithm,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :expires,
  :if_match,
  :if_none_match,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :write_offset_bytes,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

Class: Aws::S3::Types::PutObjectRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

#body ⇒ IO

#bucket ⇒ String

#bucket_key_enabled ⇒ Boolean

#cache_control ⇒ String

#checksum_algorithm ⇒ String

#checksum_crc32 ⇒ String

#checksum_crc32c ⇒ String

#checksum_sha1 ⇒ String

#checksum_sha256 ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_length ⇒ Integer

#content_md5 ⇒ String

#content_type ⇒ String

#expected_bucket_owner ⇒ String

#expires ⇒ Time

#grant_full_control ⇒ String

#grant_read ⇒ String

#grant_read_acp ⇒ String

#grant_write_acp ⇒ String

#if_match ⇒ String

#if_none_match ⇒ String

#key ⇒ String

#metadata ⇒ Hash<String,String>

#object_lock_legal_hold_status ⇒ String

#object_lock_mode ⇒ String

#object_lock_retain_until_date ⇒ Time

#request_payer ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_encryption_context ⇒ String

#ssekms_key_id ⇒ String

#storage_class ⇒ String

#tagging ⇒ String

#website_redirect_location ⇒ String

#write_offset_bytes ⇒ Integer

#acl ⇒ `String`

#body ⇒ `IO`

#bucket ⇒ `String`

#bucket_key_enabled ⇒ `Boolean`

#cache_control ⇒ `String`

#checksum_algorithm ⇒ `String`

#checksum_crc32 ⇒ `String`

#checksum_crc32c ⇒ `String`

#checksum_sha1 ⇒ `String`

#checksum_sha256 ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_length ⇒ `Integer`

#content_md5 ⇒ `String`

#content_type ⇒ `String`

#expected_bucket_owner ⇒ `String`

#expires ⇒ `Time`

#grant_full_control ⇒ `String`

#grant_read ⇒ `String`

#grant_read_acp ⇒ `String`

#grant_write_acp ⇒ `String`

#if_match ⇒ `String`

#if_none_match ⇒ `String`

#key ⇒ `String`

#metadata ⇒ `Hash<String,String>`

#object_lock_legal_hold_status ⇒ `String`

#object_lock_mode ⇒ `String`

#object_lock_retain_until_date ⇒ `Time`

#request_payer ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_encryption_context ⇒ `String`

#ssekms_key_id ⇒ `String`

#storage_class ⇒ `String`

#tagging ⇒ `String`

#website_redirect_location ⇒ `String`

#write_offset_bytes ⇒ `Integer`