class Aws::S3::Types::PutObjectRequest

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRequest AWS API Documentation
@return [String]
‘403 Forbidden` (access denied).
by a different account, the request fails with the HTTP status code
The account ID of the expected bucket owner. If the bucket is owned
@!attribute [rw] expected_bucket_owner
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html more information about S3 Object Lock, see [Object Lock].
Specifies whether a legal hold will be applied to this object. For
@!attribute [rw] object_lock_legal_hold_status
@return [Time]
expire. Must be formatted as a timestamp parameter.
The date and time when you want this object’s Object Lock to
@!attribute [rw] object_lock_retain_until_date
@return [String]
The Object Lock mode that you want to apply to this object.
@!attribute [rw] object_lock_mode
@return [String]
parameters. (For example, “Key1=Value1”)
The tag-set for the object. The tag-set must be encoded as URL Query
@!attribute [rw] tagging
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html in the *Amazon S3 User Guide*.
Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
requests. For information about downloading objects from Requester
request. Bucket owners need not specify this parameter in their
Confirms that the requester knows that they will be charged for the
@!attribute [rw] request_payer
@return [Boolean]
settings for S3 Bucket Key.
Specifying this header with a PUT action doesn’t affect bucket-level
Key for object encryption with SSE-KMS.
Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket
encryption with server-side encryption using AWS KMS (SSE-KMS).
Specifies whether Amazon S3 should use an S3 Bucket Key for object
@!attribute [rw] bucket_key_enabled
@return [String]
`CopyObject` operations on this object.
gets passed on to Amazon Web Services KMS for future `GetObject` or
pairs. This value is stored as object metadata and automatically
UTF-8 string holding JSON with the encryption context key-value
object encryption. The value of this header is a base64-encoded
Specifies the Amazon Web Services KMS Encryption Context to use for
@!attribute [rw] ssekms_encryption_context
@return [String]
the full ARN and not just the ID.
does not exist in the same account issuing the command, you must use
Amazon Web Services managed key to protect the data. If the KMS key
x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
`x-amz-server-side-encryption:aws:kms`, but do not provide`
customer managed key that was used for the object. If you specify
Management Service (Amazon Web Services KMS) symmetric encryption
this header specifies the ID of the Amazon Web Services Key
If `x-amz-server-side-encryption` has a valid value of `aws:kms`,
@!attribute [rw] ssekms_key_id
@return [String]
to ensure that the encryption key was transmitted without error.
RFC 1321. Amazon S3 uses this header for a message integrity check
Specifies the 128-bit MD5 digest of the encryption key according to
@!attribute [rw] sse_customer_key_md5
@return [String]
`x-amz-server-side-encryption-customer-algorithm` header.
key must be appropriate for use with the algorithm specified in the
it is discarded; Amazon S3 does not store the encryption key. The
in encrypting data. This value is used to store the object and then
Specifies the customer-provided encryption key for Amazon S3 to use
@!attribute [rw] sse_customer_key
@return [String]
example, AES256).
Specifies the algorithm to use to when encrypting the object (for
@!attribute [rw] sse_customer_algorithm
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html Page Redirects].
[Hosting Websites on Amazon S3] and [How to Configure Website
For more information about website hosting in Amazon S3, see
`x-amz-website-redirect-location: www.example.com/`
redirect to another website:
In the following example, the request header sets the object
`x-amz-website-redirect-location: /anotherPage.html`
object (anotherPage.html) in the same bucket:
In the following example, the request header sets the redirect to an Metadata].
metadata. For information about object metadata, see [Object Key and
URL. Amazon S3 stores the value of this header in the object
this object to another object in the same bucket or to an external
If the bucket is configured as a website, redirects requests for
@!attribute [rw] website_redirect_location
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html Classes][1] in the *Amazon S3 User Guide*.
the OUTPOSTS Storage Class. For more information, see [Storage
specify a different Storage Class. Amazon S3 on Outposts only uses
and high availability. Depending on performance needs, you can
created objects. The STANDARD storage class provides high durability
By default, Amazon S3 uses the STANDARD Storage Class to store newly
@!attribute [rw] storage_class
@return [String]
in Amazon S3 (for example, AES256, `aws:kms`).
The server-side encryption algorithm used when storing this object
@!attribute [rw] server_side_encryption
@return [Hash<String,String>]
A map of metadata to store with the object in S3.
@!attribute [rw] metadata
@return [String]
Object key for which the PUT action was initiated.
@!attribute [rw] key
@return [String]
This action is not supported by Amazon S3 on Outposts.
Allows grantee to write the ACL for the applicable object.
@!attribute [rw] grant_write_acp
@return [String]
This action is not supported by Amazon S3 on Outposts.
Allows grantee to read the object ACL.
@!attribute [rw] grant_read_acp
@return [String]
This action is not supported by Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata.
@!attribute [rw] grant_read
@return [String]
This action is not supported by Amazon S3 on Outposts.
object.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
@!attribute [rw] grant_full_control
@return [Time] : www.rfc-editor.org/rfc/rfc7234#section-5.3 [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
more information, see
The date and time at which the object is no longer cacheable. For
@!attribute [rw] expires
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html *Amazon S3 User Guide*.
For more information, see [Checking object integrity] in the
specifies the base64-encoded, 256-bit SHA-256 digest of the object.
data received is the same data that was originally sent. This header
This header can be used as a data integrity check to verify that the
@!attribute [rw] checksum_sha256
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html *Amazon S3 User Guide*.
For more information, see [Checking object integrity] in the
specifies the base64-encoded, 160-bit SHA-1 digest of the object.
data received is the same data that was originally sent. This header
This header can be used as a data integrity check to verify that the
@!attribute [rw] checksum_sha1
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html *Amazon S3 User Guide*.
For more information, see [Checking object integrity] in the
specifies the base64-encoded, 32-bit CRC32C checksum of the object.
data received is the same data that was originally sent. This header
This header can be used as a data integrity check to verify that the
@!attribute [rw] checksum_crc32c
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html *Amazon S3 User Guide*.
For more information, see [Checking object integrity] in the
specifies the base64-encoded, 32-bit CRC32 checksum of the object.
data received is the same data that was originally sent. This header
This header can be used as a data integrity check to verify that the
@!attribute [rw] checksum_crc32
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html provided `ChecksumAlgorithm` parameter.
If you provide an individual checksum, Amazon S3 ignores any integrity] in the *Amazon S3 User Guide*.
code `400 Bad Request`. For more information, see [Checking object
sent. Otherwise, Amazon S3 fails the request with the HTTP status
must be a corresponding `x-amz-checksum` or `x-amz-trailer` header
functionality if not using the SDK. When sending this header, there
when using the SDK. This header will not provide any additional
Indicates the algorithm used to create the checksum for the object
@!attribute [rw] checksum_algorithm
@return [String] : www.rfc-editor.org/rfc/rfc9110.html#name-content-type [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
information, see
A standard MIME type describing the format of the contents. For more
@!attribute [rw] content_type
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html Authentication][1].
information about REST request authentication, see [REST
Content-MD5 mechanism as an end-to-end integrity check. For more
originally sent. Although it is optional, we recommend using the
integrity check to verify that the data is the same data that was
headers) according to RFC 1864. This header can be used as a message
The base64-encoded 128-bit MD5 digest of the message (without the
@!attribute [rw] content_md5
@return [Integer] : www.rfc-editor.org/rfc/rfc9110.html#name-content-length [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
see
the body cannot be determined automatically. For more information,
Size of the body in bytes. This parameter is useful when the size of
@!attribute [rw] content_length
@return [String]
The language the content is in.
@!attribute [rw] content_language
@return [String] : www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
information, see
media-type referenced by the Content-Type header field. For more
thus what decoding mechanisms must be applied to obtain the
Specifies what content encodings have been applied to the object and
@!attribute [rw] content_encoding
@return [String] : www.rfc-editor.org/rfc/rfc6266#section-4 [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
information, see
Specifies presentational information for the object. For more
@!attribute [rw] content_disposition
@return [String] : www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
chain. For more information, see
Can be used to specify caching behavior along the request/reply
@!attribute [rw] cache_control
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [What is S3 on Outposts] in the *Amazon S3 User Guide*.
the bucket name. For more information about S3 on Outposts ARNs, see
Services SDKs, you provide the Outposts access point ARN in place of
When you use this action with S3 on Outposts through the Amazon Web
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
takes the form `
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
When you use this action with Amazon S3 on Outposts, you must direct
[Using access points] in the *Amazon S3 User Guide*.
bucket name. For more information about access point ARNs, see
Services SDKs, you provide the access point ARN in place of the
When using this action with an access point through the Amazon Web
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
takes the form
requests to the access point hostname. The access point hostname
When using this action with an access point, you must direct
The bucket name to which the PUT action was initiated.
@!attribute [rw] bucket
@return [IO]
Object data.
@!attribute [rw] body
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL This action is not supported by Amazon S3 on Outposts.
[Canned ACL].
The canned ACL to apply to the object. For more information, see
@!attribute [rw] acl

class Aws::S3::Types::PutObjectRequest

Namespace

Included Modules

Defined in