Skip to content

Commit 9bc6245

Browse files
authored
Display link to ApiReference in client's methods (#749)
* Provide link to Api Reference in client * Regenerate files * Distinguish userguide and api reference documentations
1 parent 89db769 commit 9bc6245

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/DynamoDbClient.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ class DynamoDbClient extends AbstractApi
6565
* The `BatchGetItem` operation returns the attributes of one or more items from one or more tables. You identify
6666
* requested items by primary key.
6767
*
68+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchGetItem.html
6869
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#batchgetitem
6970
*
7071
* @param array{
@@ -86,6 +87,7 @@ public function batchGetItem($input): BatchGetItemOutput
8687
* `BatchWriteItem` can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual
8788
* items to be written can be as large as 400 KB.
8889
*
90+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html
8991
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#batchwriteitem
9092
*
9193
* @param array{
@@ -107,6 +109,7 @@ public function batchWriteItem($input): BatchWriteItemOutput
107109
* The `CreateTable` operation adds a new table to your account. In an AWS account, table names must be unique within
108110
* each Region. That is, you can have two tables with same name if you create the tables in different Regions.
109111
*
112+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html
110113
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#createtable
111114
*
112115
* @param array{
@@ -135,6 +138,7 @@ public function createTable($input): CreateTableOutput
135138
* Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item
136139
* if it exists, or if it has an expected attribute value.
137140
*
141+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html
138142
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deleteitem
139143
*
140144
* @param array{
@@ -166,6 +170,7 @@ public function deleteItem($input): DeleteItemOutput
166170
* specified table does not exist, DynamoDB returns a `ResourceNotFoundException`. If table is already in the `DELETING`
167171
* state, no error is returned.
168172
*
173+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html
169174
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deletetable
170175
*
171176
* @param array{
@@ -185,6 +190,7 @@ public function deleteTable($input): DeleteTableOutput
185190
* Returns information about the table, including the current status of the table, when it was created, the primary key
186191
* schema, and any indexes on the table.
187192
*
193+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html
188194
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#describetable
189195
*
190196
* @param array{
@@ -204,6 +210,7 @@ public function describeTable($input): DescribeTableOutput
204210
* The `GetItem` operation returns a set of attributes for the item with the given primary key. If there is no matching
205211
* item, `GetItem` does not return any data and there will be no `Item` element in the response.
206212
*
213+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html
207214
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#getitem
208215
*
209216
* @param array{
@@ -229,6 +236,7 @@ public function getItem($input): GetItemOutput
229236
* Returns an array of table names associated with the current account and endpoint. The output from `ListTables` is
230237
* paginated, with each page returning a maximum of 100 table names.
231238
*
239+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTables.html
232240
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#listtables
233241
*
234242
* @param array{
@@ -252,6 +260,7 @@ public function listTables($input = []): ListTablesOutput
252260
* existing item if it has certain attribute values. You can return the item's attribute values in the same operation,
253261
* using the `ReturnValues` parameter.
254262
*
263+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html
255264
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#putitem
256265
*
257266
* @param array{
@@ -280,6 +289,7 @@ public function putItem($input): PutItemOutput
280289
* The `Query` operation finds items based on primary key values. You can query any table or secondary index that has a
281290
* composite primary key (a partition key and a sort key).
282291
*
292+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html
283293
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#query
284294
*
285295
* @param array{
@@ -315,6 +325,7 @@ public function query($input): QueryOutput
315325
* The `Scan` operation returns one or more items and item attributes by accessing every item in a table or a secondary
316326
* index. To have DynamoDB return fewer items, you can provide a `FilterExpression` operation.
317327
*
328+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html
318329
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#scan
319330
*
320331
* @param array{
@@ -387,6 +398,7 @@ public function tableNotExists($input): TableNotExistsWaiter
387398
* attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected
388399
* attribute values).
389400
*
401+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html
390402
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#updateitem
391403
*
392404
* @param array{
@@ -417,6 +429,7 @@ public function updateItem($input): UpdateItemOutput
417429
* Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given
418430
* table.
419431
*
432+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html
420433
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#updatetable
421434
*
422435
* @param array{
@@ -445,6 +458,7 @@ public function updateTable($input): UpdateTableOutput
445458
* fully process. Any additional `UpdateTimeToLive` calls for the same table during this one hour duration result in a
446459
* `ValidationException`.
447460
*
461+
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTimeToLive.html
448462
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#updatetimetolive
449463
*
450464
* @param array{

0 commit comments

Comments
 (0)