Method: Aws::S3::Client#put_object

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

#put_object(params = {}) ⇒ `Types::PutObjectOutput`

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the ‘Content-MD5` header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

<note markdown=“1”> To configure your application to send the request headers before sending the request body, use the ‘100-continue` HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the `100-continue` HTTP status code, see Section 8.2.3 of [www.ietf.org/rfc/rfc2616.txt][1].

</note>

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see [Using Server-Side Encryption].

Access Permissions

: You can optionally specify the accounts or groups that should be

granted specific permissions on the new object. There are two ways
to grant the permissions using the request headers:

* Specify a canned ACL with the `x-amz-acl` request header. For more
  information, see [Canned ACL][3].

* 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. These parameters map to the
  set of permissions that Amazon S3 supports in an ACL. For more
  information, see [Access Control List (ACL) Overview][4].

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

Server-Side- Encryption-Specific Request Headers

: You can optionally tell Amazon S3 to encrypt data at rest using

server-side encryption. Server-side encryption is for data
encryption at rest. Amazon S3 encrypts your data as it writes it to
disks in its data centers and decrypts it when you access it. The
option you use depends on whether you want to use AWS managed
encryption keys or provide your own encryption key.

* Use encryption keys managed by Amazon S3 or customer master keys
  (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
  want AWS to manage the keys used to encrypt data, specify the
  following headers in the request.

  * x-amz-server-side-encryption

  * x-amz-server-side-encryption-aws-kms-key-id

  * x-amz-server-side-encryption-context

  <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
  provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
  uses the AWS managed CMK in AWS KMS to protect the data. If you
  want to use a customer managed AWS KMS CMK, you must provide the
  `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
  customer managed CMK. Amazon S3 only supports symmetric CMKs and
  not asymmetric CMKs. For more information, see [Using Symmetric
  and Asymmetric Keys][5] in the *AWS Key Management Service
  Developer Guide*.

   </note>

  All GET and PUT requests for an object protected by AWS KMS fail
  if you don't make them with SSL or by using SigV4.

  For more information about server-side encryption with CMKs stored
  in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in AWS][6].

* Use customer-provided encryption keys – If you want to manage your
  own encryption keys, provide all the following headers in the
  request.

  * x-amz-server-side-encryption-customer-algorithm

  * x-amz-server-side-encryption-customer-key

  * x-amz-server-side-encryption-customer-key-MD5

  For more information about server-side encryption with CMKs stored
  in KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in AWS][6].

Access-Control-List (ACL)-Specific Request Headers

: You also can use the following access control–related headers with

this operation. By default, all objects are private. Only the owner
has full access control. When adding a new object, you can grant
permissions to individual AWS accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the Access
Control List (ACL) on the object. For more information, see [Using
ACLs][7]. With this operation, you can grant access permissions
using one of the following two methods:

* Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
  predefined ACLs, known as canned ACLs. Each canned ACL has a
  predefined set of grantees and permissions. For more information,
  see [Canned ACL][3].

* Specify access permissions explicitly — To explicitly grant access
  permissions to specific AWS accounts or groups, use the following
  headers. Each header maps to specific permissions that Amazon S3
  supports in an ACL. For more information, see [Access Control List
  (ACL) Overview][4]. In the header, you specify a list of grantees
  who get the specific permission. To grant permissions explicitly
  use:

  * x-amz-grant-read

  * x-amz-grant-write

  * x-amz-grant-read-acp

  * x-amz-grant-write-acp

  * x-amz-grant-full-control

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

  * `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)

    * EU (Ireland)

    * South America (São Paulo)

     For a list of all the Amazon S3 supported Regions and
    endpoints,
    see [Regions and Endpoints][8] in the AWS General Reference

  * `id` – if the value specified is the canonical user ID of an AWS
    account

  * `uri` – if you are granting permissions to a predefined group

  For example, the following `x-amz-grant-read` header grants the
  AWS accounts identified by email addresses permissions to read
  object data and its metadata:

  `x-amz-grant-read: emailAddress="[email protected]",
  emailAddress="[email protected]" `

Server-Side- Encryption-Specific Request Headers

: You can optionally tell Amazon S3 to encrypt data at rest using

server-side encryption. Server-side encryption is for data
encryption at rest. Amazon S3 encrypts your data as it writes it to
disks in its data centers and decrypts it when you access it. The
option you use depends on whether you want to use AWS-managed
encryption keys or provide your own encryption key.

* Use encryption keys managed by Amazon S3 or customer master keys
  (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
  want AWS to manage the keys used to encrypt data, specify the
  following headers in the request.

  * x-amz-server-side-encryption

  * x-amz-server-side-encryption-aws-kms-key-id

  * x-amz-server-side-encryption-context

  <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
  provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
  uses the AWS managed CMK in AWS KMS to protect the data. If you
  want to use a customer managed AWS KMS CMK, you must provide the
  `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
  customer managed CMK. Amazon S3 only supports symmetric CMKs and
  not asymmetric CMKs. For more information, see [Using Symmetric
  and Asymmetric Keys][5] in the *AWS Key Management Service
  Developer Guide*.

   </note>

  All GET and PUT requests for an object protected by AWS KMS fail
  if you don't make them with SSL or by using SigV4.

  For more information about server-side encryption with CMKs stored
  in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in AWS KMS][6].

* Use customer-provided encryption keys – If you want to manage your
  own encryption keys, provide all the following headers in the
  request.

  <note markdown="1"> If you use this feature, the ETag value that Amazon S3 returns in
  the response is not the MD5 of the object.

   </note>

  * x-amz-server-side-encryption-customer-algorithm

  * x-amz-server-side-encryption-customer-key

  * x-amz-server-side-encryption-customer-key-MD5

  For more information about server-side encryption with CMKs stored
  in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in AWS KMS][6].

**Storage Class Options**

By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see [Storage Classes] in the Amazon Simple Storage Service Developer Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the ‘x-amz-version-id response` header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see GetBucketVersioning. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

**Related Resources**

CopyObject
DeleteObject

Examples:

Example: To upload an object (specify optional headers)


# The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
# storage class and use server-side encryption.

resp = client.put_object({
  body: "HappyFace.jpg", 
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
  server_side_encryption: "AES256", 
  storage_class: "STANDARD_IA", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  server_side_encryption: "AES256", 
  version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp", 
}

Example: To upload an object and specify optional tags


# The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
# S3 returns version ID of the newly created object.

resp = client.put_object({
  body: "c:\\HappyFace.jpg", 
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
  tagging: "key1=value1&key2=value2", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a", 
}

Example: To upload object and specify user-defined metadata


# The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
# enabled, S3 returns version ID in response.

resp = client.put_object({
  body: "filetoupload", 
  bucket: "examplebucket", 
  key: "exampleobject", 
  metadata: {
    "metadata1" => "value1", 
    "metadata2" => "value2", 
  }, 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", 
}

Example: To create an object.


# The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.

resp = client.put_object({
  body: "filetoupload", 
  bucket: "examplebucket", 
  key: "objectkey", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", 
}

Example: To upload an object


# The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
# syntax. S3 returns VersionId of the newly created object.

resp = client.put_object({
  body: "HappyFace.jpg", 
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", 
}

Example: To upload an object and specify canned ACL.


# The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
# access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.

resp = client.put_object({
  acl: "authenticated-read", 
  body: "filetoupload", 
  bucket: "examplebucket", 
  key: "exampleobject", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr", 
}

Example: To upload an object and specify server-side encryption and object tags


# The following example uploads and object. The request specifies the optional server-side encryption option. The request
# also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.

resp = client.put_object({
  body: "filetoupload", 
  bucket: "examplebucket", 
  key: "exampleobject", 
  server_side_encryption: "AES256", 
  tagging: "key1=value1&key2=value2", 
})

resp.to_h outputs the following:
{
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  server_side_encryption: "AES256", 
  version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", 
}

Streaming a file from disk

# upload file from disk in a single request, may not exceed 5GB
File.open('/source/file/path', 'rb') do |file|
  s3.put_object(bucket: 'bucket-name', key: 'object-key', body: file)
end

Request syntax with placeholder values


resp = client.put_object({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  body: source_file,
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_length: 1,
  content_md5: "ContentMD5",
  content_type: "ContentType",
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  server_side_encryption: "AES256", # accepts AES256, aws:kms
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
})

Response structure


resp.expiration #=> String
resp.etag #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
resp.version_id #=> String
resp.sse_customer_algorithm #=> String
resp.sse_customer_key_md5 #=> String
resp.ssekms_key_id #=> String
resp.ssekms_encryption_context #=> String
resp.request_charged #=> String, one of "requester"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:acl (String) —

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
:body (String, IO) —

Object data.
:bucket (required, String) —

Bucket name to which the PUT operation was initiated.

When using this API with an access point, 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using Access Points] in the *Amazon Simple Storage Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
: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
:content_disposition (String) —

Specifies presentational information for the object. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
: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.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
:content_language (String) —

The language the content is in.
: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.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
: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].

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
:content_type (String) —

A standard MIME type describing the format of the contents. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
:expires (Time, DateTime, Date, Integer, String) —

The date and time at which the object is no longer cacheable. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
: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.
:key (required, String) —

Object key for which the PUT operation was initiated.
:metadata (Hash<String,String>) —

A map of metadata to store with the object in S3.
:server_side_encryption (String) —

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
:storage_class (String) —

If you don’t specify, Standard is the default storage class. Amazon S3 supports other storage classes.
: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 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] and [How to Configure Website Page Redirects].

[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
:sse_customer_algorithm (String) —

Specifies the algorithm to use to 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. 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.
: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.
:ssekms_key_id (String) —

If ‘x-amz-server-side-encryption` is present and has the value of `aws:kms`, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of ‘x-amz-server-side-encryption` is `aws:kms`, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify `x-amz-server-side-encryption:aws:kms`, but do not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS managed CMK in AWS to protect the data.
:ssekms_encryption_context (String) —

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
: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. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets] in the *Amazon S3 Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
:tagging (String) —

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

The Object Lock mode that you want to apply to this object.
:object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

The date and time when you want this object’s Object Lock to expire.
: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].

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

Returns:

(Types::PutObjectOutput) —
Returns a response object which responds to the following methods:
- #expiration => String
- #etag => String
- #server_side_encryption => String
- #version_id => String
- #sse_customer_algorithm => String
- #sse_customer_key_md5 => String
- #ssekms_key_id => String
- #ssekms_encryption_context => String
- #request_charged => String