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

Module: Aws::S3

Defined in:: aws-sdk-core/lib/aws-sdk-core/s3.rb,
aws-sdk-core/lib/aws-sdk-core/s3/presigner.rb,
aws-sdk-core/lib/aws-sdk-core/s3/bucket_region_cache.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/bucket.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/object.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/file_part.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption_v2.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/file_uploader.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/object_copier.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/object_summary.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/presigned_post.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/file_downloader.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/utils.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/multipart_upload.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/client.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/errors.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/utils.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/client.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/errors.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/materials.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/materials.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/multipart_upload_error.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/io_decrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/io_encrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/key_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/multipart_file_uploader.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/object_multipart_copier.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/io_decrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/io_encrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/key_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/decrypt_handler.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/encrypt_handler.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/io_auth_decrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/decrypt_handler.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/encrypt_handler.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/kms_cipher_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/io_auth_decrypter.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/default_key_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/kms_cipher_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/default_key_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/default_cipher_provider.rb,
aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryptionV2/default_cipher_provider.rb more...

Overview

This module provides a client for making API requests to Amazon Simple Storage Service.

Aws::S3::Client

The Client class provides one-to-one mapping for each API operation.

s3 = Aws::S3::Client.new(region: 'us-east-1')
s3.operation_names
#=> [:abort_multipart_upload, :complete_multipart_upload, :copy_object, :create_bucket, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = s3.abort_multipart_upload(params)

See Client for more information.

Aws::S3::Errors

Errors returned from Amazon Simple Storage Service are defined in the Errors module and extend Errors::ServiceError.

begin
  # do stuff
rescue Aws::S3::Errors::ServiceError
  # rescues all errors returned by Amazon Simple Storage Service
end

See Errors for more information.

Defined Under Namespace

Modules: Encryption, EncryptionV2, Errors, Types Classes: Bucket, BucketAcl, BucketCors, BucketLifecycle, BucketLifecycleConfiguration, BucketLogging, BucketNotification, BucketPolicy, BucketRegionCache, BucketRequestPayment, BucketTagging, BucketVersioning, BucketWebsite, Client, MultipartUpload, MultipartUploadError, MultipartUploadPart, Object, ObjectAcl, ObjectSummary, ObjectVersion, PresignedPost, Presigner, Resource

Constant Summary collapse

REQUIRED_PARAMS =

[:key_wrap_schema, :content_encryption_schema, :security_profile]

SUPPORTED_SECURITY_PROFILES =