You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutObjectRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  body: source_file, # file/IO object, or string data
  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, OUTPOSTS
  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
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

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

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    The canned ACL to apply to the object.

#body ⇒ IO

Object data.

Returns:

  • (IO) —

    Object data.

#bucket ⇒ String

The 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 with 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.

When using this API 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 using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    The bucket name to which the PUT operation was initiated.

#cache_control ⇒ String

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

Returns:

  • (String) —

    Can be used to specify caching behavior along the request/reply chain.

#content_disposition ⇒ String

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

Returns:

  • (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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Returns:

  • (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.

Returns:

  • (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 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Returns:

  • (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. 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.

Returns:

  • (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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

Returns:

  • (String) —

    A standard MIME type describing the format of the contents.

#expected_bucket_owner ⇒ String

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (String) —

    The account id of the expected bucket owner.

#expires ⇒ Time

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

Returns:

  • (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.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (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.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to read the object data and its metadata.

#grant_read_acp ⇒ String

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to read the object ACL.

#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to write the ACL for the applicable object.

#key ⇒ String

Object key for which the PUT operation was initiated.

Returns:

  • (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.

Returns:

  • (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. For more information about S3 Object Lock, see Object Lock.

Returns:

  • (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.

Possible values:

  • GOVERNANCE
  • COMPLIANCE

Returns:

  • (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.

Returns:

  • (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. 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.

Possible values:

  • requester

Returns:

  • (String) —

    Confirms that the requester knows that they will be charged for the request.

#server_side_encryption ⇒ String

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

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String) —

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

#sse_customer_algorithm ⇒ String

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

Returns:

  • (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.

Returns:

  • (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. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

  • (String) —

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#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.

Returns:

  • (String) —

    Specifies the AWS KMS Encryption Context to use for object encryption.

#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.

Returns:

  • (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.

#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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Returns:

  • (String) —

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

#tagging ⇒ String

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

Returns:

  • (String) —

    The tag-set for the object.

#use_accelerate_endpoint ⇒ Boolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#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: http://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.

Returns:

  • (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.