Skip to content

Commit

Permalink
Update generated code (#1716)
Browse files Browse the repository at this point in the history
update generated code
  • Loading branch information
async-aws-bot authored May 25, 2024
1 parent 3198ec9 commit 4784d4a
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 38 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## NOT RELEASED

### Changed

- AWS enhancement: Documentation updates.

## 3.2.0

### Added
Expand Down
14 changes: 5 additions & 9 deletions src/DynamoDbClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
*
Expand Down Expand Up @@ -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
*
Expand Down Expand Up @@ -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:
*
Expand All @@ -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
*
Expand Down
8 changes: 4 additions & 4 deletions src/Input/CreateTableInput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
12 changes: 5 additions & 7 deletions src/Input/UpdateTableInput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Result/DeleteItemOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Result/GetItemOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Result/PutItemOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Result/QueryOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Result/ScanOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Result/UpdateItemOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions src/ValueObject/ConsumedCapacity.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down

0 comments on commit 4784d4a

Please sign in to comment.