From 4784d4a366c68672e025561ed6bf9425c6e92b4c Mon Sep 17 00:00:00 2001 From: AsyncAws <61784373+async-aws-bot@users.noreply.github.com> Date: Sat, 25 May 2024 00:05:09 -0700 Subject: [PATCH] Update generated code (#1716) update generated code --- CHANGELOG.md | 4 ++++ src/DynamoDbClient.php | 14 +++++--------- src/Input/CreateTableInput.php | 8 ++++---- src/Input/UpdateTableInput.php | 12 +++++------- src/Result/DeleteItemOutput.php | 4 ++-- src/Result/GetItemOutput.php | 6 +++--- src/Result/PutItemOutput.php | 6 +++--- src/Result/QueryOutput.php | 6 +++--- src/Result/ScanOutput.php | 6 +++--- src/Result/UpdateItemOutput.php | 4 ++-- src/ValueObject/ConsumedCapacity.php | 4 ++-- 11 files changed, 36 insertions(+), 38 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b0704c3..b64ac88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## NOT RELEASED +### Changed + +- AWS enhancement: Documentation updates. + ## 3.2.0 ### Added diff --git a/src/DynamoDbClient.php b/src/DynamoDbClient.php index 2f19e86..73c2211 100644 --- a/src/DynamoDbClient.php +++ b/src/DynamoDbClient.php @@ -214,6 +214,8 @@ public function batchGetItem($input): BatchGetItemOutput * - There are more than 25 requests in the batch. * - Any individual item in a batch exceeds 400 KB. * - The total request size exceeds 16 MB. + * - Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and + * for a sort key, the limit is 1024 bytes. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations @@ -362,7 +364,7 @@ public function deleteItem($input): DeleteItemOutput * specified table does not exist, DynamoDB returns a `ResourceNotFoundException`. If table is already in the `DELETING` * state, no error is returned. * - * ! This operation only applies to Version 2019.11.21 (Current) [^1] of global tables. + * ! For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). * * > DynamoDB might continue to accept data read and write operations, such as `GetItem` and `PutItem`, on a table in * > the `DELETING` state until the table deletion is complete. @@ -374,8 +376,6 @@ public function deleteItem($input): DeleteItemOutput * * Use the `DescribeTable` action to check the status of the table. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html - * * @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deletetable * @@ -427,15 +427,13 @@ public function describeEndpoints($input = []): DescribeEndpointsResponse * Returns information about the table, including the current status of the table, when it was created, the primary key * schema, and any indexes on the table. * - * ! This operation only applies to Version 2019.11.21 (Current) [^1] of global tables. + * ! For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). * * > If you issue a `DescribeTable` request immediately after a `CreateTable` request, DynamoDB might return a * > `ResourceNotFoundException`. This is because `DescribeTable` uses an eventually consistent query, and the metadata * > for your table might not be available at that moment. Wait for a few seconds, and then try the `DescribeTable` * > request again. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html - * * @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#describetable * @@ -969,7 +967,7 @@ public function updateItem($input): UpdateItemOutput * Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given * table. * - * ! This operation only applies to Version 2019.11.21 (Current) [^1] of global tables. + * ! For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). * * You can only perform one of the following operations at once: * @@ -982,8 +980,6 @@ public function updateItem($input): UpdateItemOutput * `UPDATING`. While it's `UPDATING`, you can't issue another `UpdateTable` request. When the table returns to the * `ACTIVE` state, the `UpdateTable` operation is complete. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html - * * @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#updatetable * diff --git a/src/Input/CreateTableInput.php b/src/Input/CreateTableInput.php index 6b3a086..9c4f53a 100644 --- a/src/Input/CreateTableInput.php +++ b/src/Input/CreateTableInput.php @@ -146,12 +146,12 @@ final class CreateTableInput extends Input * later. * * - `PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to - * Provisioned Mode [^1]. + * Provisioned capacity mode [^1]. * - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the - * billing mode to On-Demand Mode [^2]. + * billing mode to On-demand capacity mode [^2]. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual - * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html + * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html * * @var BillingMode::*|null */ diff --git a/src/Input/UpdateTableInput.php b/src/Input/UpdateTableInput.php index 1a2a29a..359f8fe 100644 --- a/src/Input/UpdateTableInput.php +++ b/src/Input/UpdateTableInput.php @@ -46,12 +46,12 @@ final class UpdateTableInput extends Input * indexes over the past 30 minutes. * * - `PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to - * Provisioned Mode [^1]. + * Provisioned capacity mode [^1]. * - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the - * billing mode to On-Demand Mode [^2]. + * billing mode to On-demand capacity mode [^2]. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual - * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html + * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html * * @var BillingMode::*|null */ @@ -102,9 +102,7 @@ final class UpdateTableInput extends Input /** * A list of replica update actions (create, delete, or update) for the table. * - * > This property only applies to Version 2019.11.21 (Current) [^1] of global tables. - * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html + * > For global tables, this property only applies to global tables using Version 2019.11.21 (Current version). * * @var ReplicationGroupUpdate[]|null */ diff --git a/src/Result/DeleteItemOutput.php b/src/Result/DeleteItemOutput.php index be97a19..a5a093b 100644 --- a/src/Result/DeleteItemOutput.php +++ b/src/Result/DeleteItemOutput.php @@ -26,9 +26,9 @@ class DeleteItemOutput extends Result * The capacity units consumed by the `DeleteItem` operation. The data returned includes the total provisioned * throughput consumed, along with statistics for the table and any indexes involved in the operation. * `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, - * see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer Guide*. + * see Provisioned capacity mode [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html * * @var ConsumedCapacity|null */ diff --git a/src/Result/GetItemOutput.php b/src/Result/GetItemOutput.php index 2fee035..3c3da75 100644 --- a/src/Result/GetItemOutput.php +++ b/src/Result/GetItemOutput.php @@ -23,10 +23,10 @@ class GetItemOutput extends Result /** * The capacity units consumed by the `GetItem` operation. The data returned includes the total provisioned throughput * consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only - * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Provisioned Throughput - * [^1] in the *Amazon DynamoDB Developer Guide*. + * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Capacity unit consumption + * for read operations [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption * * @var ConsumedCapacity|null */ diff --git a/src/Result/PutItemOutput.php b/src/Result/PutItemOutput.php index d2b5c8a..1b4bbea 100644 --- a/src/Result/PutItemOutput.php +++ b/src/Result/PutItemOutput.php @@ -25,10 +25,10 @@ class PutItemOutput extends Result /** * The capacity units consumed by the `PutItem` operation. The data returned includes the total provisioned throughput * consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only - * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Provisioned Throughput - * [^1] in the *Amazon DynamoDB Developer Guide*. + * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Capacity unity + * consumption for write operations [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption * * @var ConsumedCapacity|null */ diff --git a/src/Result/QueryOutput.php b/src/Result/QueryOutput.php index a1c3455..85e0c0c 100644 --- a/src/Result/QueryOutput.php +++ b/src/Result/QueryOutput.php @@ -68,10 +68,10 @@ class QueryOutput extends Result implements \IteratorAggregate /** * The capacity units consumed by the `Query` operation. The data returned includes the total provisioned throughput * consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only - * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Provisioned Throughput - * [^1] in the *Amazon DynamoDB Developer Guide*. + * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Capacity unit consumption + * for read operations [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption * * @var ConsumedCapacity|null */ diff --git a/src/Result/ScanOutput.php b/src/Result/ScanOutput.php index 63f200b..3436247 100644 --- a/src/Result/ScanOutput.php +++ b/src/Result/ScanOutput.php @@ -68,10 +68,10 @@ class ScanOutput extends Result implements \IteratorAggregate /** * The capacity units consumed by the `Scan` operation. The data returned includes the total provisioned throughput * consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only - * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Provisioned Throughput - * [^1] in the *Amazon DynamoDB Developer Guide*. + * returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see Capacity unit consumption + * for read operations [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption * * @var ConsumedCapacity|null */ diff --git a/src/Result/UpdateItemOutput.php b/src/Result/UpdateItemOutput.php index ab47280..724c82e 100644 --- a/src/Result/UpdateItemOutput.php +++ b/src/Result/UpdateItemOutput.php @@ -29,9 +29,9 @@ class UpdateItemOutput extends Result * The capacity units consumed by the `UpdateItem` operation. The data returned includes the total provisioned * throughput consumed, along with statistics for the table and any indexes involved in the operation. * `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, - * see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer Guide*. + * see Capacity unity consumption for write operations [^1] in the *Amazon DynamoDB Developer Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption * * @var ConsumedCapacity|null */ diff --git a/src/ValueObject/ConsumedCapacity.php b/src/ValueObject/ConsumedCapacity.php index 9b5a7ae..e0f0e1c 100644 --- a/src/ValueObject/ConsumedCapacity.php +++ b/src/ValueObject/ConsumedCapacity.php @@ -5,10 +5,10 @@ /** * The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, * along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if - * the request asked for it. For more information, see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer + * the request asked for it. For more information, see Provisioned capacity mode [^1] in the *Amazon DynamoDB Developer * Guide*. * - * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html */ final class ConsumedCapacity {