From 1eab0619e1f8151c1bc3ba5a0d8081f6c671150d Mon Sep 17 00:00:00 2001 From: AsyncAws <61784373+async-aws-bot@users.noreply.github.com> Date: Wed, 2 Oct 2024 23:57:18 -0700 Subject: [PATCH] Update generated code (#1774) update generated code --- src/Input/CompleteMultipartUploadRequest.php | 6 ++-- src/Input/DeleteObjectsRequest.php | 8 ++--- src/Input/PutObjectRequest.php | 14 ++++----- src/Input/UploadPartRequest.php | 6 ++-- src/Result/CompleteMultipartUploadOutput.php | 4 +-- src/Result/GetObjectOutput.php | 4 +-- src/Result/HeadObjectOutput.php | 4 +-- src/Result/PutObjectOutput.php | 4 +-- src/Result/UploadPartOutput.php | 4 +-- src/S3Client.php | 31 +++++++++++--------- src/ValueObject/CompletedPart.php | 4 +-- src/ValueObject/CopyObjectResult.php | 4 +-- src/ValueObject/CopyPartResult.php | 4 +-- src/ValueObject/Part.php | 6 ++-- 14 files changed, 53 insertions(+), 50 deletions(-) diff --git a/src/Input/CompleteMultipartUploadRequest.php b/src/Input/CompleteMultipartUploadRequest.php index 9750c26..d28ff2c 100644 --- a/src/Input/CompleteMultipartUploadRequest.php +++ b/src/Input/CompleteMultipartUploadRequest.php @@ -72,8 +72,8 @@ final class CompleteMultipartUploadRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, - * see Checking object integrity [^1] in the *Amazon S3 User Guide*. + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more + * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html * @@ -83,7 +83,7 @@ final class CompleteMultipartUploadRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html diff --git a/src/Input/DeleteObjectsRequest.php b/src/Input/DeleteObjectsRequest.php index fdd1434..a08f8c3 100644 --- a/src/Input/DeleteObjectsRequest.php +++ b/src/Input/DeleteObjectsRequest.php @@ -106,10 +106,10 @@ final class DeleteObjectsRequest extends Input * For the `x-amz-checksum-*algorithm*` header, replace `*algorithm*` with the supported algorithm from the following * list: * - * - CRC32 - * - CRC32C - * - SHA1 - * - SHA256 + * - `CRC32` + * - `CRC32C` + * - `SHA1` + * - `SHA256` * * For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * diff --git a/src/Input/PutObjectRequest.php b/src/Input/PutObjectRequest.php index 0e2bfd8..d0f6acf 100644 --- a/src/Input/PutObjectRequest.php +++ b/src/Input/PutObjectRequest.php @@ -172,10 +172,10 @@ final class PutObjectRequest extends Input * For the `x-amz-checksum-*algorithm*` header, replace `*algorithm*` with the supported algorithm from the following * list: * - * - CRC32 - * - CRC32C - * - SHA1 - * - SHA256 + * - `CRC32` + * - `CRC32C` + * - `SHA1` + * - `SHA256` * * For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * @@ -194,8 +194,8 @@ final class PutObjectRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, - * see Checking object integrity [^1] in the *Amazon S3 User Guide*. + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more + * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html * @@ -205,7 +205,7 @@ final class PutObjectRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html diff --git a/src/Input/UploadPartRequest.php b/src/Input/UploadPartRequest.php index 9e64261..d3edb76 100644 --- a/src/Input/UploadPartRequest.php +++ b/src/Input/UploadPartRequest.php @@ -88,8 +88,8 @@ final class UploadPartRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, - * see Checking object integrity [^1] in the *Amazon S3 User Guide*. + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more + * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html * @@ -99,7 +99,7 @@ final class UploadPartRequest extends Input /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html diff --git a/src/Result/CompleteMultipartUploadOutput.php b/src/Result/CompleteMultipartUploadOutput.php index 0888619..38e748b 100644 --- a/src/Result/CompleteMultipartUploadOutput.php +++ b/src/Result/CompleteMultipartUploadOutput.php @@ -57,7 +57,7 @@ class CompleteMultipartUploadOutput extends Result private $etag; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -70,7 +70,7 @@ class CompleteMultipartUploadOutput extends Result private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/Result/GetObjectOutput.php b/src/Result/GetObjectOutput.php index 7294504..a0b9159 100644 --- a/src/Result/GetObjectOutput.php +++ b/src/Result/GetObjectOutput.php @@ -92,7 +92,7 @@ class GetObjectOutput extends Result private $etag; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html @@ -102,7 +102,7 @@ class GetObjectOutput extends Result private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html diff --git a/src/Result/HeadObjectOutput.php b/src/Result/HeadObjectOutput.php index e7c9f3c..8ffcee1 100644 --- a/src/Result/HeadObjectOutput.php +++ b/src/Result/HeadObjectOutput.php @@ -91,7 +91,7 @@ class HeadObjectOutput extends Result private $contentLength; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -104,7 +104,7 @@ class HeadObjectOutput extends Result private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/Result/PutObjectOutput.php b/src/Result/PutObjectOutput.php index a53f3a8..63afc43 100644 --- a/src/Result/PutObjectOutput.php +++ b/src/Result/PutObjectOutput.php @@ -36,7 +36,7 @@ class PutObjectOutput extends Result private $etag; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -49,7 +49,7 @@ class PutObjectOutput extends Result private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/Result/UploadPartOutput.php b/src/Result/UploadPartOutput.php index fd3fa47..d9c81cc 100644 --- a/src/Result/UploadPartOutput.php +++ b/src/Result/UploadPartOutput.php @@ -24,7 +24,7 @@ class UploadPartOutput extends Result private $etag; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -37,7 +37,7 @@ class UploadPartOutput extends Result private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/S3Client.php b/src/S3Client.php index 61cc235..2b48d43 100644 --- a/src/S3Client.php +++ b/src/S3Client.php @@ -1601,7 +1601,9 @@ public function getObjectTagging($input): GetObjectTaggingOutput * * - **General purpose bucket permissions** - To use `HEAD`, you must have the `s3:GetObject` permission. You need the * relevant read object (or version) permission for this operation. For more information, see Actions, resources, - * and condition keys for Amazon S3 [^2] in the *Amazon S3 User Guide*. + * and condition keys for Amazon S3 [^2] in the *Amazon S3 User Guide*. For more information about the permissions + * to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations [^3] in the + * *Amazon S3 User Guide*. * * If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the * `s3:ListBucket` permission. @@ -1612,13 +1614,13 @@ public function getObjectTagging($input): GetObjectTaggingOutput * error. * * - **Directory bucket permissions** - To grant access to this API operation on a directory bucket, we recommend that - * you use the `CreateSession` [^3] API operation for session-based authorization. Specifically, you grant the + * you use the `CreateSession` [^4] API operation for session-based authorization. Specifically, you grant the * `s3express:CreateSession` permission to the directory bucket in a bucket policy or an IAM identity-based policy. * Then, you make the `CreateSession` API call on the bucket to obtain a session token. With the session token in * your request header, you can make API requests to this operation. After the session token expires, you make * another `CreateSession` API call to generate a new session token for use. Amazon Web Services CLI or SDKs create * session and refresh the session token automatically to avoid service interruptions when a session expires. For - * more information about authorization, see `CreateSession` [^4]. + * more information about authorization, see `CreateSession` [^5]. * * If you enable `x-amz-checksum-mode` in the request and the object is encrypted with Amazon Web Services Key * Management Service (Amazon Web Services KMS), you must also have the `kms:GenerateDataKey` and `kms:Decrypt` @@ -1643,12 +1645,12 @@ public function getObjectTagging($input): GetObjectTaggingOutput * - `x-amz-server-side-encryption-customer-key` * - `x-amz-server-side-encryption-customer-key-MD5` * - * For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) [^5] in the + * For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) [^6] in the * *Amazon S3 User Guide*. * * > **Directory bucket ** - For directory buckets, there are only two supported options for server-side encryption: * > SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption - * > [^6] in the *Amazon S3 User Guide*. + * > [^7] in the *Amazon S3 User Guide*. * * - `Versioning`: * @@ -1670,23 +1672,24 @@ public function getObjectTagging($input): GetObjectTaggingOutput * > For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints * > support virtual-hosted-style requests in the format * > `https://*bucket_name*.s3express-*az_id*.*region*.amazonaws.com/*key-name*`. Path-style requests are not - * > supported. For more information, see Regional and Zonal endpoints [^7] in the *Amazon S3 User Guide*. + * > supported. For more information, see Regional and Zonal endpoints [^8] in the *Amazon S3 User Guide*. * * * The following actions are related to `HeadObject`: * - * - GetObject [^8] - * - GetObjectAttributes [^9] + * - GetObject [^9] + * - GetObjectAttributes [^10] * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html * [^2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html - * [^3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + * [^3]: /AmazonS3/latest/userguide/using-with-s3-policy-actions.html * [^4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html - * [^5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html - * [^6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html - * [^7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html - * [^8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html - * [^9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html + * [^5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + * [^6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html + * [^7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html + * [^8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + * [^9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + * [^10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html * * @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html * @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html diff --git a/src/ValueObject/CompletedPart.php b/src/ValueObject/CompletedPart.php index fa3ef51..74b37d2 100644 --- a/src/ValueObject/CompletedPart.php +++ b/src/ValueObject/CompletedPart.php @@ -15,7 +15,7 @@ final class CompletedPart private $etag; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -28,7 +28,7 @@ final class CompletedPart private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/ValueObject/CopyObjectResult.php b/src/ValueObject/CopyObjectResult.php index 5e38a97..e53e9ef 100644 --- a/src/ValueObject/CopyObjectResult.php +++ b/src/ValueObject/CopyObjectResult.php @@ -22,7 +22,7 @@ final class CopyObjectResult private $lastModified; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html @@ -32,7 +32,7 @@ final class CopyObjectResult private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. For more information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html diff --git a/src/ValueObject/CopyPartResult.php b/src/ValueObject/CopyPartResult.php index 45b2ab7..0cab8bc 100644 --- a/src/ValueObject/CopyPartResult.php +++ b/src/ValueObject/CopyPartResult.php @@ -22,7 +22,7 @@ final class CopyPartResult private $lastModified; /** - * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity @@ -35,7 +35,7 @@ final class CopyPartResult private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity diff --git a/src/ValueObject/Part.php b/src/ValueObject/Part.php index 319d4cc..98504b3 100644 --- a/src/ValueObject/Part.php +++ b/src/ValueObject/Part.php @@ -37,8 +37,8 @@ final class Part /** * This header can be used as a data integrity check to verify that the data received is the same data that was - * originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, - * see Checking object integrity [^1] in the *Amazon S3 User Guide*. + * originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more + * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html * @@ -47,7 +47,7 @@ final class Part private $checksumCrc32; /** - * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the + * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the * object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a * direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual * part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity