docs(client-dynamodb): Updating descriptions for several APIs.

aws · Oct 18, 2023 · 2320e50 · 2320e50
1 parent 12f6be4
commit 2320e50
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 58 deletions.
diff --git a/clients/client-dynamodb/src/commands/ExecuteTransactionCommand.ts b/clients/client-dynamodb/src/commands/ExecuteTransactionCommand.ts
@@ -245,6 +245,13 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
  *             <li>
  *                <p>There is a user error, such as an invalid data format.</p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                     There is an ongoing <code>TransactWriteItems</code> operation that conflicts with a concurrent
+ *                     <code>TransactWriteItems</code> request. In this case the <code>TransactWriteItems</code> operation
+ *                     fails with a <code>TransactionCanceledException</code>.
+ *                 </p>
+ *             </li>
  *          </ul>
  *          <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
  *             following circumstances:</p>

diff --git a/clients/client-dynamodb/src/commands/TransactGetItemsCommand.ts b/clients/client-dynamodb/src/commands/TransactGetItemsCommand.ts
@@ -266,6 +266,13 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
  *             <li>
  *                <p>There is a user error, such as an invalid data format.</p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                     There is an ongoing <code>TransactWriteItems</code> operation that conflicts with a concurrent
+ *                     <code>TransactWriteItems</code> request. In this case the <code>TransactWriteItems</code> operation
+ *                     fails with a <code>TransactionCanceledException</code>.
+ *                 </p>
+ *             </li>
  *          </ul>
  *          <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
  *             following circumstances:</p>

diff --git a/clients/client-dynamodb/src/commands/TransactWriteItemsCommand.ts b/clients/client-dynamodb/src/commands/TransactWriteItemsCommand.ts
@@ -370,6 +370,13 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
  *             <li>
  *                <p>There is a user error, such as an invalid data format.</p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                     There is an ongoing <code>TransactWriteItems</code> operation that conflicts with a concurrent
+ *                     <code>TransactWriteItems</code> request. In this case the <code>TransactWriteItems</code> operation
+ *                     fails with a <code>TransactionCanceledException</code>.
+ *                 </p>
+ *             </li>
  *          </ul>
  *          <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
  *             following circumstances:</p>

diff --git a/clients/client-dynamodb/src/endpoint/ruleset.ts b/clients/client-dynamodb/src/endpoint/ruleset.ts
@@ -6,29 +6,31 @@ import { RuleSetObject } from "@smithy/types";
    or see "smithy.rules#endpointRuleSet"
    in codegen/sdk-codegen/aws-models/dynamodb.json */
 
-const u="required",
-v="fn",
-w="argv",
-x="ref";
-const a="isSet",
-b="tree",
-c="error",
-d="endpoint",
-e="PartitionResult",
-f="getAttr",
-g="stringEquals",
-h={[u]:false,"type":"String"},
-i={[u]:true,"default":false,"type":"Boolean"},
-j={[x]:"Endpoint"},
-k={[v]:"booleanEquals",[w]:[{[x]:"UseFIPS"},true]},
-l={[v]:"booleanEquals",[w]:[{[x]:"UseDualStack"},true]},
-m={},
-n={[x]:"Region"},
-o={[v]:"booleanEquals",[w]:[true,{[v]:f,[w]:[{[x]:e},"supportsFIPS"]}]},
-p={[x]:e},
-q={[v]:"booleanEquals",[w]:[true,{[v]:f,[w]:[p,"supportsDualStack"]}]},
-r=[k],
-s=[l],
-t=[n];
-const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[v]:a,[w]:[j]}],type:b,rules:[{conditions:r,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:s,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:j,properties:m,headers:m},type:d}]},{conditions:[{[v]:a,[w]:t}],type:b,rules:[{conditions:[{[v]:"aws.partition",[w]:t,assign:e}],type:b,rules:[{conditions:[k,l],type:b,rules:[{conditions:[o,q],type:b,rules:[{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:r,type:b,rules:[{conditions:[o],type:b,rules:[{conditions:[{[v]:g,[w]:["aws-us-gov",{[v]:f,[w]:[p,"name"]}]}],endpoint:{url:"https://dynamodb.{Region}.amazonaws.com",properties:m,headers:m},type:d},{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:s,type:b,rules:[{conditions:[q],type:b,rules:[{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{conditions:[{[v]:g,[w]:[n,"local"]}],endpoint:{url:"http://localhost:8000",properties:{authSchemes:[{name:"sigv4",signingName:"dynamodb",signingRegion:"us-east-1"}]},headers:m},type:d},{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
+const w="required",
+x="fn",
+y="argv",
+z="ref";
+const a=true,
+b="isSet",
+c="booleanEquals",
+d="error",
+e="endpoint",
+f="tree",
+g="PartitionResult",
+h="getAttr",
+i="stringEquals",
+j={[w]:false,"type":"String"},
+k={[w]:true,"default":false,"type":"Boolean"},
+l={[z]:"Endpoint"},
+m={[x]:c,[y]:[{[z]:"UseFIPS"},true]},
+n={[x]:c,[y]:[{[z]:"UseDualStack"},true]},
+o={},
+p={[z]:"Region"},
+q={[x]:h,[y]:[{[z]:g},"supportsFIPS"]},
+r={[z]:g},
+s={[x]:c,[y]:[true,{[x]:h,[y]:[r,"supportsDualStack"]}]},
+t=[m],
+u=[n],
+v=[p];
+const _data={version:"1.0",parameters:{Region:j,UseDualStack:k,UseFIPS:k,Endpoint:j},rules:[{conditions:[{[x]:b,[y]:[l]}],rules:[{conditions:t,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:u,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:l,properties:o,headers:o},type:e}],type:f},{conditions:[{[x]:b,[y]:v}],rules:[{conditions:[{[x]:"aws.partition",[y]:v,assign:g}],rules:[{conditions:[m,n],rules:[{conditions:[{[x]:c,[y]:[a,q]},s],rules:[{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:o,headers:o},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:t,rules:[{conditions:[{[x]:c,[y]:[q,a]}],rules:[{conditions:[{[x]:i,[y]:[{[x]:h,[y]:[r,"name"]},"aws-us-gov"]}],endpoint:{url:"https://dynamodb.{Region}.amazonaws.com",properties:o,headers:o},type:e},{endpoint:{url:"https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}",properties:o,headers:o},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:u,rules:[{conditions:[s],rules:[{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:o,headers:o},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{conditions:[{[x]:i,[y]:[p,"local"]}],endpoint:{url:"http://localhost:8000",properties:{authSchemes:[{name:"sigv4",signingName:"dynamodb",signingRegion:"us-east-1"}]},headers:o},type:e},{endpoint:{url:"https://dynamodb.{Region}.{PartitionResult#dnsSuffix}",properties:o,headers:o},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
 export const ruleSet: RuleSetObject = _data;
diff --git a/clients/client-dynamodb/src/models/models_0.ts b/clients/client-dynamodb/src/models/models_0.ts
@@ -3805,7 +3805,7 @@ export interface IncrementalExportSpecification {
 
   /**
    * @public
-   * <p>Choice of whether to output the previous item image prior to the start time of the incremental export. Valid values are <code>NEW_AND_OLD_IMAGES</code> and <code>NEW_IMAGES</code>.</p>
+   * <p>The view type that was chosen for the export. Valid values are <code>NEW_AND_OLD_IMAGES</code> and <code>NEW_IMAGES</code>. The default value is <code>NEW_AND_OLD_IMAGES</code>.</p>
    */
   ExportViewType?: ExportViewType;
 }
@@ -3965,7 +3965,7 @@ export interface ExportDescription {
 
   /**
    * @public
-   * <p>Choice of whether to execute as a full export or incremental export. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>. If <code>INCREMENTAL_EXPORT</code> is provided, the <code>IncrementalExportSpecification</code> must also be used.</p>
+   * <p>The type of export that was performed. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>.</p>
    */
   ExportType?: ExportType;
 
@@ -5152,7 +5152,7 @@ export interface ExportTableToPointInTimeInput {
 
   /**
    * @public
-   * <p>Choice of whether to execute as a full export or incremental export. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>. If <code>INCREMENTAL_EXPORT</code> is provided, the <code>IncrementalExportSpecification</code> must also be used.</p>
+   * <p>Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.</p>
    */
   ExportType?: ExportType;
 
@@ -5477,7 +5477,7 @@ export interface ExportSummary {
 
   /**
    * @public
-   * <p>Choice of whether to execute as a full export or incremental export. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>. If <code>INCREMENTAL_EXPORT</code> is provided, the <code>IncrementalExportSpecification</code> must also be used.</p>
+   * <p>The type of export that was performed. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>.</p>
    */
   ExportType?: ExportType;
 }
@@ -8223,6 +8223,13 @@ export interface TransactGetItemsOutput {
  *             <li>
  *                <p>There is a user error, such as an invalid data format.</p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                     There is an ongoing <code>TransactWriteItems</code> operation that conflicts with a concurrent
+ *                     <code>TransactWriteItems</code> request. In this case the <code>TransactWriteItems</code> operation
+ *                     fails with a <code>TransactionCanceledException</code>.
+ *                 </p>
+ *             </li>
  *          </ul>
  *          <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
  *             following circumstances:</p>
@@ -9794,7 +9801,7 @@ export interface ScanInput {
    *             <p>A <code>FilterExpression</code> is applied after the items have already been read;
    *                 the process of filtering does not consume any additional read capacity units.</p>
    *          </note>
-   *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer
+   *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression">Filter Expressions</a> in the <i>Amazon DynamoDB Developer
    *                 Guide</i>.</p>
    */
   FilterExpression?: string;