Uploading an Object with Metadata to an Amazon S3 Bucket

The following code example uploads an object to a bucket in Amazon S3, associating the specified metadata with the uploaded object.

# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX - License - Identifier: Apache - 2.0

require 'aws-sdk-s3'
 
# Uploads an object to a bucket in Amazon Simple Storage Service (Amazon S3).
#   Also associates specified metadata with the uploaded object.
#
# Prerequisites:
#
# - An S3 bucket.
# - An object to upload to the bucket.
#
# @param s3_client [Aws::S3::Client] An initialized S3 client.
# @param bucket_name [String] The name of the bucket.
# @param object_key [String] The name of the object.
# @param metadata [Hash] Metadata to associate with the uploaded object.
# @return [Boolean] true if the object was uploaded; otherwise, false.
# @example
#   exit 1 unless object_uploaded?(
#     Aws::S3::Client.new(region: 'us-east-1'),
#     'doc-example-bucket',
#     'my-file.txt'
#   )
def object_uploaded_with_metadata?(
  s3_client,
  bucket_name,
  object_key,
  metadata
)
  response = s3_client.put_object(
    bucket: bucket_name,
    key: object_key,
    metadata: metadata
  )
  if response.etag
    return true
  else
    return false
  end
rescue StandardError => e
  puts "Error uploading object: #{e.message}"
  return false
end

# Full example call:
def run_me
  bucket_name = 'doc-example-bucket'
  object_key = 'my-file.txt'
  metadata = {
    author: 'Mary Doe',
    version: '1.0.0.0'
  }
  region = 'us-east-1'
  s3_client = Aws::S3::Client.new(region: region)

  if object_uploaded_with_metadata?(
    s3_client,
    bucket_name,
    object_key,
    metadata
  )
    puts "Object '#{object_key}' uploaded to bucket '#{bucket_name}' " \
      'with metadata.'
  else
    puts "Object '#{object_key}' not uploaded to bucket '#{bucket_name}'."
  end
end

run_me if $PROGRAM_NAME == __FILE__