diff --git a/manifest.json b/manifest.json index 7b2e24033..be1993a6e 100644 --- a/manifest.json +++ b/manifest.json @@ -1,6 +1,6 @@ { "variables": { - "${LATEST}": "3.262.1" + "${LATEST}": "3.263.1" }, "endpoints": "https://raw.githubusercontent.com/aws/aws-sdk-php/${LATEST}/src/data/endpoints.json", "services": { diff --git a/src/Service/S3/CHANGELOG.md b/src/Service/S3/CHANGELOG.md index 9da7b6ff2..2f5b91335 100644 --- a/src/Service/S3/CHANGELOG.md +++ b/src/Service/S3/CHANGELOG.md @@ -5,6 +5,7 @@ ### Added - AWS api-change: Added `ap-southeast-4` region. +- AWS enhancement: Documentation updates. ## 1.13.0 diff --git a/src/Service/S3/src/Enum/ServerSideEncryption.php b/src/Service/S3/src/Enum/ServerSideEncryption.php index 592fc8f82..b2dc56129 100644 --- a/src/Service/S3/src/Enum/ServerSideEncryption.php +++ b/src/Service/S3/src/Enum/ServerSideEncryption.php @@ -3,9 +3,7 @@ namespace AsyncAws\S3\Enum; /** - * If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS - * key in your initiate multipart upload request, the response includes this header. It confirms the encryption - * algorithm that Amazon S3 used to encrypt the object. + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ final class ServerSideEncryption { diff --git a/src/Service/S3/src/Input/CopyObjectRequest.php b/src/Service/S3/src/Input/CopyObjectRequest.php index 819bbd165..fa7031aad 100644 --- a/src/Service/S3/src/Input/CopyObjectRequest.php +++ b/src/Service/S3/src/Input/CopyObjectRequest.php @@ -187,7 +187,7 @@ final class CopyObjectRequest extends Input private $taggingDirective; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). * * @var ServerSideEncryption::*|null */ @@ -207,7 +207,9 @@ final class CopyObjectRequest extends Input /** * 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. + * to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each + * object and is not copied when using the `x-amz-metadata-directive` header. Instead, you may opt to provide this + * header in combination with the directive. * * @var string|null */ diff --git a/src/Service/S3/src/Input/CreateMultipartUploadRequest.php b/src/Service/S3/src/Input/CreateMultipartUploadRequest.php index cbd0bd2ff..27e44d86a 100644 --- a/src/Service/S3/src/Input/CreateMultipartUploadRequest.php +++ b/src/Service/S3/src/Input/CreateMultipartUploadRequest.php @@ -120,7 +120,7 @@ final class CreateMultipartUploadRequest extends Input private $metadata; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). * * @var ServerSideEncryption::*|null */ @@ -171,10 +171,10 @@ final class CreateMultipartUploadRequest extends Input private $sseCustomerKeyMd5; /** - * Specifies the ID of the symmetric customer managed key to use for object encryption. All GET and PUT requests for an - * object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about - * configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see - * Specifying the Signature Version in Request Authentication in the *Amazon S3 User Guide*. + * Specifies the ID of the symmetric encryption customer managed key to use for object encryption. All GET and PUT + * requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For + * information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services + * CLI, see Specifying the Signature Version in Request Authentication in the *Amazon S3 User Guide*. * * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version * diff --git a/src/Service/S3/src/Input/GetObjectRequest.php b/src/Service/S3/src/Input/GetObjectRequest.php index 1f8c0c7de..d8d875f45 100644 --- a/src/Service/S3/src/Input/GetObjectRequest.php +++ b/src/Service/S3/src/Input/GetObjectRequest.php @@ -63,9 +63,9 @@ final class GetObjectRequest extends Input /** * Downloads the specified range bytes of an object. For more information about the HTTP Range header, see - * https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. + * https://www.rfc-editor.org/rfc/rfc9110.html#name-range. * - * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 + * @see https://www.rfc-editor.org/rfc/rfc9110.html#name-range * * @var string|null */ diff --git a/src/Service/S3/src/Input/HeadObjectRequest.php b/src/Service/S3/src/Input/HeadObjectRequest.php index cce26be54..7c8b898b8 100644 --- a/src/Service/S3/src/Input/HeadObjectRequest.php +++ b/src/Service/S3/src/Input/HeadObjectRequest.php @@ -62,7 +62,8 @@ final class HeadObjectRequest extends Input private $key; /** - * Because `HeadObject` returns only the metadata for an object, this parameter has no effect. + * HeadObject returns only the metadata for an object. If the Range is satisfiable, only the `ContentLength` is affected + * in the response. If the Range is not satisfiable, S3 returns a `416 - Requested Range Not Satisfiable` error. * * @var string|null */ diff --git a/src/Service/S3/src/Input/PutObjectRequest.php b/src/Service/S3/src/Input/PutObjectRequest.php index 3e666fbeb..ad04e370e 100644 --- a/src/Service/S3/src/Input/PutObjectRequest.php +++ b/src/Service/S3/src/Input/PutObjectRequest.php @@ -53,9 +53,9 @@ final class PutObjectRequest extends Input /** * Specifies presentational information for the object. For more information, see - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1. + * https://www.rfc-editor.org/rfc/rfc6266#section-4. * - * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 + * @see https://www.rfc-editor.org/rfc/rfc6266#section-4 * * @var string|null */ @@ -64,9 +64,9 @@ final class PutObjectRequest extends Input /** * 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. For more information, see - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11. + * https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding. * - * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 + * @see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding * * @var string|null */ @@ -81,9 +81,9 @@ final class PutObjectRequest extends Input /** * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For - * more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13. + * more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length. * - * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13 + * @see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length * * @var string|null */ @@ -103,9 +103,9 @@ final class PutObjectRequest extends Input /** * 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. + * https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type. * - * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 + * @see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type * * @var string|null */ @@ -169,9 +169,9 @@ final class PutObjectRequest extends Input /** * 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. + * https://www.rfc-editor.org/rfc/rfc7234#section-5.3. * - * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 + * @see https://www.rfc-editor.org/rfc/rfc7234#section-5.3 * * @var \DateTimeImmutable|null */ @@ -222,7 +222,7 @@ final class PutObjectRequest extends Input private $metadata; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). * * @var ServerSideEncryption::*|null */ @@ -276,9 +276,9 @@ final class PutObjectRequest extends Input private $sseCustomerKeyMd5; /** - * If `x-amz-server-side-encryption` is present and has the value of `aws:kms`, this header specifies the ID of the - * Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used - * for the object. If you specify `x-amz-server-side-encryption:aws:kms`, but do not provide` + * If `x-amz-server-side-encryption` has a valid value of `aws:kms`, this header specifies the ID of the Amazon Web + * Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was 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 Amazon Web Services managed key to protect the data. * If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID. * @@ -288,7 +288,9 @@ final class PutObjectRequest extends Input /** * Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a - * base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. + * base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object + * metadata and automatically gets passed on to Amazon Web Services KMS for future `GetObject` or `CopyObject` + * operations on this object. * * @var string|null */ diff --git a/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php b/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php index 427c6b963..2a18a2bee 100644 --- a/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php +++ b/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php @@ -79,9 +79,7 @@ class CompleteMultipartUploadOutput extends Result private $checksumSha256; /** - * If you specified server-side encryption either with an Amazon S3-managed encryption key or an Amazon Web Services KMS - * key in your initiate multipart upload request, the response includes this header. It confirms the encryption - * algorithm that Amazon S3 used to encrypt the object. + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -92,7 +90,7 @@ class CompleteMultipartUploadOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key that was used for the object. + * encryption customer managed key that was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/Result/CopyObjectOutput.php b/src/Service/S3/src/Result/CopyObjectOutput.php index 4cc6e75e5..ffea3a85f 100644 --- a/src/Service/S3/src/Result/CopyObjectOutput.php +++ b/src/Service/S3/src/Result/CopyObjectOutput.php @@ -31,7 +31,7 @@ class CopyObjectOutput extends Result private $versionId; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -49,7 +49,7 @@ class CopyObjectOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key that was used for the object. + * encryption customer managed key that was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/Result/CreateMultipartUploadOutput.php b/src/Service/S3/src/Result/CreateMultipartUploadOutput.php index c3f703589..e65dc1f5a 100644 --- a/src/Service/S3/src/Result/CreateMultipartUploadOutput.php +++ b/src/Service/S3/src/Result/CreateMultipartUploadOutput.php @@ -43,7 +43,7 @@ class CreateMultipartUploadOutput extends Result private $uploadId; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -61,7 +61,7 @@ class CreateMultipartUploadOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key that was used for the object. + * encryption customer managed key that was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/Result/GetObjectOutput.php b/src/Service/S3/src/Result/GetObjectOutput.php index 17d54da85..c202d9ac9 100644 --- a/src/Service/S3/src/Result/GetObjectOutput.php +++ b/src/Service/S3/src/Result/GetObjectOutput.php @@ -149,7 +149,7 @@ class GetObjectOutput extends Result private $websiteRedirectLocation; /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -172,7 +172,7 @@ class GetObjectOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key that was used for the object. + * encryption customer managed key that was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/Result/HeadObjectOutput.php b/src/Service/S3/src/Result/HeadObjectOutput.php index 5c2fe7ae8..96c5aa2d6 100644 --- a/src/Service/S3/src/Result/HeadObjectOutput.php +++ b/src/Service/S3/src/Result/HeadObjectOutput.php @@ -147,9 +147,7 @@ class HeadObjectOutput extends Result private $websiteRedirectLocation; /** - * If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon - * S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm - * used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -172,7 +170,7 @@ class HeadObjectOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key that was used for the object. + * encryption customer managed key that was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/Result/ListObjectsV2Output.php b/src/Service/S3/src/Result/ListObjectsV2Output.php index 01e37dd99..02937dc43 100644 --- a/src/Service/S3/src/Result/ListObjectsV2Output.php +++ b/src/Service/S3/src/Result/ListObjectsV2Output.php @@ -64,8 +64,8 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate private $encodingType; /** - * KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys - * field. Say you ask for 50 keys, your result will include less than equals 50 keys. + * KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the + * `MaxKeys` field. Say you ask for 50 keys, your result will include 50 keys or fewer. */ private $keyCount; diff --git a/src/Service/S3/src/Result/PutObjectOutput.php b/src/Service/S3/src/Result/PutObjectOutput.php index 2a2a4921f..8815b29db 100644 --- a/src/Service/S3/src/Result/PutObjectOutput.php +++ b/src/Service/S3/src/Result/PutObjectOutput.php @@ -60,9 +60,7 @@ class PutObjectOutput extends Result private $checksumSha256; /** - * If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption - * key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used - * to encrypt the object. + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -84,15 +82,17 @@ class PutObjectOutput extends Result private $sseCustomerKeyMd5; /** - * If `x-amz-server-side-encryption` is present and has the value of `aws:kms`, this header specifies the ID of the - * Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for + * If `x-amz-server-side-encryption` is has a valid value of `aws:kms`, this header specifies the ID of the Amazon Web + * Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for * the object. */ private $sseKmsKeyId; /** * If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this - * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. + * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is + * stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future `GetObject` or + * `CopyObject` operations on this object. */ private $sseKmsEncryptionContext; diff --git a/src/Service/S3/src/Result/UploadPartOutput.php b/src/Service/S3/src/Result/UploadPartOutput.php index a55c45d7c..a6e5d0628 100644 --- a/src/Service/S3/src/Result/UploadPartOutput.php +++ b/src/Service/S3/src/Result/UploadPartOutput.php @@ -10,7 +10,7 @@ class UploadPartOutput extends Result { /** - * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). + * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, `aws:kms`). */ private $serverSideEncryption; @@ -69,7 +69,7 @@ class UploadPartOutput extends Result /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed key was used for the object. + * encryption customer managed key was used for the object. */ private $sseKmsKeyId; diff --git a/src/Service/S3/src/S3Client.php b/src/Service/S3/src/S3Client.php index bbdd9a055..2889e8e87 100644 --- a/src/Service/S3/src/S3Client.php +++ b/src/Service/S3/src/S3Client.php @@ -475,9 +475,11 @@ public function getBucketCors($input): GetBucketCorsOutput } /** - * Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default - * encryption configuration, GetBucketEncryption returns `ServerSideEncryptionConfigurationNotFoundError`. + * Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default + * encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about + * the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the *Amazon S3 User Guide*. * + * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html * @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#getbucketencryption * diff --git a/src/Service/S3/src/ValueObject/Owner.php b/src/Service/S3/src/ValueObject/Owner.php index 5f2f9ce6c..2118c2fbd 100644 --- a/src/Service/S3/src/ValueObject/Owner.php +++ b/src/Service/S3/src/ValueObject/Owner.php @@ -8,7 +8,8 @@ final class Owner { /** - * Container for the display name of the owner. + * Container for the display name of the owner. This value is only supported in the following Amazon Web Services + * Regions:. */ private $displayName;