aws-sdk-s3 1.55.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec083041e07beb3541c4ef88d81d0a1c396367c
-  data.tar.gz: 2655a030cbb345f276a22d5f3b274189ab95e244
+  metadata.gz: 97510d745f7ed2fd04221e9213bc80749aa72800
+  data.tar.gz: 8f486dbd89e0b58c112b18cc877f79a19d7299da
 SHA512:
-  metadata.gz: 2aaa6b610445aae94b7ab30018304185d4684868f08bc6b36aafc3800a0080b806c2d152ad847730a7039b2759ab5b127138c3e170ea7aea08b652fbba0724ca
-  data.tar.gz: af1cf33968b298bcc6003b40a2e08482aad3a7bde5ae292321fb5495b110bad03663a4b7818ad812fc66b20f653351bd5b7e53fc4369024a910a173986e63a80
+  metadata.gz: 02dc98b651db4c246856e368a86e06f8fa2791d2ba636ef0805038206749b6603cd00e0c5ed163fc6cd20d3b5cd118fa9f26d449a964a8f4dd2298a3318b285b
+  data.tar.gz: fcbfaa5ee8c9c68b47f3f5b1166603b0e4a82b84c1efef8865818449b1da44c4f0f22efb96dbd60f9decbf3d3dfc91d0e3bf3fc54cfe866604de77472060fef4

data/lib/aws-sdk-s3.rb

@@ -63,6 +63,6 @@ require_relative 'aws-sdk-s3/event_streams'
 # @service
 module Aws::S3
 
-  GEM_VERSION = '1.55.0'
+  GEM_VERSION = '1.56.0'
 
 end

data/lib/aws-sdk-s3/bucket.rb

@@ -229,6 +229,7 @@ module Aws::S3
     # @option options [String] :acl
     #   The canned ACL to apply to the bucket.
     # @option options [Types::CreateBucketConfiguration] :create_bucket_configuration
+    #   The configuration information for the bucket.
     # @option options [String] :grant_full_control
     #   Allows grantee the read, write, read ACP, and write ACP permissions on
     #   the bucket.
@@ -242,8 +243,8 @@ module Aws::S3
     # @option options [String] :grant_write_acp
     #   Allows grantee to write the ACL for the applicable bucket.
     # @option options [Boolean] :object_lock_enabled_for_bucket
-    #   Specifies whether you want Amazon S3 object lock to be enabled for the
-    #   new bucket.
+    #   Specifies whether you want S3 Object Lock to be enabled for the new
+    #   bucket.
     # @return [Types::CreateBucketOutput]
     def create(options = {})
       options = options.merge(bucket: @name)
@@ -280,9 +281,12 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [required, Types::Delete] :delete
+    #   Container for the request.
     # @option options [String] :mfa
     #   The concatenation of the authentication device's serial number, a
     #   space, and the value that is displayed on your authentication device.
+    #   Required to permanently delete a versioned object if versioning is
+    #   configured with MFA Delete enabled.
     # @option options [String] :request_payer
     #   Confirms that the requester knows that she or he will be charged for
     #   the request. Bucket owners need not specify this parameter in their
@@ -291,7 +295,7 @@ module Aws::S3
     #   http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
     # @option options [Boolean] :bypass_governance_retention
     #   Specifies whether you want to delete this object even if it has a
-    #   Governance-type object lock in place. You must have sufficient
+    #   Governance-type Object Lock in place. You must have sufficient
     #   permissions to perform this operation.
     # @return [Types::DeleteObjectsOutput]
     def delete_objects(options = {})
@@ -337,30 +341,77 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [String] :acl
-    #   The canned ACL to apply to the object.
+    #   The canned ACL to apply to the object. For more information, see
+    #   [Canned ACL][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
     # @option options [String, IO] :body
     #   Object data.
     # @option options [String] :cache_control
-    #   Specifies caching behavior along the request/reply chain.
+    #   Can be used to specify caching behavior along the request/reply chain.
+    #   For more information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
     # @option options [String] :content_disposition
-    #   Specifies presentational information for the object.
+    #   Specifies presentational information for the object. For more
+    #   information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
     # @option options [String] :content_encoding
     #   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.
+    #   referenced by the Content-Type header field. For more information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
     # @option options [String] :content_language
     #   The language the content is in.
     # @option options [Integer] :content_length
     #   Size of the body in bytes. This parameter is useful when the size of
-    #   the body cannot be determined automatically.
+    #   the body cannot be determined automatically. For more information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
     # @option options [String] :content_md5
-    #   The base64-encoded 128-bit MD5 digest of the part data. This parameter
-    #   is auto-populated when using the command from the CLI. This parameted
-    #   is required if object lock parameters are specified.
+    #   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][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
     # @option options [String] :content_type
-    #   A standard MIME type describing the format of the object data.
+    #   A standard MIME type describing the format of the contents. For more
+    #   information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
     # @option options [Time,DateTime,Date,Integer,String] :expires
-    #   The date and time at which the object is no longer cacheable.
+    #   The date and time at which the object is no longer cacheable. For more
+    #   information, see
+    #   [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].
+    #
+    #
+    #
+    #   [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
     # @option options [String] :grant_full_control
     #   Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
     #   object.
@@ -378,11 +429,32 @@ module Aws::S3
     #   The Server-side encryption algorithm used when storing this object in
     #   S3 (e.g., AES256, aws:kms).
     # @option options [String] :storage_class
-    #   The type of storage to use for the object. Defaults to 'STANDARD'.
+    #   If you don't specify, Standard is the default storage class. Amazon
+    #   S3 supports other storage classes.
     # @option options [String] :website_redirect_location
     #   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.
+    #   Amazon S3 stores the value of this header in the object metadata. For
+    #   information about object metadata, see .
+    #
+    #   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: http://www.example.com/`
+    #
+    #   For more information about website hosting in Amazon S3, see [Hosting
+    #   Websites on Amazon S3][1] and [How to Configure Website Page
+    #   Redirects][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
+    #   [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
     # @option options [String] :sse_customer_algorithm
     #   Specifies the algorithm to use to when encrypting the object (e.g.,
     #   AES256).
@@ -397,11 +469,16 @@ module Aws::S3
     #   RFC 1321. Amazon S3 uses this header for a message integrity check to
     #   ensure the encryption key was transmitted without error.
     # @option options [String] :ssekms_key_id
-    #   Specifies the AWS KMS key ID to use for object encryption. All GET and
-    #   PUT requests for an object protected by AWS KMS will fail if not made
-    #   via SSL or using SigV4. Documentation on configuring any of the
-    #   officially supported AWS SDKs and CLI can be found at
-    #   http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
+    #   If the x-amz-server-side-encryption is present and has the value of
+    #   aws:kms, this header specifies the ID of the AWS Key Management
+    #   Service (AWS KMS) customer master key (CMK) that was used for the
+    #   object.
+    #
+    #   If the value of x-amz-server-side-encryption is aws:kms, this header
+    #   specifies the ID of the AWS KMS CMK that will be used for the object.
+    #   If you specify x-amz-server-side-encryption:aws:kms, but do not
+    #   provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses
+    #   the AWS managed CMK in AWS to protect the data.
     # @option options [String] :ssekms_encryption_context
     #   Specifies the AWS KMS Encryption Context to use for object encryption.
     #   The value of this header is a base64-encoded UTF-8 string holding JSON
@@ -416,11 +493,16 @@ module Aws::S3
     #   The tag-set for the object. The tag-set must be encoded as URL Query
     #   parameters. (For example, "Key1=Value1")
     # @option options [String] :object_lock_mode
-    #   The object lock mode that you want to apply to this object.
+    #   The Object Lock mode that you want to apply to this object.
     # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
-    #   The date and time when you want this object's object lock to expire.
+    #   The date and time when you want this object's Object Lock to expire.
     # @option options [String] :object_lock_legal_hold_status
-    #   The Legal Hold status that you want to apply to the specified object.
+    #   Specifies whether a legal hold will be applied to this object. For
+    #   more information about S3 Object Lock, see [Object Lock][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
     # @return [Object]
     def put_object(options = {})
       options = options.merge(bucket: @name)
@@ -486,6 +568,13 @@ module Aws::S3
     # @param [Hash] options ({})
     # @option options [String] :delimiter
     #   Character you use to group keys.
+    #
+    #   All keys that contain the same string between the prefix, if
+    #   specified, and the first occurrence of the delimiter after the prefix
+    #   are grouped under a single result element, `CommonPrefixes`. If you
+    #   don't specify the prefix parameter, then the substring starts at the
+    #   beginning of the key. The keys that are grouped under `CommonPrefixes`
+    #   result element are not returned elsewhere in the response.
     # @option options [String] :encoding_type
     #   Requests Amazon S3 to encode the object keys in the response and
     #   specifies the encoding method to use. An object key may contain any
@@ -496,13 +585,27 @@ module Aws::S3
     # @option options [String] :key_marker
     #   Together with upload-id-marker, this parameter specifies the multipart
     #   upload after which listing should begin.
+    #
+    #   If `upload-id-marker` is not specified, only the keys
+    #   lexicographically greater than the specified `key-marker` will be
+    #   included in the list.
+    #
+    #   If `upload-id-marker` is specified, any multipart uploads for a key
+    #   equal to the `key-marker` might also be included, provided those
+    #   multipart uploads have upload IDs lexicographically greater than the
+    #   specified `upload-id-marker`.
     # @option options [String] :prefix
     #   Lists in-progress uploads only for those keys that begin with the
-    #   specified prefix.
+    #   specified prefix. You can use prefixes to separate a bucket into
+    #   different grouping of keys. (You can think of using prefix to make
+    #   groups in the same way you'd use a folder in a file system.)
     # @option options [String] :upload_id_marker
     #   Together with key-marker, specifies the multipart upload after which
     #   listing should begin. If key-marker is not specified, the
-    #   upload-id-marker parameter is ignored.
+    #   upload-id-marker parameter is ignored. Otherwise, any multipart
+    #   uploads for a key equal to the key-marker might be included in the
+    #   list only if they have an upload ID lexicographically greater than the
+    #   specified upload-id-marker.
     # @return [MultipartUpload::Collection]
     def multipart_uploads(options = {})
       batches = Enumerator.new do |y|
@@ -554,7 +657,12 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [String] :delimiter
-    #   A delimiter is a character you use to group keys.
+    #   A delimiter is a character that you specify to group keys. All keys
+    #   that contain the same string between the `prefix` and the first
+    #   occurrence of the delimiter are grouped under a single result element
+    #   in CommonPrefixes. These groups are counted as one result against the
+    #   max-keys limitation. These keys are not returned elsewhere in the
+    #   response.
     # @option options [String] :encoding_type
     #   Requests Amazon S3 to encode the object keys in the response and
     #   specifies the encoding method to use. An object key may contain any
@@ -565,7 +673,12 @@ module Aws::S3
     # @option options [String] :key_marker
     #   Specifies the key to start with when listing objects in a bucket.
     # @option options [String] :prefix
-    #   Limits the response to keys that begin with the specified prefix.
+    #   Use this parameter to select only those keys that begin with the
+    #   specified prefix. You can use prefixes to separate a bucket into
+    #   different groupings of keys. (You can think of using prefix to make
+    #   groups in the same way you'd use a folder in a file system.) You can
+    #   use prefix with delimiter to roll up numerous objects into a single
+    #   result under CommonPrefixes.
     # @option options [String] :version_id_marker
     #   Specifies the object version you want to start listing from.
     # @return [ObjectVersion::Collection]
@@ -614,7 +727,7 @@ module Aws::S3
     # @option options [String] :start_after
     #   StartAfter is where you want Amazon S3 to start listing from. Amazon
     #   S3 starts listing after this specified key. StartAfter can be any key
-    #   in the bucket
+    #   in the bucket.
     # @option options [String] :request_payer
     #   Confirms that the requester knows that she or he will be charged for
     #   the list objects request in V2 style. Bucket owners need not specify

data/lib/aws-sdk-s3/bucket_acl.rb

@@ -30,7 +30,7 @@ module Aws::S3
       @bucket_name
     end
 
-    
+    # Container for the bucket owner's display name and ID.
     # @return [Types::Owner]
     def owner
       data[:owner]
@@ -210,6 +210,13 @@ module Aws::S3
     #   Contains the elements that set the ACL permissions for an object per
     #   grantee.
     # @option options [String] :content_md5
+    #   The base64-encoded 128-bit MD5 digest of the data. This header must be
+    #   used as a message integrity check to verify that the request body was
+    #   not corrupted in transit. For more information, go to [RFC 1864.][1]
+    #
+    #
+    #
+    #   [1]: http://www.ietf.org/rfc/rfc1864.txt
     # @option options [String] :grant_full_control
     #   Allows grantee the read, write, read ACP, and write ACP permissions on
     #   the bucket.

data/lib/aws-sdk-s3/bucket_cors.rb

@@ -30,7 +30,8 @@ module Aws::S3
       @bucket_name
     end
 
-    
+    # A set of origins and methods (cross-origin access that you want to
+    # allow). You can add up to 100 rules to the configuration.
     # @return [Array<Types::CORSRule>]
     def cors_rules
       data[:cors_rules]
@@ -197,7 +198,22 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [required, Types::CORSConfiguration] :cors_configuration
+    #   Describes the cross-origin access configuration for objects in an
+    #   Amazon S3 bucket. For more information, see [Enabling Cross-Origin
+    #   Resource Sharing][1] in the Amazon Simple Storage Service Developer
+    #   Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev//cors.html
     # @option options [String] :content_md5
+    #   The base64-encoded 128-bit MD5 digest of the data. This header must be
+    #   used as a message integrity check to verify that the request body was
+    #   not corrupted in transit. For more information, go to [RFC 1864.][1]
+    #
+    #
+    #
+    #   [1]: http://www.ietf.org/rfc/rfc1864.txt
     # @return [EmptyStructure]
     def put(options = {})
       options = options.merge(bucket: @bucket_name)

data/lib/aws-sdk-s3/bucket_lifecycle.rb

@@ -30,7 +30,7 @@ module Aws::S3
       @bucket_name
     end
 
-    
+    # Container for a lifecycle rule.
     # @return [Array<Types::Rule>]
     def rules
       data[:rules]

data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb

@@ -30,7 +30,7 @@ module Aws::S3
       @bucket_name
     end
 
-    
+    # Container for a lifecycle rule.
     # @return [Array<Types::LifecycleRule>]
     def rules
       data[:rules]
@@ -234,6 +234,7 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [Types::BucketLifecycleConfiguration] :lifecycle_configuration
+    #   Container for lifecycle rules. You can add as many as 1,000 rules.
     # @return [EmptyStructure]
     def put(options = {})
       options = options.merge(bucket: @bucket_name)

data/lib/aws-sdk-s3/bucket_logging.rb

@@ -30,7 +30,14 @@ module Aws::S3
       @bucket_name
     end
 
-    
+    # Describes where logs are stored and the prefix that Amazon S3 assigns
+    # to all log object keys for a bucket. For more information, see [PUT
+    # Bucket logging][1] in the *Amazon Simple Storage Service API
+    # Reference*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html
     # @return [Types::LoggingEnabled]
     def logging_enabled
       data[:logging_enabled]
@@ -193,7 +200,9 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [required, Types::BucketLoggingStatus] :bucket_logging_status
+    #   Container for logging status information.
     # @option options [String] :content_md5
+    #   The MD5 hash of the `PutBucketLogging` request body.
     # @return [EmptyStructure]
     def put(options = {})
       options = options.merge(bucket: @bucket_name)

data/lib/aws-sdk-s3/bucket_notification.rb

@@ -242,6 +242,9 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [required, Types::NotificationConfiguration] :notification_configuration
+    #   A container for specifying the notification configuration of the
+    #   bucket. If this element is empty, notifications are turned off for the
+    #   bucket.
     # @return [EmptyStructure]
     def put(options = {})
       options = options.merge(bucket: @bucket_name)

data/lib/aws-sdk-s3/bucket_policy.rb

@@ -188,6 +188,7 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [String] :content_md5
+    #   The MD5 hash of the request body.
     # @option options [Boolean] :confirm_remove_self_bucket_access
     #   Set this parameter to true to confirm that you want to remove your
     #   permissions to change this bucket policy in the future.

data/lib/aws-sdk-s3/bucket_request_payment.rb

@@ -178,7 +178,16 @@ module Aws::S3
     #   })
     # @param [Hash] options ({})
     # @option options [String] :content_md5
+    #   >The base64-encoded 128-bit MD5 digest of the data. You must use
+    #   this header as a message integrity check to verify that the request
+    #   body was not corrupted in transit. For more information, see [RFC
+    #   1864][1].
+    #
+    #
+    #
+    #   [1]: http://www.ietf.org/rfc/rfc1864.txt
     # @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
+    #   Container for Payer.
     # @return [EmptyStructure]
     def put(options = {})
       options = options.merge(bucket: @bucket_name)