Class: Aws::S3::EncryptionV3::Client

Inherits:

Object

• Object
• Aws::S3::EncryptionV3::Client

Extended by:

Deprecations, Forwardable

Defined in:

lib/aws-sdk-s3/encryptionV3/client.rb

Constant Summary

REQUIRED_PARAMS =

../specification/s3-encryption/client.md#aws-sdk-compatibility

type=implication

% The S3EC MUST provide a different set of configuration options than the conventional S3 client.

[:key_wrap_schema].freeze

OPTIONAL_PARAMS =

[
  :kms_key_id,
  :kms_client,
  :key_provider,
  :encryption_key,
  :envelope_location,
  ##= ../specification/s3-encryption/client.md#instruction-file-configuration
  ##% In this case, the Instruction File Configuration SHOULD be optional, such that its default configuration is used when none is provided.
  :instruction_file_suffix,
  ##= ../specification/s3-encryption/client.md#encryption-algorithm
  ##% The S3EC MUST support configuration of the encryption algorithm (or algorithm suite) during its initialization.
  :content_encryption_schema,
  :security_profile,
  ##= ../specification/s3-encryption/client.md#key-commitment
  ##% The S3EC MUST support configuration of the [Key Commitment policy](./key-commitment.md) during its initialization.
  :commitment_policy
].freeze

SUPPORTED_COMMITMENT_POLICIES =

i[
  forbid_encrypt_allow_decrypt
  require_encrypt_allow_decrypt
  require_encrypt_require_decrypt
].freeze

SUPPORTED_SECURITY_PROFILES =

../specification/s3-encryption/client.md#enable-legacy-wrapping-algorithms

% The S3EC MUST support the option to enable or disable legacy wrapping algorithms.

../specification/s3-encryption/client.md#enable-legacy-unauthenticated-modes

% The S3EC MUST support the option to enable or disable legacy unauthenticated modes (content encryption algorithms).

i[v3 v3_and_legacy].freeze

DEFAULT_SECURITY_PROFILES =

../specification/s3-encryption/client.md#enable-legacy-unauthenticated-modes

% The option to enable legacy unauthenticated modes MUST be set to false by default.

../specification/s3-encryption/client.md#enable-legacy-wrapping-algorithms

% The option to enable legacy wrapping algorithms MUST be set to false by default.

:v3

DEFAULT_COMMITMENT_POLICIES =

:require_encrypt_require_decrypt

DEFAULT_CONTENT_ENCRYPTION_SCHEMA =

:alg_aes_256_gcm_hkdf_sha512_commit_key

Instance Attribute Summary

• #client ⇒ S3::Client readonly
• #commitment_policy ⇒ Symbol readonly

  Determines the support for reading objects written using older key wrap or content encryption schemas.

• #envelope_location ⇒ Symbol<:metadata, :instruction_file> readonly
• #instruction_file_suffix ⇒ String readonly

  When #envelope_location is ‘:instruction_file`, the envelope is stored in the object with the object key suffixed by this string.

• #key_provider ⇒ KeyProvider^? readonly

  Returns ‘nil` if you are using AWS Key Management Service (KMS).

• #kms_allow_decrypt_with_any_cmk ⇒ Boolean readonly

  If true the provided KMS key_id will not be used during decrypt, allowing decryption with the key_id from the object.

Instance Method Summary

• #get_object(params = {}, &block) ⇒ Types::GetObjectOutput

  Gets an object from Amazon S3, decrypting data locally.

• #initialize(options = {}) ⇒ Client constructor

  Creates a new encryption client.

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

  Uploads an object to Amazon S3, encrypting data client-side.

Constructor Details

#initialize(options = {}) ⇒ Client

Creates a new encryption client.

## Required Configuration

• a key or key provider - The key provided also determines the key wrapping schema(s) supported for both encryption and decryption.

• ‘key_wrap_schema` - The key wrapping schema. It must match the type of key configured.

## Optional Configuration (with defaults)

• ‘content_encryption_schema` - Defaults to `:alg_aes_256_gcm_hkdf_sha512_commit_key`

• ‘security_profile` - Defaults to `:v3`. Set to `:v3_and_legacy` to read V2-encrypted objects.

• ‘commitment_policy` - Defaults to `:require_encrypt_require_decrypt` (most secure)

To configure the key you must provide one of the following set of options:

• ‘:encryption_key`

• ‘:kms_key_id`

• ‘:key_provider`

You may also pass any other options accepted by ‘Client#initialize`.

Options Hash (options):

• :client (S3::Client) —

  A basic S3 client that is used to make api calls. If a ‘:client` is not provided, a new Client will be constructed.

• :encryption_key (OpenSSL::PKey::RSA, String) —

  The master key to use for encrypting/decrypting all objects.

• :kms_key_id (String) —

  When you provide a ‘:kms_key_id`, then AWS Key Management Service (KMS) will be used to manage the object encryption keys. By default a KMS::Client will be constructed for KMS API calls. Alternatively, you can provide your own via `:kms_client`. To only support decryption/reads, you may provide `:allow_decrypt_with_any_cmk` which will use the implicit CMK associated with the data during reads but will not allow you to encrypt/write objects with this client.

• :key_provider (#key_for) —

  Any object that responds to ‘#key_for`. This method should accept a materials description JSON document string and return return an encryption key.

• :key_wrap_schema (required, Symbol) —

  The Key wrapping schema to be used. It must match the type of key configured. Must be one of the following:

  • :kms_context (Must provide kms_key_id)

  • :aes_gcm (Must provide an AES (string) key)

  • :rsa_oaep_sha1 (Must provide an RSA key)

• :content_encryption_schema (Symbol) — default: :alg_aes_256_gcm_hkdf_sha512_commit_key —

  The content encryption algorithm to use. Defaults to the V3 algorithm with key commitment.

• :security_profile (Symbol) — default: :v3 —

  Determines the support for reading objects written using older encryption schemas. Must be one of the following:

  • :v3 - Only reads V3-encrypted objects (default, most secure)

  • :v3_and_legacy - Enables reading of V2-encrypted objects

• :commitment_policy (Symbol) — default: :require_encrypt_require_decrypt —

  Determines support for key commitment. Must be one of the following:

  • :forbid_encrypt_allow_decrypt - Does not encrypt with key commitment, can decrypt with or without. Use only for specific compatibility needs.

  • :require_encrypt_allow_decrypt - Encrypts with key commitment, can decrypt with or without.

  • :require_encrypt_require_decrypt - Encrypts with key commitment, only decrypts objects with key commitment (default, most secure)

• :envelope_location (Symbol) — default: :metadata —

  Where to store the envelope encryption keys. By default, the envelope is stored with the encrypted object. If you pass ‘:instruction_file`, then the envelope is stored in a separate object in Amazon S3.

• :instruction_file_suffix (String) — default: '.instruction' —

  When ‘:envelope_location` is `:instruction_file` then the instruction file uses the object key with this suffix appended.

• :kms_client (KMS::Client) —

  A default KMS::Client is constructed when using KMS to manage encryption keys.

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 375

def initialize(options = {})
  validate_params(options)
  ##= ../specification/s3-encryption/client.md#wrapped-s3-client-s
  ##% The S3EC MUST support the option to provide an SDK S3 client instance during its initialization.
  @client = extract_client(options)
  ##= ../specification/s3-encryption/data-format/metadata-strategy.md#instruction-file
  ##% Instruction File writes MUST be optionally configured during client creation or on each PutObject request.
  ##= ../specification/s3-encryption/client.md#instruction-file-configuration
  ##% The S3EC MAY support the option to provide Instruction File Configuration during its initialization.
  ##= ../specification/s3-encryption/client.md#instruction-file-configuration
  ##% If the S3EC in a given language supports Instruction Files, then it MUST accept Instruction File Configuration during its initialization.
  @envelope_location = extract_location(options)
  @instruction_file_suffix = extract_suffix(options)
  @kms_allow_decrypt_with_any_cmk =
    options[:kms_key_id] == :kms_allow_decrypt_with_any_cmk
  @commitment_policy = extract_commitment_policy(options)
  @security_profile = extract_security_profile(options)

  ##= ../specification/s3-encryption/client.md#key-commitment
  ##% The S3EC MUST validate the configured Encryption Algorithm against the provided key commitment policy.
  if @commitment_policy != :require_encrypt_require_decrypt
    new_options = options.merge(
      {
        security_profile: security_profile_to_v2(@security_profile),
        ##= ../specification/s3-encryption/client.md#key-commitment
        ##% If the configured Encryption Algorithm is incompatible with the key commitment policy, then it MUST throw an exception.
        content_encryption_schema: if @commitment_policy == :forbid_encrypt_allow_decrypt
                                     options[:content_encryption_schema]
                                   else
                                     # assert @commitment_policy = :require_encrypt_allow_decrypt
                                     # In this case the v2_cipher_provider is only used for decrypt
                                     :aes_gcm_no_padding
                                   end
      }
    )
    @v2_cipher_provider = build_v2_cipher_provider_for_decrypt(new_options)
    # In this case the v3 cipher is only used for decrypt.
    @v3_cipher_provider = build_cipher_provider(options.reject { |k, _| k == :content_encryption_schema })
    @key_provider = @v2_cipher_provider.key_provider if @v2_cipher_provider.is_a?(DefaultCipherProvider)
  else
    @v3_cipher_provider = build_cipher_provider(options)
    @key_provider = @v3_cipher_provider.key_provider if @v3_cipher_provider.is_a?(DefaultCipherProvider)
  end
end

Instance Attribute Details

#client ⇒ S3::Client (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 421

def client
  @client
end

#commitment_policy ⇒ Symbol (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 429

def commitment_policy
  @commitment_policy
end

#envelope_location ⇒ Symbol<:metadata, :instruction_file> (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 436

def envelope_location
  @envelope_location
end

#instruction_file_suffix ⇒ String (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 441

def instruction_file_suffix
  @instruction_file_suffix
end

#key_provider ⇒ KeyProvider^? (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 425

def key_provider
  @key_provider
end

#kms_allow_decrypt_with_any_cmk ⇒ Boolean (readonly)

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 433

def kms_allow_decrypt_with_any_cmk
  @kms_allow_decrypt_with_any_cmk
end

Instance Method Details

#get_object(params = {}, &block) ⇒ Types::GetObjectOutput

Note:

The ‘:range` request parameter is not supported.

Gets an object from Amazon S3, decrypting data locally. See Client#get_object for documentation on accepted request parameters. Warning: If you provide a block to get_object or set the request parameter :response_target to a Proc, then read the entire object to the end before you start using the decrypted data. This is to verify that the object has not been modified since it was encrypted.

Options Hash (params):

• :instruction_file_suffix (String) —

  The suffix used to find the instruction file containing the encryption envelope. You should not set this option when the envelope is stored in the object metadata. Defaults to #instruction_file_suffix.

• :kms_encryption_context (Hash) —

  Additional encryption context to use with KMS. Applies only when KMS is used.

• :response_target (String, IO) —

  Where to write response data, file path, or IO object.

• :bucket (required, String) —

  The bucket name containing the object.

  **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, ` amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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] in the *Amazon S3 User Guide*.

  **Object Lambda access points** - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

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

  </note>
  

  **S3 on Outposts** - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see [What is S3 on Outposts?] 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

• :if_match (String) —

  Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a ‘412 Precondition Failed` error.

  If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

  For more information about conditional requests, see [RFC 7232].

  [1]: tools.ietf.org/html/rfc7232

• :if_modified_since (Time, DateTime, Date, Integer, String) —

  Return the object only if it has been modified since the specified time; otherwise, return a ‘304 Not Modified` error.

  If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` status code.

  For more information about conditional requests, see [RFC 7232].

  [1]: tools.ietf.org/html/rfc7232

• :if_none_match (String) —

  Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a ‘304 Not Modified` error.

  If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` HTTP status code.

  For more information about conditional requests, see [RFC 7232].

  [1]: tools.ietf.org/html/rfc7232

• :if_unmodified_since (Time, DateTime, Date, Integer, String) —

  Return the object only if it has not been modified since the specified time; otherwise, return a ‘412 Precondition Failed` error.

  If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

  For more information about conditional requests, see [RFC 7232].

  [1]: tools.ietf.org/html/rfc7232

• :key (required, String) —

  Key of the object to get.

• :range (String) —

  Downloads the specified byte range of an object. For more information about the HTTP Range header, see [www.rfc-editor.org/rfc/rfc9110.html#name-range][1].

  <note markdown=“1”> Amazon S3 doesn’t support retrieving multiple ranges of data per ‘GET` request.

  </note>
  

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

• :response_cache_control (String) —

  Sets the ‘Cache-Control` header of the response.

• :response_content_disposition (String) —

  Sets the ‘Content-Disposition` header of the response.

• :response_content_encoding (String) —

  Sets the ‘Content-Encoding` header of the response.

• :response_content_language (String) —

  Sets the ‘Content-Language` header of the response.

• :response_content_type (String) —

  Sets the ‘Content-Type` header of the response.

• :response_expires (Time, DateTime, Date, Integer, String) —

  Sets the ‘Expires` header of the response.

• :version_id (String) —

  Version ID used to reference a specific version of the object.

  By default, the ‘GetObject` operation returns the current version of an object. To return a different version, use the `versionId` subresource.

  <note markdown=“1”> * If you include a ‘versionId` in your request header, you must have

  the `s3:GetObjectVersion` permission to access a specific version of
  an object. The `s3:GetObject` permission is not required in this
  scenario.
  

  • If you request the current version of an object without a specific ‘versionId` in the request header, only the `s3:GetObject` permission is required. The `s3:GetObjectVersion` permission is not required in this scenario.

  • **Directory buckets** - S3 Versioning isn’t enabled and supported for directory buckets. For this API operation, only the ‘null` value of the version ID is supported by directory buckets. You can only specify `null` to the `versionId` query parameter in the request.

  </note>
  

  For more information about versioning, see [PutBucketVersioning].

  [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html

• :sse_customer_algorithm (String) —

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

  If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • ‘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 SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] 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/ServerSideEncryptionCustomerKeys.html

• :sse_customer_key (String) —

  Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

  If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • ‘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 SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] 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/ServerSideEncryptionCustomerKeys.html

• :sse_customer_key_md5 (String) —

  Specifies the 128-bit MD5 digest of the customer-provided 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.

  If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • ‘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 SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] 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/ServerSideEncryptionCustomerKeys.html

• :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

• :part_number (Integer) —

  Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

• :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).

• :checksum_mode (String) —

  To retrieve the checksum, this mode must be enabled.

Raises:

• (NotImplementedError)

See Also:

• Client#get_object

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 521

def get_object(params = {}, &block)
  raise NotImplementedError, '#get_object with :range not supported' if params[:range]

  envelope_location, instruction_file_suffix = envelope_options(params)
  kms_encryption_context = params.delete(:kms_encryption_context)
  kms_any_cmk_mode = kms_any_cmk_mode(params)
  commitment_policy = commitment_policy_from_params(params)

  ##= ../specification/s3-encryption/client.md#required-api-operations
  ##% - GetObject MUST be implemented by the S3EC.
  req = @client.build_request(:get_object, params)
  ##= ../specification/s3-encryption/client.md#required-api-operations
  ##% - GetObject MUST decrypt data received from the S3 server and return it as plaintext.
  req.handlers.add(DecryptHandler)
  req.context[:encryption] = {
    v3_cipher_provider: @v3_cipher_provider,
    envelope_location: envelope_location,
    instruction_file_suffix: instruction_file_suffix,
    kms_encryption_context: kms_encryption_context,
    kms_allow_decrypt_with_any_cmk: kms_any_cmk_mode,
    commitment_policy: commitment_policy
  }.tap do |hash|
    if commitment_policy != :require_encrypt_require_decrypt
      security_profile = security_profile_from_params(params)
      hash[:security_profile] = security_profile_to_v2(security_profile)
      hash[:cipher_provider] = @v2_cipher_provider
    end
  end
  Aws::Plugins::UserAgent.metric('S3_CRYPTO_V3') do
    req.send_request(target: block)
  end
end

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

Uploads an object to Amazon S3, encrypting data client-side. See Client#put_object for documentation on accepted request parameters.

Options Hash (params):

• :kms_encryption_context (Hash) —

  Additional encryption context to use with KMS. Applies only when KMS is used. In order to decrypt the object you will need to provide the identical :kms_encryption_context to ‘get_object`.

• :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

• :body (String, StringIO, File) —

  Object data.

• :bucket (required, 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, ` amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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] in the *Amazon S3 User Guide*.

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

  </note>
  

  **S3 on Outposts** - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see [What is S3 on Outposts?] 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

• :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.rfc-editor.org/rfc/rfc6266#section-4][1].

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

• :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

• :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.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].

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

• :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].

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

  <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

• :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

• :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`

  • ‘CRC64NVME`

  • ‘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 fails the request with a `BadDigest` error.

  <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

• :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 ‘CRC32` 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

• :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 ‘CRC32C` 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

• :checksum_crc64nvme (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, 64-bit ‘CRC64NVME` checksum of the object. The `CRC64NVME` checksum is always a full object checksum. 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

• :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 ‘SHA1` 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

• :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 ‘SHA256` 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

• :expires (Time, DateTime, Date, Integer, String) —

  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

• :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][2

  in the *Amazon S3 User Guide*.

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

• :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][2

  in the *Amazon S3 User Guide*.

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

• :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>
  

• :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>
  

• :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>
  

• :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>
  

• :key (required, String) —

  Object key for which the PUT action was initiated.

• :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>
  

• :metadata (Hash<String,String>) —

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

• :server_side_encryption (String) —

  The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.

  • 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] 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] and [UploadPartCopy]), the encryption request headers must match the default encryption configuration of the directory bucket.

    </note>
    

  • S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is ‘aws:fsx`. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.

  [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

• :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] in the *Amazon S3 User Guide*.

  <note markdown=“1”> * Directory buckets only support ‘EXPRESS_ONEZONE` (the S3 Express One

  Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3
  One Zone-Infrequent Access storage class) in Dedicated Local Zones.
  

  • Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

  </note>
  

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

• :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] 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

• :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>
  

• :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>
  

• :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>
  

• :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** - To encrypt data using SSE-KMS, it’s recommended to specify the ‘x-amz-server-side-encryption` header to `aws:kms`. Then, the `x-amz-server-side-encryption-aws-kms-key-id` header implicitly uses the bucket’s default KMS customer managed key ID. If you want to explicitly set the ‘ x-amz-server-side-encryption-aws-kms-key-id` header, it must match the bucket’s default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket’s lifetime. The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported. Incorrect key specification results in an HTTP ‘400 Bad Request` error.

  [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

• :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

• :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

• :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

• :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>
  

• :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>
  

• :object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

  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>
  

• :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

• :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).

See Also:

• Client#put_object

# File 'lib/aws-sdk-s3/encryptionV3/client.rb', line 461

def put_object(params = {})
  kms_encryption_context = params.delete(:kms_encryption_context)
  ##= ../specification/s3-encryption/client.md#required-api-operations
  ##% - PutObject MUST be implemented by the S3EC.
  req = @client.build_request(:put_object, params)
  ##= ../specification/s3-encryption/client.md#required-api-operations
  ##% - PutObject MUST encrypt its input data before it is uploaded to S3.
  req.handlers.add(EncryptHandler, priority: 95)
  req.context[:encryption] = {
    cipher_provider:
    if @commitment_policy == :forbid_encrypt_allow_decrypt
      ##= ../specification/s3-encryption/key-commitment.md#commitment-policy
      ##% When the commitment policy is FORBID_ENCRYPT_ALLOW_DECRYPT, the S3EC MUST NOT encrypt using an algorithm suite which supports key commitment.
      @v2_cipher_provider
    else
      ##= ../specification/s3-encryption/key-commitment.md#commitment-policy
      ##% When the commitment policy is REQUIRE_ENCRYPT_ALLOW_DECRYPT, the S3EC MUST only encrypt using an algorithm suite which supports key commitment.
      ##= ../specification/s3-encryption/key-commitment.md#commitment-policy
      ##% When the commitment policy is REQUIRE_ENCRYPT_REQUIRE_DECRYPT, the S3EC MUST only encrypt using an algorithm suite which supports key commitment.
      @v3_cipher_provider
    end,
    envelope_location: @envelope_location,
    instruction_file_suffix: @instruction_file_suffix,
    kms_encryption_context: kms_encryption_context
  }
  Aws::Plugins::UserAgent.metric('S3_CRYPTO_V3') do
    req.send_request
  end
end