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

Module: Aws::S3

Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/md5s.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/sse_cpk.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/utils.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/client.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/errors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/dualstack.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/redirects.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/s3_signer.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/accelerate.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/bucket_dns.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/s3_host_id.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/materials.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/bucket.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_decrypter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_encrypter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/key_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/http_200_errors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/url_encoded_keys.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/decrypt_handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/encrypt_handler.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/expect_100_continue.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/location_constraint.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/io_auth_decrypter.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object_summary.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/multipart_upload.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/default_key_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/default_cipher_provider.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/client.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/errors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/waiters.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/resource.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_part.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/presigner.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_acl.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_acl.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_cors.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_policy.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_uploader.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/legacy_signer.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_copier.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_logging.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_website.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_summary.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_version.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/presigned_post.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/file_downloader.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_versioning.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_notification.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_region_cache.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_part.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_request_payment.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_upload_error.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/multipart_file_uploader.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/object_multipart_copier.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb,
gems/aws-sdk-s3/lib/aws-sdk-s3.rb

Overview

This module provides support for Amazon Simple Storage Service. This module is available in the aws-sdk-s3 gem.

Client

The Client class provides one method for each API operation. Operation methods each accept a hash of request parameters and return a response structure.

See Client for more information.

Errors

Errors returned from Amazon Simple Storage Service all extend Errors::ServiceError.

begin
  # do stuff
rescue Aws::S3::Errors::ServiceError
  # rescues all service API errors
end

See Errors for more information.

Defined Under Namespace

Modules: Encryption, Errors, Plugins, Types, Waiters 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

GEM_VERSION =
'1.8.0'