@aws-sdk/client-dynamodb 3.289.0 → 3.290.0

package/dist-types/commands/RestoreTableFromBackupCommand.d.ts

@@ -53,6 +53,39 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
  * @see {@link RestoreTableFromBackupCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
  *
+ * @throws {@link BackupInUseException} (client fault)
+ *  <p>There is another ongoing conflicting backup control plane operation on the table.
+ *             The backup is either being created, deleted or restored to a table.</p>
+ *
+ * @throws {@link BackupNotFoundException} (client fault)
+ *  <p>Backup not found for the given BackupARN. </p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
+ *          <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
+ *             include <code>CreateTable</code>, <code>UpdateTable</code>,
+ *                 <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
+ *                 <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
+ *          <p>When you are creating a table with one or more secondary
+ *             indexes, you can have up to 250 such requests running at a time. However, if the table or
+ *             index specifications are complex, then DynamoDB might temporarily reduce the number
+ *             of concurrent operations.</p>
+ *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
+ *          <p>There is a soft account quota of 2,500 tables.</p>
+ *
+ * @throws {@link TableAlreadyExistsException} (client fault)
+ *  <p>A target table with the specified name already exists. </p>
+ *
+ * @throws {@link TableInUseException} (client fault)
+ *  <p>A target table with the specified name is either being created or deleted.
+ *         </p>
+ *
+ *
  */
 export declare class RestoreTableFromBackupCommand extends $Command<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: RestoreTableFromBackupCommandInput;

package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts

@@ -78,6 +78,43 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
  * @see {@link RestoreTableToPointInTimeCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
  *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link InvalidRestoreTimeException} (client fault)
+ *  <p>An invalid restore time was specified. RestoreDateTime must be between
+ *             EarliestRestorableDateTime and LatestRestorableDateTime.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
+ *          <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
+ *             include <code>CreateTable</code>, <code>UpdateTable</code>,
+ *                 <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
+ *                 <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
+ *          <p>When you are creating a table with one or more secondary
+ *             indexes, you can have up to 250 such requests running at a time. However, if the table or
+ *             index specifications are complex, then DynamoDB might temporarily reduce the number
+ *             of concurrent operations.</p>
+ *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
+ *          <p>There is a soft account quota of 2,500 tables.</p>
+ *
+ * @throws {@link PointInTimeRecoveryUnavailableException} (client fault)
+ *  <p>Point in time recovery has not yet been enabled for this source table.</p>
+ *
+ * @throws {@link TableAlreadyExistsException} (client fault)
+ *  <p>A target table with the specified name already exists. </p>
+ *
+ * @throws {@link TableInUseException} (client fault)
+ *  <p>A target table with the specified name is either being created or deleted.
+ *         </p>
+ *
+ * @throws {@link TableNotFoundException} (client fault)
+ *  <p>A source table with the name <code>TableName</code> does not currently exist within
+ *             the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.</p>
+ *
+ *
  */
 export declare class RestoreTableToPointInTimeCommand extends $Command<RestoreTableToPointInTimeCommandInput, RestoreTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: RestoreTableToPointInTimeCommandInput;

package/dist-types/commands/ScanCommand.d.ts

@@ -54,6 +54,27 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
  * @see {@link ScanCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
  *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
+ *             automatically retry requests that receive this exception. Your request is eventually
+ *             successful, unless your retry queue is too large to finish. Reduce the frequency of
+ *             requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
+ *
+ * @throws {@link RequestLimitExceeded} (client fault)
+ *  <p>Throughput exceeds the current throughput quota for your account. Please contact
+ *                 <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
+ *             quota increase.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent table or index. The resource might not
+ *             be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
+ *
+ *
  * @example To scan a table
  * ```javascript
  * // This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.

package/dist-types/commands/TagResourceCommand.d.ts

@@ -34,6 +34,34 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
  *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
+ *          <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
+ *             include <code>CreateTable</code>, <code>UpdateTable</code>,
+ *                 <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
+ *                 <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
+ *          <p>When you are creating a table with one or more secondary
+ *             indexes, you can have up to 250 such requests running at a time. However, if the table or
+ *             index specifications are complex, then DynamoDB might temporarily reduce the number
+ *             of concurrent operations.</p>
+ *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
+ *          <p>There is a soft account quota of 2,500 tables.</p>
+ *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The operation conflicts with the resource's availability. For example, you
+ *             attempted to recreate an existing table, or tried to delete a table currently in the
+ *                 <code>CREATING</code> state.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent table or index. The resource might not
+ *             be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
+ *
+ *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: TagResourceCommandInput;

package/dist-types/commands/TransactGetItemsCommand.d.ts

@@ -55,6 +55,260 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
  * @see {@link TransactGetItemsCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
  *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
+ *             automatically retry requests that receive this exception. Your request is eventually
+ *             successful, unless your retry queue is too large to finish. Reduce the frequency of
+ *             requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
+ *
+ * @throws {@link RequestLimitExceeded} (client fault)
+ *  <p>Throughput exceeds the current throughput quota for your account. Please contact
+ *                 <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
+ *             quota increase.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent table or index. The resource might not
+ *             be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link TransactionCanceledException} (client fault)
+ *  <p>The entire transaction request was canceled.</p>
+ *          <p>DynamoDB cancels a <code>TransactWriteItems</code> request under the following
+ *             circumstances:</p>
+ *          <ul>
+ *             <li>
+ *                <p>A condition in one of the condition expressions is not met.</p>
+ *             </li>
+ *             <li>
+ *                <p>A table in the <code>TransactWriteItems</code> request is in a different
+ *                     account or region.</p>
+ *             </li>
+ *             <li>
+ *                <p>More than one action in the <code>TransactWriteItems</code> operation
+ *                     targets the same item.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is insufficient provisioned capacity for the transaction to be
+ *                     completed.</p>
+ *             </li>
+ *             <li>
+ *                <p>An item size becomes too large (larger than 400 KB), or a local secondary
+ *                     index (LSI) becomes too large, or a similar validation error occurs because of
+ *                     changes made by the transaction.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is a user error, such as an invalid data format.</p>
+ *             </li>
+ *          </ul>
+ *          <p>DynamoDB cancels a <code>TransactGetItems</code> request under the
+ *             following circumstances:</p>
+ *          <ul>
+ *             <li>
+ *                <p>There is an ongoing <code>TransactGetItems</code> operation that conflicts
+ *                     with a concurrent <code>PutItem</code>, <code>UpdateItem</code>,
+ *                         <code>DeleteItem</code> or <code>TransactWriteItems</code> request. In this
+ *                     case the <code>TransactGetItems</code> operation fails with a
+ *                         <code>TransactionCanceledException</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>A table in the <code>TransactGetItems</code> request is in a different
+ *                     account or region.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is insufficient provisioned capacity for the transaction to be
+ *                     completed.</p>
+ *             </li>
+ *             <li>
+ *                <p>There is a user error, such as an invalid data format.</p>
+ *             </li>
+ *          </ul>
+ *          <note>
+ *             <p>If using Java, DynamoDB lists the cancellation reasons on the
+ *                     <code>CancellationReasons</code> property. This property is not set for other
+ *                 languages. Transaction cancellation reasons are ordered in the order of requested
+ *                 items, if an item has no error it will have <code>None</code> code and
+ *                     <code>Null</code> message.</p>
+ *          </note>
+ *          <p>Cancellation reason codes and possible error messages:</p>
+ *          <ul>
+ *             <li>
+ *                <p>No Errors:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>None</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Message: <code>null</code>
+ *                      </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Conditional Check Failed:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>ConditionalCheckFailed</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Message: The conditional request failed. </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Item Collection Size Limit Exceeded:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>ItemCollectionSizeLimitExceeded</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Message: Collection size exceeded.</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Transaction Conflict:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>TransactionConflict</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Message: Transaction is ongoing for the item.</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Provisioned Throughput Exceeded:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>ProvisionedThroughputExceeded</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Messages:</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>The level of configured provisioned throughput for the
+ *                                     table was exceeded. Consider increasing your provisioning level
+ *                                     with the UpdateTable API.</p>
+ *                            <note>
+ *                               <p>This Message is received when provisioned throughput is
+ *                                         exceeded is on a provisioned DynamoDB
+ *                                         table.</p>
+ *                            </note>
+ *                         </li>
+ *                         <li>
+ *                            <p>The level of configured provisioned throughput for one or
+ *                                     more global secondary indexes of the table was exceeded.
+ *                                     Consider increasing your provisioning level for the
+ *                                     under-provisioned global secondary indexes with the UpdateTable
+ *                                     API.</p>
+ *                            <note>
+ *                               <p>This message is returned when provisioned throughput is
+ *                                         exceeded is on a provisioned GSI.</p>
+ *                            </note>
+ *                         </li>
+ *                      </ul>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Throttling Error:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>ThrottlingError</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Messages: </p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>Throughput exceeds the current capacity of your table or
+ *                                     index. DynamoDB is automatically scaling your table or
+ *                                     index so please try again shortly. If exceptions persist, check
+ *                                     if you have a hot key:
+ *                                     https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.</p>
+ *                            <note>
+ *                               <p>This message is returned when writes get throttled on an
+ *                                         On-Demand table as DynamoDB is automatically
+ *                                         scaling the table.</p>
+ *                            </note>
+ *                         </li>
+ *                         <li>
+ *                            <p>Throughput exceeds the current capacity for one or more
+ *                                     global secondary indexes. DynamoDB is automatically
+ *                                     scaling your index so please try again shortly.</p>
+ *                            <note>
+ *                               <p>This message is returned when writes get throttled on
+ *                                         an On-Demand GSI as DynamoDB is automatically
+ *                                         scaling the GSI.</p>
+ *                            </note>
+ *                         </li>
+ *                      </ul>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Validation Error:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Code: <code>ValidationError</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Messages: </p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>One or more parameter values were invalid.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>The update expression attempted to update the secondary
+ *                                     index key beyond allowed size limits.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>The update expression attempted to update the secondary
+ *                                     index key to unsupported type.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>An operand in the update expression has an incorrect data
+ *                                     type.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>Item size to update has exceeded the maximum allowed
+ *                                     size.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>Number overflow. Attempting to store a number with
+ *                                     magnitude larger than supported range.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>Type mismatch for attribute to update.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>Nesting Levels have exceeded supported limits.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>The document path provided in the update expression is
+ *                                     invalid for update.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>The provided expression refers to an attribute that does
+ *                                     not exist in the item.</p>
+ *                         </li>
+ *                      </ul>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ *
+ *
  */
 export declare class TransactGetItemsCommand extends $Command<TransactGetItemsCommandInput, TransactGetItemsCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: TransactGetItemsCommandInput;