Skip to content

Commit 0abebb2

Browse files
authored
Fix list in generated doc (#1434)
1 parent 73fee20 commit 0abebb2

36 files changed

+0
-208
lines changed

src/DynamoDbClient.php

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -203,20 +203,14 @@ public function batchGetItem($input): BatchGetItemOutput
203203
* If one or more of the following is true, DynamoDB rejects the entire batch write operation:
204204
*
205205
* - One or more tables specified in the `BatchWriteItem` request does not exist.
206-
* -
207206
* - Primary key attributes specified on an item in the request do not match those in the corresponding table's primary
208207
* key schema.
209-
* -
210208
* - You try to perform multiple operations on the same item in the same `BatchWriteItem` request. For example, you
211209
* cannot put and delete the same item in the same `BatchWriteItem` request.
212-
* -
213210
* - Your request contains at least two items with identical hash and range keys (which essentially is two put
214211
* operations).
215-
* -
216212
* - There are more than 25 requests in the batch.
217-
* -
218213
* - Any individual item in a batch exceeds 400 KB.
219-
* -
220214
* - The total request size exceeds 16 MB.
221215
*
222216
* [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html
@@ -856,17 +850,14 @@ public function tableNotExists($input): TableNotExistsWaiter
856850
* item to be written, the name of the table to write it in, an optional condition expression that must be satisfied
857851
* for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's
858852
* attributes if the condition is not met.
859-
* -
860853
* - `Update`  —   Initiates an `UpdateItem` operation to update an existing item. This structure specifies the
861854
* primary key of the item to be updated, the name of the table where it resides, an optional condition expression
862855
* that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated,
863856
* and a field indicating whether to retrieve the item's attributes if the condition is not met.
864-
* -
865857
* - `Delete`  —   Initiates a `DeleteItem` operation to delete an existing item. This structure specifies the
866858
* primary key of the item to be deleted, the name of the table where it resides, an optional condition expression
867859
* that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's
868860
* attributes if the condition is not met.
869-
* -
870861
* - `ConditionCheck`  —   Applies a condition to an item that is not being modified by the transaction. This
871862
* structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition
872863
* expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the
@@ -875,16 +866,11 @@ public function tableNotExists($input): TableNotExistsWaiter
875866
* DynamoDB rejects the entire `TransactWriteItems` request if any of the following is true:
876867
*
877868
* - A condition in one of the condition expressions is not met.
878-
* -
879869
* - An ongoing operation is in the process of updating the same item.
880-
* -
881870
* - There is insufficient provisioned capacity for the transaction to be completed.
882-
* -
883871
* - An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar
884872
* validation error occurs because of changes made by the transaction.
885-
* -
886873
* - The aggregate size of the items in the transaction exceeds 4 MB.
887-
* -
888874
* - There is a user error, such as an invalid data format.
889875
*
890876
* @see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
@@ -985,9 +971,7 @@ public function updateItem($input): UpdateItemOutput
985971
* You can only perform one of the following operations at once:
986972
*
987973
* - Modify the provisioned throughput settings of the table.
988-
* -
989974
* - Remove a global secondary index from the table.
990-
* -
991975
* - Create a new global secondary index on the table. After the index begins backfilling, you can use `UpdateTable` to
992976
* perform other operations.
993977
*

src/Enum/ReturnConsumedCapacity.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
*
1212
* Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases,
1313
* specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
14-
* -
1514
* - `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
16-
* -
1715
* - `NONE` - No `ConsumedCapacity` details are included in the response.
1816
*/
1917
final class ReturnConsumedCapacity

src/Exception/TransactionCanceledException.php

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,20 @@
1313
* DynamoDB cancels a `TransactWriteItems` request under the following circumstances:
1414
*
1515
* - A condition in one of the condition expressions is not met.
16-
* -
1716
* - A table in the `TransactWriteItems` request is in a different account or region.
18-
* -
1917
* - More than one action in the `TransactWriteItems` operation targets the same item.
20-
* -
2118
* - There is insufficient provisioned capacity for the transaction to be completed.
22-
* -
2319
* - An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a
2420
* similar validation error occurs because of changes made by the transaction.
25-
* -
2621
* - There is a user error, such as an invalid data format.
2722
*
2823
* DynamoDB cancels a `TransactGetItems` request under the following circumstances:
2924
*
3025
* - There is an ongoing `TransactGetItems` operation that conflicts with a concurrent `PutItem`, `UpdateItem`,
3126
* `DeleteItem` or `TransactWriteItems` request. In this case the `TransactGetItems` operation fails with a
3227
* `TransactionCanceledException`.
33-
* -
3428
* - A table in the `TransactGetItems` request is in a different account or region.
35-
* -
3629
* - There is insufficient provisioned capacity for the transaction to be completed.
37-
* -
3830
* - There is a user error, such as an invalid data format.
3931
*
4032
* > If using Java, DynamoDB lists the cancellation reasons on the `CancellationReasons` property. This property is not
@@ -46,31 +38,26 @@
4638
* - No Errors:
4739
*
4840
* - Code: `None`
49-
* -
5041
* - Message: `null`
5142
*
5243
* - Conditional Check Failed:
5344
*
5445
* - Code: `ConditionalCheckFailed`
55-
* -
5646
* - Message: The conditional request failed.
5747
*
5848
* - Item Collection Size Limit Exceeded:
5949
*
6050
* - Code: `ItemCollectionSizeLimitExceeded`
61-
* -
6251
* - Message: Collection size exceeded.
6352
*
6453
* - Transaction Conflict:
6554
*
6655
* - Code: `TransactionConflict`
67-
* -
6856
* - Message: Transaction is ongoing for the item.
6957
*
7058
* - Provisioned Throughput Exceeded:
7159
*
7260
* - Code: `ProvisionedThroughputExceeded`
73-
* -
7461
* - Messages:
7562
*
7663
* - The level of configured provisioned throughput for the table was exceeded. Consider increasing your
@@ -89,7 +76,6 @@
8976
* - Throttling Error:
9077
*
9178
* - Code: `ThrottlingError`
92-
* -
9379
* - Messages:
9480
*
9581
* - Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or
@@ -110,27 +96,17 @@
11096
* - Validation Error:
11197
*
11298
* - Code: `ValidationError`
113-
* -
11499
* - Messages:
115100
*
116101
* - One or more parameter values were invalid.
117-
* -
118102
* - The update expression attempted to update the secondary index key beyond allowed size limits.
119-
* -
120103
* - The update expression attempted to update the secondary index key to unsupported type.
121-
* -
122104
* - An operand in the update expression has an incorrect data type.
123-
* -
124105
* - Item size to update has exceeded the maximum allowed size.
125-
* -
126106
* - Number overflow. Attempting to store a number with magnitude larger than supported range.
127-
* -
128107
* - Type mismatch for attribute to update.
129-
* -
130108
* - Nesting Levels have exceeded supported limits.
131-
* -
132109
* - The document path provided in the update expression is invalid for update.
133-
* -
134110
* - The provided expression refers to an attribute that does not exist in the item.
135111
*/
136112
final class TransactionCanceledException extends ClientException

src/Exception/TransactionInProgressException.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,22 @@
1515
*
1616
* - Set `clientExecutionTimeout` to a value that allows at least one retry to be processed after 5 seconds have elapsed
1717
* since the first attempt for the `TransactWriteItems` operation.
18-
* -
1918
* - Set `socketTimeout` to a value a little lower than the `requestTimeout` setting.
20-
* -
2119
* - `requestTimeout` should be set based on the time taken for the individual retries of a single HTTP request for your
2220
* use case, but setting it to 1 second or higher should work well to reduce chances of retries and
2321
* `TransactionInProgressException` errors.
24-
* -
2522
* - Use exponential backoff when retrying and tune backoff if needed.
2623
*
2724
* Assuming default retry policy [^1], example timeout settings based on the guidelines above are as follows:
2825
*
2926
* Example timeline:
3027
*
3128
* - 0-1000 first attempt
32-
* -
3329
* - 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
34-
* -
3530
* - 1500-2500 second attempt
36-
* -
3731
* - 2500-3500 second sleep/delay (500 * 2, exponential backoff)
38-
* -
3932
* - 3500-4500 third attempt
40-
* -
4133
* - 4500-6500 third sleep/delay (500 * 2^2)
42-
* -
4334
* - 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt
4435
* reached TC)
4536
*

src/Input/BatchGetItemInput.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,11 @@ final class BatchGetItemInput extends Input
2222
*
2323
* - `ConsistentRead` - If `true`, a strongly consistent read is used; if `false` (the default), an eventually
2424
* consistent read is used.
25-
* -
2625
* - `ExpressionAttributeNames` - One or more substitution tokens for attribute names in the `ProjectionExpression`
2726
* parameter. The following are some use cases for using `ExpressionAttributeNames`:
2827
*
2928
* - To access an attribute whose name conflicts with a DynamoDB reserved word.
30-
* -
3129
* - To create a placeholder for repeating occurrences of an attribute name in an expression.
32-
* -
3330
* - To prevent special characters in an attribute name from being misinterpreted in an expression.
3431
*
3532
* Use the **#** character in an expression to dereference an attribute name. For example, consider the following
@@ -52,11 +49,9 @@ final class BatchGetItemInput extends Input
5249
*
5350
* For more information about expression attribute names, see Accessing Item Attributes [^2] in the *Amazon DynamoDB
5451
* Developer Guide*.
55-
* -
5652
* - `Keys` - An array of primary key attribute values that define specific items in the table. For each primary key,
5753
* you must provide *all* of the key attributes. For example, with a simple primary key, you only need to provide the
5854
* partition key value. For a composite key, you must provide *both* the partition key value and the sort key value.
59-
* -
6055
* - `ProjectionExpression` - A string that identifies one or more attributes to retrieve from the table. These
6156
* attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be
6257
* separated by commas.
@@ -65,7 +60,6 @@ final class BatchGetItemInput extends Input
6560
* found, they do not appear in the result.
6661
*
6762
* For more information, see Accessing Item Attributes [^3] in the *Amazon DynamoDB Developer Guide*.
68-
* -
6963
* - `AttributesToGet` - This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see
7064
* AttributesToGet [^4] in the *Amazon DynamoDB Developer Guide*.
7165
*

src/Input/CreateTableInput.php

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,9 @@ final class CreateTableInput extends Input
5252
* Each `KeySchemaElement` in the array is composed of:
5353
*
5454
* - `AttributeName` - The name of this key attribute.
55-
* -
5655
* - `KeyType` - The role that the key attribute will assume:
5756
*
5857
* - `HASH` - partition key
59-
* -
6058
* - `RANGE` - sort key
6159
*
6260
*
@@ -91,21 +89,17 @@ final class CreateTableInput extends Input
9189
* Each local secondary index in the array includes the following:
9290
*
9391
* - `IndexName` - The name of the local secondary index. Must be unique only for this table.
94-
* -
9592
* - `KeySchema` - Specifies the key schema for the local secondary index. The key schema must begin with the same
9693
* partition key as the table.
97-
* -
9894
* - `Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in
9995
* addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute
10096
* specification is composed of:
10197
*
10298
* - `ProjectionType` - One of the following:
10399
*
104100
* - `KEYS_ONLY` - Only the index and primary keys are projected into the index.
105-
* -
106101
* - `INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes
107102
* is in `NonKeyAttributes`.
108-
* -
109103
* - `ALL` - All of the table attributes are projected into the index.
110104
*
111105
* - `NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index.
@@ -122,20 +116,16 @@ final class CreateTableInput extends Input
122116
* the array includes the following:.
123117
*
124118
* - `IndexName` - The name of the global secondary index. Must be unique only for this table.
125-
* -
126119
* - `KeySchema` - Specifies the key schema for the global secondary index.
127-
* -
128120
* - `Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in
129121
* addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute
130122
* specification is composed of:
131123
*
132124
* - `ProjectionType` - One of the following:
133125
*
134126
* - `KEYS_ONLY` - Only the index and primary keys are projected into the index.
135-
* -
136127
* - `INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes
137128
* is in `NonKeyAttributes`.
138-
* -
139129
* - `ALL` - All of the table attributes are projected into the index.
140130
*
141131
* - `NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index.
@@ -156,7 +146,6 @@ final class CreateTableInput extends Input
156146
*
157147
* - `PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to
158148
* Provisioned Mode [^1].
159-
* -
160149
* - `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the
161150
* billing mode to On-Demand Mode [^2].
162151
*
@@ -187,16 +176,12 @@ final class CreateTableInput extends Input
187176
* The settings for DynamoDB Streams on the table. These settings consist of:.
188177
*
189178
* - `StreamEnabled` - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
190-
* -
191179
* - `StreamViewType` - When an item in the table is modified, `StreamViewType` determines what information is written
192180
* to the table's stream. Valid values for `StreamViewType` are:
193181
*
194182
* - `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
195-
* -
196183
* - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
197-
* -
198184
* - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
199-
* -
200185
* - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
201186
*
202187
* @var StreamSpecification|null

src/Input/DeleteItemInput.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ final class DeleteItemInput extends Input
6666
*
6767
* - `NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is
6868
* the default for `ReturnValues`.)
69-
* -
7069
* - `ALL_OLD` - The content of the old item is returned.
7170
*
7271
* There is no additional cost associated with requesting a return value aside from the small network and processing
@@ -101,9 +100,7 @@ final class DeleteItemInput extends Input
101100
* - Functions: `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`
102101
*
103102
* These function names are case-sensitive.
104-
* -
105103
* - Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
106-
* -
107104
* - Logical operators: `AND | OR | NOT`
108105
*
109106
* For more information about condition expressions, see Condition Expressions [^1] in the *Amazon DynamoDB Developer
@@ -120,9 +117,7 @@ final class DeleteItemInput extends Input
120117
* `ExpressionAttributeNames`:.
121118
*
122119
* - To access an attribute whose name conflicts with a DynamoDB reserved word.
123-
* -
124120
* - To create a placeholder for repeating occurrences of an attribute name in an expression.
125-
* -
126121
* - To prevent special characters in an attribute name from being misinterpreted in an expression.
127122
*
128123
* Use the **#** character in an expression to dereference an attribute name. For example, consider the following

src/Input/GetItemInput.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,7 @@ final class GetItemInput extends Input
7979
* `ExpressionAttributeNames`:.
8080
*
8181
* - To access an attribute whose name conflicts with a DynamoDB reserved word.
82-
* -
8382
* - To create a placeholder for repeating occurrences of an attribute name in an expression.
84-
* -
8583
* - To prevent special characters in an attribute name from being misinterpreted in an expression.
8684
*
8785
* Use the **#** character in an expression to dereference an attribute name. For example, consider the following

src/Input/PutItemInput.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ final class PutItemInput extends Input
6969
*
7070
* - `NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is
7171
* the default for `ReturnValues`.)
72-
* -
7372
* - `ALL_OLD` - If `PutItem` overwrote an attribute name-value pair, then the content of the old item is returned.
7473
*
7574
* The values returned are strongly consistent.
@@ -116,9 +115,7 @@ final class PutItemInput extends Input
116115
* - Functions: `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`
117116
*
118117
* These function names are case-sensitive.
119-
* -
120118
* - Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
121-
* -
122119
* - Logical operators: `AND | OR | NOT`
123120
*
124121
* For more information on condition expressions, see Condition Expressions [^1] in the *Amazon DynamoDB Developer
@@ -135,9 +132,7 @@ final class PutItemInput extends Input
135132
* `ExpressionAttributeNames`:.
136133
*
137134
* - To access an attribute whose name conflicts with a DynamoDB reserved word.
138-
* -
139135
* - To create a placeholder for repeating occurrences of an attribute name in an expression.
140-
* -
141136
* - To prevent special characters in an attribute name from being misinterpreted in an expression.
142137
*
143138
* Use the **#** character in an expression to dereference an attribute name. For example, consider the following

0 commit comments

Comments
 (0)