Skip to content

Commit e7e8dc2

Browse files
author
awstools
committed
docs(client-dynamodb): Doc only update for API descriptions.
1 parent 21029cc commit e7e8dc2

File tree

3 files changed

+113
-103
lines changed

3 files changed

+113
-103
lines changed

clients/client-dynamodb/src/commands/BatchGetItemCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
7575
* nonexistent items consume the minimum read capacity units according to the type of read.
7676
* For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Working with Tables</a> in the <i>Amazon DynamoDB Developer
7777
* Guide</i>.</p>
78+
* <note>
79+
* <p>
80+
* <code>BatchGetItem</code> will result in a <code>ValidationException</code> if the
81+
* same key is specified multiple times.</p>
82+
* </note>
7883
* @example
7984
* Use a bare-bones client and the command you need to make an API call.
8085
* ```javascript

clients/client-dynamodb/src/models/models_0.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,9 @@ export interface OnDemandThroughput {
520520
}
521521

522522
/**
523-
* <p>Represents the provisioned throughput settings for a specified table or index. The
524-
* settings can be modified using the <code>UpdateTable</code> operation.</p>
523+
* <p>Represents the provisioned throughput settings for the specified global secondary
524+
* index. You must use <code>ProvisionedThroughput</code> or
525+
* <code>OnDemandThroughput</code> based on your table’s capacity mode.</p>
525526
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
526527
* Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer
527528
* Guide</i>.</p>
@@ -1881,7 +1882,9 @@ export interface CreateGlobalSecondaryIndexAction {
18811882
/**
18821883
* <p>The maximum number of read and write units for the global secondary index being
18831884
* created. If you use this parameter, you must specify <code>MaxReadRequestUnits</code>,
1884-
* <code>MaxWriteRequestUnits</code>, or both.</p>
1885+
* <code>MaxWriteRequestUnits</code>, or both. You must use either
1886+
* <code>OnDemand Throughput</code> or <code>ProvisionedThroughput</code> based on your table's
1887+
* capacity mode.</p>
18851888
* @public
18861889
*/
18871890
OnDemandThroughput?: OnDemandThroughput | undefined;
@@ -2113,8 +2116,9 @@ export const TableStatus = {
21132116
export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
21142117

21152118
/**
2116-
* <p>Represents the warm throughput value (in read units per second and write units per
2117-
* second) of the base table.</p>
2119+
* <p>Represents the warm throughput value (in read units per second and write units per second)
2120+
* of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and specifies
2121+
* the minimum provisioned capacity maintained for immediate data access.</p>
21182122
* @public
21192123
*/
21202124
export interface TableWarmThroughputDescription {
@@ -2131,7 +2135,7 @@ export interface TableWarmThroughputDescription {
21312135
WriteUnitsPerSecond?: number | undefined;
21322136

21332137
/**
2134-
* <p>Represents warm throughput value of the base table..</p>
2138+
* <p>Represents warm throughput value of the base table.</p>
21352139
* @public
21362140
*/
21372141
Status?: TableStatus | undefined;
@@ -4800,8 +4804,9 @@ export interface TableCreationParameters {
48004804
BillingMode?: BillingMode | undefined;
48014805

48024806
/**
4803-
* <p>Represents the provisioned throughput settings for a specified table or index. The
4804-
* settings can be modified using the <code>UpdateTable</code> operation.</p>
4807+
* <p>Represents the provisioned throughput settings for the specified global secondary
4808+
* index. You must use <code>ProvisionedThroughput</code> or
4809+
* <code>OnDemandThroughput</code> based on your table’s capacity mode.</p>
48054810
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
48064811
* Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer
48074812
* Guide</i>.</p>

0 commit comments

Comments
 (0)