Module: Aws::S3

Defined in:
lib/aws-sdk-s3/bucket_acl.rb,
lib/aws-sdk-s3/file_part.rb,
lib/aws-sdk-s3/presigner.rb,
lib/aws-sdk-s3/client_api.rb,
lib/aws-sdk-s3/encryption.rb,
lib/aws-sdk-s3/object_acl.rb,
lib/aws-sdk-s3/bucket_cors.rb,
lib/aws-sdk-s3/plugins/arn.rb,
lib/aws-sdk-s3/plugins/md5s.rb,
lib/aws-sdk-s3/bucket_policy.rb,
lib/aws-sdk-s3/encryption_v2.rb,
lib/aws-sdk-s3/event_streams.rb,
lib/aws-sdk-s3/file_uploader.rb,
lib/aws-sdk-s3/legacy_signer.rb,
lib/aws-sdk-s3/object_copier.rb,
lib/aws-sdk-s3/bucket_logging.rb,
lib/aws-sdk-s3/bucket_tagging.rb,
lib/aws-sdk-s3/bucket_website.rb,
lib/aws-sdk-s3/customizations.rb,
lib/aws-sdk-s3/object_summary.rb,
lib/aws-sdk-s3/object_version.rb,
lib/aws-sdk-s3/presigned_post.rb,
lib/aws-sdk-s3/file_downloader.rb,
lib/aws-sdk-s3/plugins/sse_cpk.rb,
lib/aws-sdk-s3/bucket_lifecycle.rb,
lib/aws-sdk-s3/encryption/utils.rb,
lib/aws-sdk-s3/multipart_upload.rb,
lib/aws-sdk-s3/bucket_versioning.rb,
lib/aws-sdk-s3/encryption/client.rb,
lib/aws-sdk-s3/encryption/errors.rb,
lib/aws-sdk-s3/endpoint_provider.rb,
lib/aws-sdk-s3/plugins/dualstack.rb,
lib/aws-sdk-s3/plugins/endpoints.rb,
lib/aws-sdk-s3/plugins/redirects.rb,
lib/aws-sdk-s3/plugins/s3_signer.rb,
lib/aws-sdk-s3/encryptionV2/utils.rb,
lib/aws-sdk-s3/plugins/accelerate.rb,
lib/aws-sdk-s3/plugins/bucket_dns.rb,
lib/aws-sdk-s3/plugins/s3_host_id.rb,
lib/aws-sdk-s3/bucket_notification.rb,
lib/aws-sdk-s3/bucket_region_cache.rb,
lib/aws-sdk-s3/encryptionV2/client.rb,
lib/aws-sdk-s3/encryptionV2/errors.rb,
lib/aws-sdk-s3/endpoint_parameters.rb,
lib/aws-sdk-s3/express_credentials.rb,
lib/aws-sdk-s3/encryption/materials.rb,
lib/aws-sdk-s3/customizations/bucket.rb,
lib/aws-sdk-s3/customizations/errors.rb,
lib/aws-sdk-s3/customizations/object.rb,
lib/aws-sdk-s3/multipart_upload_part.rb,
lib/aws-sdk-s3/plugins/access_grants.rb,
lib/aws-sdk-s3/bucket_request_payment.rb,
lib/aws-sdk-s3/encryptionV2/materials.rb,
lib/aws-sdk-s3/multipart_upload_error.rb,
lib/aws-sdk-s3/encryption/io_decrypter.rb,
lib/aws-sdk-s3/encryption/io_encrypter.rb,
lib/aws-sdk-s3/encryption/key_provider.rb,
lib/aws-sdk-s3/multipart_file_uploader.rb,
lib/aws-sdk-s3/object_multipart_copier.rb,
lib/aws-sdk-s3/plugins/http_200_errors.rb,
lib/aws-sdk-s3/plugins/streaming_retry.rb,
lib/aws-sdk-s3/plugins/url_encoded_keys.rb,
lib/aws-sdk-s3/access_grants_credentials.rb,
lib/aws-sdk-s3/encryptionV2/io_decrypter.rb,
lib/aws-sdk-s3/encryptionV2/io_encrypter.rb,
lib/aws-sdk-s3/encryptionV2/key_provider.rb,
lib/aws-sdk-s3/multipart_stream_uploader.rb,
lib/aws-sdk-s3/encryption/decrypt_handler.rb,
lib/aws-sdk-s3/encryption/encrypt_handler.rb,
lib/aws-sdk-s3/plugins/expect_100_continue.rb,
lib/aws-sdk-s3/plugins/location_constraint.rb,
lib/aws-sdk-s3/encryption/io_auth_decrypter.rb,
lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb,
lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb,
lib/aws-sdk-s3/express_credentials_provider.rb,
lib/aws-sdk-s3/plugins/express_session_auth.rb,
lib/aws-sdk-s3/customizations/object_summary.rb,
lib/aws-sdk-s3/customizations/object_version.rb,
lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb,
lib/aws-sdk-s3/bucket_lifecycle_configuration.rb,
lib/aws-sdk-s3/encryption/kms_cipher_provider.rb,
lib/aws-sdk-s3/encryptionV2/io_auth_decrypter.rb,
lib/aws-sdk-s3/customizations/multipart_upload.rb,
lib/aws-sdk-s3/encryption/default_key_provider.rb,
lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb,
lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb,
lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb,
lib/aws-sdk-s3/encryptionV2/default_key_provider.rb,
lib/aws-sdk-s3/access_grants_credentials_provider.rb,
lib/aws-sdk-s3/encryption/default_cipher_provider.rb,
lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb,
lib/aws-sdk-s3/customizations/types/permanent_redirect.rb,
lib/aws-sdk-s3/plugins/skip_whole_multipart_get_checksums.rb,
lib/aws-sdk-s3/endpoints.rb,
lib/aws-sdk-s3/resource.rb,
lib/aws-sdk-s3/waiters.rb,
lib/aws-sdk-s3/object.rb,
lib/aws-sdk-s3/errors.rb,
lib/aws-sdk-s3/client.rb,
lib/aws-sdk-s3/bucket.rb,
lib/aws-sdk-s3/types.rb,
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.

s3 = Aws::S3::Client.new
resp = s3.abort_multipart_upload(params)

See Client for more information.

# Errors

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

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

See Errors for more information.

Defined Under Namespace

Modules: ClientApi, Encryption, EncryptionV2, Endpoints, Errors, EventStreams, Plugins, Types, Waiters Classes: AccessGrantsCredentials, AccessGrantsCredentialsProvider, Bucket, BucketAcl, BucketCors, BucketLifecycle, BucketLifecycleConfiguration, BucketLogging, BucketNotification, BucketPolicy, BucketRegionCache, BucketRequestPayment, BucketTagging, BucketVersioning, BucketWebsite, Client, EndpointParameters, EndpointProvider, ExpressCredentials, ExpressCredentialsProvider, FileDownloader, FilePart, FileUploader, LegacySigner, MultipartFileUploader, MultipartStreamUploader, MultipartUpload, MultipartUploadError, MultipartUploadPart, Object, ObjectAcl, ObjectCopier, ObjectMultipartCopier, ObjectSummary, ObjectVersion, PresignedPost, Presigner, Resource

service collapse

GEM_VERSION = 
'1.172.0'

Constant Summary collapse

AES_GCM_TAG_LEN_BYTES = 
16
EC_USER_AGENT = 
'S3CryptoV1n'
REQUIRED_PARAMS = 
[:key_wrap_schema, :content_encryption_schema, :security_profile]
SUPPORTED_SECURITY_PROFILES = 
[:v2, :v2_and_legacy]

Class Method Summary collapse

Class Method Details

.access_grants_account_id_cache ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



11
12
13
14
15
16
 
# File 'lib/aws-sdk-s3/access_grants_credentials_provider.rb', line 11

def self.
  @access_grants_account_id_cache ||= LRUCache.new(
    max_entries: 100,
    expiration: 60 * 10
  )
end

.access_grants_credentials_cache ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6
7
8
 
# File 'lib/aws-sdk-s3/access_grants_credentials_provider.rb', line 6

def self.access_grants_credentials_cache
  @access_grants_credentials_cache ||= LRUCache.new(max_entries: 100)
end

.bucket_region_cache ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



8
9
10
 
# File 'lib/aws-sdk-s3/plugins/s3_signer.rb', line 8

def self.bucket_region_cache
  @bucket_region_cache ||= BucketRegionCache.new
end

.express_credentials_cache ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



6
7
8
 
# File 'lib/aws-sdk-s3/express_credentials_provider.rb', line 6

def self.express_credentials_cache
  @express_credentials_cache ||= LRUCache.new(max_entries: 100)
end