@aws-sdk/client-dynamodb

import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { DynamoDBServiceException as __BaseException } from "./DynamoDBServiceException"; import type { AttributeValue, CancellationReason, ThrottlingReason } from "./models_0"; /** * There is another ongoing conflicting backup control plane operation on the table. * The backup is either being created, deleted or restored to a table. * @public */ export declare class BackupInUseException extends __BaseException { readonly name: "BackupInUseException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<BackupInUseException, __BaseException>); } /** * Backup not found for the given BackupARN. * @public */ export declare class BackupNotFoundException extends __BaseException { readonly name: "BackupNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<BackupNotFoundException, __BaseException>); } /** * An error occurred on the server side. * @public */ export declare class InternalServerError extends __BaseException { readonly name: "InternalServerError"; readonly $fault: "server"; /** * @internal */ constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>); } /** * Throughput exceeds the current throughput quota for your account. For detailed * information about why the request was throttled and the ARN of the impacted resource, * find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. Contact <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a quota * increase. * @public */ export declare class RequestLimitExceeded extends __BaseException { readonly name: "RequestLimitExceeded"; readonly $fault: "client"; /** * A list of <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> that * provide detailed diagnostic information about why the request was throttled. * * @public */ ThrottlingReasons?: ThrottlingReason[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<RequestLimitExceeded, __BaseException>); } /** * The request was denied due to request throttling. For detailed information about why * the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. * @public */ export declare class ThrottlingException extends __BaseException { readonly name: "ThrottlingException"; readonly $fault: "client"; /** * A list of <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> that * provide detailed diagnostic information about why the request was throttled. * * @public */ throttlingReasons?: ThrottlingReason[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>); } /** * @public */ export declare class InvalidEndpointException extends __BaseException { readonly name: "InvalidEndpointException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidEndpointException, __BaseException>); } /** * The request was denied due to request throttling. For detailed information about * why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. 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 Amazon DynamoDB Developer Guide. * @public */ export declare class ProvisionedThroughputExceededException extends __BaseException { readonly name: "ProvisionedThroughputExceededException"; readonly $fault: "client"; /** * A list of <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> that * provide detailed diagnostic information about why the request was throttled. * * @public */ ThrottlingReasons?: ThrottlingReason[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>); } /** * 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>. * @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>); } /** * An item collection is too large. This exception is only returned for tables that * have one or more local secondary indexes. * @public */ export declare class ItemCollectionSizeLimitExceededException extends __BaseException { readonly name: "ItemCollectionSizeLimitExceededException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ItemCollectionSizeLimitExceededException, __BaseException>); } /** * The request was rejected because one or more items in the request are being modified * by a request in another Region. * @public */ export declare class ReplicatedWriteConflictException extends __BaseException { readonly name: "ReplicatedWriteConflictException"; readonly $fault: "client"; $retryable: {}; /** * @internal */ constructor(opts: __ExceptionOptionType<ReplicatedWriteConflictException, __BaseException>); } /** * Backups have not yet been enabled for this table. * @public */ export declare class ContinuousBackupsUnavailableException extends __BaseException { readonly name: "ContinuousBackupsUnavailableException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ContinuousBackupsUnavailableException, __BaseException>); } /** * There is no limit to the number of daily on-demand backups that can be taken. * 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>. * 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. * When importing into DynamoDB, up to 50 simultaneous import table operations are * allowed per account. * There is a soft account quota of 2,500 tables. * GetRecords was called with a value of more than 1000 for the limit request * parameter. * More than 2 processes are reading from the same streams shard at the same time. * Exceeding this limit may result in request throttling. * @public */ export declare class LimitExceededException extends __BaseException { readonly name: "LimitExceededException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>); } /** * A target table with the specified name is either being created or deleted. * * @public */ export declare class TableInUseException extends __BaseException { readonly name: "TableInUseException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<TableInUseException, __BaseException>); } /** * 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. * @public */ export declare class TableNotFoundException extends __BaseException { readonly name: "TableNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<TableNotFoundException, __BaseException>); } /** * The specified global table already exists. * @public */ export declare class GlobalTableAlreadyExistsException extends __BaseException { readonly name: "GlobalTableAlreadyExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<GlobalTableAlreadyExistsException, __BaseException>); } /** * The operation conflicts with the resource's availability. For example: * <ul> * <li> * You attempted to recreate an existing table. * </li> * <li> * You tried to delete a table currently in the <code>CREATING</code> * state. * </li> * <li> * You tried to update a resource that was already being updated. * </li> * </ul> * When appropriate, wait for the ongoing update to complete and attempt the request * again. * @public */ export declare class ResourceInUseException extends __BaseException { readonly name: "ResourceInUseException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>); } /** * Operation was rejected because there is an ongoing transaction for the * item. * @public */ export declare class TransactionConflictException extends __BaseException { readonly name: "TransactionConflictException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<TransactionConflictException, __BaseException>); } /** * The operation tried to access a nonexistent resource-based policy. * If you specified an <code>ExpectedRevisionId</code>, it's possible that a policy is * present for the resource but its revision ID didn't match the expected value. * @public */ export declare class PolicyNotFoundException extends __BaseException { readonly name: "PolicyNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<PolicyNotFoundException, __BaseException>); } /** * The specified export was not found. * @public */ export declare class ExportNotFoundException extends __BaseException { readonly name: "ExportNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ExportNotFoundException, __BaseException>); } /** * The specified global table does not exist. * @public */ export declare class GlobalTableNotFoundException extends __BaseException { readonly name: "GlobalTableNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<GlobalTableNotFoundException, __BaseException>); } /** * The specified import was not found. * @public */ export declare class ImportNotFoundException extends __BaseException { readonly name: "ImportNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ImportNotFoundException, __BaseException>); } /** * There was an attempt to insert an item with the same primary key as an item that * already exists in the DynamoDB table. * @public */ export declare class DuplicateItemException extends __BaseException { readonly name: "DuplicateItemException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<DuplicateItemException, __BaseException>); } /** * DynamoDB rejected the request because you retried a request with a * different payload but with an idempotent token that was already used. * @public */ export declare class IdempotentParameterMismatchException extends __BaseException { readonly name: "IdempotentParameterMismatchException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>); } /** * The transaction with the given request token is already in progress. * Recommended Settings * <note> * This is a general recommendation for handling the * <code>TransactionInProgressException</code>. These settings help ensure that the * client retries will trigger completion of the ongoing * <code>TransactWriteItems</code> request. * </note> * <ul> * <li> * Set <code>clientExecutionTimeout</code> to a value that allows at least one * retry to be processed after 5 seconds have elapsed since the first attempt for * the <code>TransactWriteItems</code> operation. * </li> * <li> * Set <code>socketTimeout</code> to a value a little lower than the * <code>requestTimeout</code> setting. * </li> * <li> * * <code>requestTimeout</code> should be set based on the time taken for the * individual retries of a single HTTP request for your use case, but setting it to * 1 second or higher should work well to reduce chances of retries and * <code>TransactionInProgressException</code> errors. * </li> * <li> * Use exponential backoff when retrying and tune backoff if needed. * </li> * </ul> * Assuming <a href="https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97">default retry policy</a>, example timeout settings based on the guidelines * above are as follows: * Example timeline: * <ul> * <li> * 0-1000 first attempt * </li> * <li> * 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay * for 4xx errors) * </li> * <li> * 1500-2500 second attempt * </li> * <li> * 2500-3500 second sleep/delay (500 * 2, exponential backoff) * </li> * <li> * 3500-4500 third attempt * </li> * <li> * 4500-6500 third sleep/delay (500 * 2^2) * </li> * <li> * 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds * have elapsed since the first attempt reached TC) * </li> * </ul> * @public */ export declare class TransactionInProgressException extends __BaseException { readonly name: "TransactionInProgressException"; readonly $fault: "client"; Message?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<TransactionInProgressException, __BaseException>); } /** * There was a conflict when writing to the specified S3 bucket. * @public */ export declare class ExportConflictException extends __BaseException { readonly name: "ExportConflictException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ExportConflictException, __BaseException>); } /** * The specified <code>ExportTime</code> is outside of the point in time recovery * window. * @public */ export declare class InvalidExportTimeException extends __BaseException { readonly name: "InvalidExportTimeException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidExportTimeException, __BaseException>); } /** * Point in time recovery has not yet been enabled for this source table. * @public */ export declare class PointInTimeRecoveryUnavailableException extends __BaseException { readonly name: "PointInTimeRecoveryUnavailableException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<PointInTimeRecoveryUnavailableException, __BaseException>); } /** * There was a conflict when importing from the specified S3 source. This can occur when * the current import conflicts with a previous import request that had the same client * token. * @public */ export declare class ImportConflictException extends __BaseException { readonly name: "ImportConflictException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ImportConflictException, __BaseException>); } /** * A target table with the specified name already exists. * @public */ export declare class TableAlreadyExistsException extends __BaseException { readonly name: "TableAlreadyExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<TableAlreadyExistsException, __BaseException>); } /** * An invalid restore time was specified. RestoreDateTime must be between * EarliestRestorableDateTime and LatestRestorableDateTime. * @public */ export declare class InvalidRestoreTimeException extends __BaseException { readonly name: "InvalidRestoreTimeException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidRestoreTimeException, __BaseException>); } /** * The specified replica is already part of the global table. * @public */ export declare class ReplicaAlreadyExistsException extends __BaseException { readonly name: "ReplicaAlreadyExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ReplicaAlreadyExistsException, __BaseException>); } /** * The specified replica is no longer part of the global table. * @public */ export declare class ReplicaNotFoundException extends __BaseException { readonly name: "ReplicaNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ReplicaNotFoundException, __BaseException>); } /** * The operation tried to access a nonexistent index. * @public */ export declare class IndexNotFoundException extends __BaseException { readonly name: "IndexNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<IndexNotFoundException, __BaseException>); } /** * A condition specified in the operation failed to be evaluated. * @public */ export declare class ConditionalCheckFailedException extends __BaseException { readonly name: "ConditionalCheckFailedException"; readonly $fault: "client"; /** * Item which caused the <code>ConditionalCheckFailedException</code>. * @public */ Item?: Record<string, AttributeValue> | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ConditionalCheckFailedException, __BaseException>); } /** * The entire transaction request was canceled. * DynamoDB cancels a <code>TransactWriteItems</code> request under the following * circumstances: * <ul> * <li> * A condition in one of the condition expressions is not met. * </li> * <li> * A table in the <code>TransactWriteItems</code> request is in a different * account or region. * </li> * <li> * More than one action in the <code>TransactWriteItems</code> operation * targets the same item. * </li> * <li> * There is insufficient provisioned capacity for the transaction to be * completed. * </li> * <li> * 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. * </li> * <li> * There is a user error, such as an invalid data format. * </li> * <li> * 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>. * </li> * </ul> * DynamoDB cancels a <code>TransactGetItems</code> request under the * following circumstances: * <ul> * <li> * 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>. * </li> * <li> * A table in the <code>TransactGetItems</code> request is in a different * account or region. * </li> * <li> * There is insufficient provisioned capacity for the transaction to be * completed. * </li> * <li> * There is a user error, such as an invalid data format. * </li> * </ul> * <note> * DynamoDB lists the cancellation reasons on the * <code>CancellationReasons</code> property. 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. * </note> * Cancellation reason codes and possible error messages: * <ul> * <li> * No Errors: * <ul> * <li> * Code: <code>None</code> * * </li> * <li> * Message: <code>null</code> * * </li> * </ul> * </li> * <li> * Conditional Check Failed: * <ul> * <li> * Code: <code>ConditionalCheckFailed</code> * * </li> * <li> * Message: The conditional request failed. * </li> * </ul> * </li> * <li> * Item Collection Size Limit Exceeded: * <ul> * <li> * Code: <code>ItemCollectionSizeLimitExceeded</code> * * </li> * <li> * Message: Collection size exceeded. * </li> * </ul> * </li> * <li> * Transaction Conflict: * <ul> * <li> * Code: <code>TransactionConflict</code> * * </li> * <li> * Message: Transaction is ongoing for the item. * </li> * </ul> * </li> * <li> * Provisioned Throughput Exceeded: * <ul> * <li> * Code: <code>ProvisionedThroughputExceeded</code> * * </li> * <li> * Messages: * <ul> * <li> * The level of configured provisioned throughput for the * table was exceeded. Consider increasing your provisioning level * with the UpdateTable API. * <note> * This Message is received when provisioned throughput is * exceeded is on a provisioned DynamoDB * table. * </note> * </li> * <li> * 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. * <note> * This message is returned when provisioned throughput is * exceeded is on a provisioned GSI. * </note> * </li> * </ul> * </li> * </ul> * </li> * <li> * Throttling Error: * <ul> * <li> * Code: <code>ThrottlingError</code> * * </li> * <li> * Messages: * <ul> * <li> * 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. * <note> * This message is returned when writes get throttled on an * On-Demand table as DynamoDB is automatically * scaling the table. * </note> * </li> * <li> * Throughput exceeds the current capacity for one or more * global secondary indexes. DynamoDB is automatically * scaling your index so please try again shortly. * <note> * This message is returned when writes get throttled on an * On-Demand GSI as DynamoDB is automatically scaling * the GSI. * </note> * </li> * </ul> * </li> * </ul> * </li> * <li> * Validation Error: * <ul> * <li> * Code: <code>ValidationError</code> * * </li> * <li> * Messages: * <ul> * <li> * One or more parameter values were invalid. * </li> * <li> * The update expression attempted to update the secondary * index key beyond allowed size limits. * </li> * <li> * The update expression attempted to update the secondary * index key to unsupported type. * </li> * <li> * An operand in the update expression has an incorrect data * type. * </li> * <li> * Item size to update has exceeded the maximum allowed * size. * </li> * <li> * Number overflow. Attempting to store a number with * magnitude larger than supported range. * </li> * <li> * Type mismatch for attribute to update. * </li> * <li> * Nesting Levels have exceeded supported limits. * </li> * <li> * The document path provided in the update expression is * invalid for update. * </li> * <li> * The provided expression refers to an attribute that does * not exist in the item. * </li> * </ul> * </li> * </ul> * </li> * </ul> * @public */ export declare class TransactionCanceledException extends __BaseException { readonly name: "TransactionCanceledException"; readonly $fault: "client"; Message?: string | undefined; /** * A list of cancellation reasons. * @public */ CancellationReasons?: CancellationReason[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<TransactionCanceledException, __BaseException>); }