@aws-sdk/client-dynamodb 3.42.0 → 3.46.0

package/dist-types/models/models_0.d.ts

@@ -891,71 +891,6 @@ export declare enum BackupTypeFilter {
     SYSTEM = "SYSTEM",
     USER = "USER"
 }
-export declare enum BatchStatementErrorCodeEnum {
-    AccessDenied = "AccessDenied",
-    ConditionalCheckFailed = "ConditionalCheckFailed",
-    DuplicateItem = "DuplicateItem",
-    InternalServerError = "InternalServerError",
-    ItemCollectionSizeLimitExceeded = "ItemCollectionSizeLimitExceeded",
-    ProvisionedThroughputExceeded = "ProvisionedThroughputExceeded",
-    RequestLimitExceeded = "RequestLimitExceeded",
-    ResourceNotFound = "ResourceNotFound",
-    ThrottlingError = "ThrottlingError",
-    TransactionConflict = "TransactionConflict",
-    ValidationError = "ValidationError"
-}
-/**
- * <p> An error associated with a statement in a PartiQL batch that was run. </p>
- */
-export interface BatchStatementError {
-    /**
-     * <p> The error code associated with the failed PartiQL batch statement. </p>
-     */
-    Code?: BatchStatementErrorCodeEnum | string;
-    /**
-     * <p> The error message associated with the PartiQL batch resposne. </p>
-     */
-    Message?: string;
-}
-export declare namespace BatchStatementError {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: BatchStatementError) => any;
-}
-/**
- * <p>An error occurred on the server side.</p>
- */
-export interface InternalServerError extends __SmithyException, $MetadataBearer {
-    name: "InternalServerError";
-    $fault: "server";
-    /**
-     * <p>The server encountered an internal error trying to fulfill the request.</p>
-     */
-    message?: string;
-}
-export declare namespace InternalServerError {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InternalServerError) => any;
-}
-/**
- * <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>
- */
-export interface RequestLimitExceeded extends __SmithyException, $MetadataBearer {
-    name: "RequestLimitExceeded";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace RequestLimitExceeded {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: RequestLimitExceeded) => any;
-}
 export declare type ReturnConsumedCapacity = "INDEXES" | "NONE" | "TOTAL";
 /**
  * <p>Represents the amount of provisioned throughput capacity consumed on a table or an
@@ -1030,6 +965,71 @@ export declare namespace ConsumedCapacity {
      */
     const filterSensitiveLog: (obj: ConsumedCapacity) => any;
 }
+export declare enum BatchStatementErrorCodeEnum {
+    AccessDenied = "AccessDenied",
+    ConditionalCheckFailed = "ConditionalCheckFailed",
+    DuplicateItem = "DuplicateItem",
+    InternalServerError = "InternalServerError",
+    ItemCollectionSizeLimitExceeded = "ItemCollectionSizeLimitExceeded",
+    ProvisionedThroughputExceeded = "ProvisionedThroughputExceeded",
+    RequestLimitExceeded = "RequestLimitExceeded",
+    ResourceNotFound = "ResourceNotFound",
+    ThrottlingError = "ThrottlingError",
+    TransactionConflict = "TransactionConflict",
+    ValidationError = "ValidationError"
+}
+/**
+ * <p> An error associated with a statement in a PartiQL batch that was run. </p>
+ */
+export interface BatchStatementError {
+    /**
+     * <p> The error code associated with the failed PartiQL batch statement. </p>
+     */
+    Code?: BatchStatementErrorCodeEnum | string;
+    /**
+     * <p> The error message associated with the PartiQL batch resposne. </p>
+     */
+    Message?: string;
+}
+export declare namespace BatchStatementError {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: BatchStatementError) => any;
+}
+/**
+ * <p>An error occurred on the server side.</p>
+ */
+export interface InternalServerError extends __SmithyException, $MetadataBearer {
+    name: "InternalServerError";
+    $fault: "server";
+    /**
+     * <p>The server encountered an internal error trying to fulfill the request.</p>
+     */
+    message?: string;
+}
+export declare namespace InternalServerError {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: InternalServerError) => any;
+}
+/**
+ * <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>
+ */
+export interface RequestLimitExceeded extends __SmithyException, $MetadataBearer {
+    name: "RequestLimitExceeded";
+    $fault: "client";
+    message?: string;
+}
+export declare namespace RequestLimitExceeded {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: RequestLimitExceeded) => any;
+}
 export interface InvalidEndpointException extends __SmithyException, $MetadataBearer {
     name: "InvalidEndpointException";
     $fault: "client";
@@ -1444,6 +1444,30 @@ export declare namespace ReplicaGlobalSecondaryIndexDescription {
     const filterSensitiveLog: (obj: ReplicaGlobalSecondaryIndexDescription) => any;
 }
 export declare type ReplicaStatus = "ACTIVE" | "CREATING" | "CREATION_FAILED" | "DELETING" | "INACCESSIBLE_ENCRYPTION_CREDENTIALS" | "REGION_DISABLED" | "UPDATING";
+export declare enum TableClass {
+    STANDARD = "STANDARD",
+    STANDARD_INFREQUENT_ACCESS = "STANDARD_INFREQUENT_ACCESS"
+}
+/**
+ * <p>Contains details of the table class.</p>
+ */
+export interface TableClassSummary {
+    /**
+     * <p>The table class of the specified table. Valid values are <code>STANDARD</code> and
+     *                 <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
+     */
+    TableClass?: TableClass | string;
+    /**
+     * <p>The date and time at which the table class was last updated.</p>
+     */
+    LastUpdateDateTime?: Date;
+}
+export declare namespace TableClassSummary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: TableClassSummary) => any;
+}
 /**
  * <p>Contains the details of the replica.</p>
  */
@@ -1523,6 +1547,10 @@ export interface ReplicaDescription {
      *             of inaccessibility check the <code>ReplicaStatus</code> property.</p>
      */
     ReplicaInaccessibleDateTime?: Date;
+    /**
+     * <p>Contains details of the table class.</p>
+     */
+    ReplicaTableClassSummary?: TableClassSummary;
 }
 export declare namespace ReplicaDescription {
     /**
@@ -1665,6 +1693,11 @@ export interface CreateReplicationGroupMemberAction {
      * <p>Replica-specific global secondary index settings.</p>
      */
     GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndex[];
+    /**
+     * <p>Replica-specific table class. If not specified, uses the source table's
+     *             table class.</p>
+     */
+    TableClassOverride?: TableClass | string;
 }
 export declare namespace CreateReplicationGroupMemberAction {
     /**
@@ -2100,6 +2133,11 @@ export interface CreateTableInput {
      *                 for DynamoDB</a>.</p>
      */
     Tags?: Tag[];
+    /**
+     * <p>The table class of the new table. Valid values are <code>STANDARD</code> and
+     *                 <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
+     */
+    TableClass?: TableClass | string;
 }
 export declare namespace CreateTableInput {
     /**
@@ -2719,6 +2757,10 @@ export interface TableDescription {
      * <p>Contains information about the table archive.</p>
      */
     ArchivalSummary?: ArchivalSummary;
+    /**
+     * <p>Contains details of the table class.</p>
+     */
+    TableClassSummary?: TableClassSummary;
 }
 export declare namespace TableDescription {
     /**
@@ -3372,6 +3414,10 @@ export interface ReplicaSettingsDescription {
      * <p>Replica global secondary index settings for the global table.</p>
      */
     ReplicaGlobalSecondaryIndexSettings?: ReplicaGlobalSecondaryIndexSettingsDescription[];
+    /**
+     * <p>Contains details of the table class.</p>
+     */
+    ReplicaTableClassSummary?: TableClassSummary;
 }
 export declare namespace ReplicaSettingsDescription {
     /**
@@ -4681,6 +4727,11 @@ export interface ReplicaSettingsUpdate {
      *             modified.</p>
      */
     ReplicaGlobalSecondaryIndexSettingsUpdate?: ReplicaGlobalSecondaryIndexSettingsUpdate[];
+    /**
+     * <p>Replica-specific table class. If not specified, uses the source table's
+     *             table class.</p>
+     */
+    ReplicaTableClass?: TableClass | string;
 }
 export declare namespace ReplicaSettingsUpdate {
     /**
@@ -4869,6 +4920,11 @@ export interface UpdateReplicationGroupMemberAction {
      * <p>Replica-specific global secondary index settings.</p>
      */
     GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndex[];
+    /**
+     * <p>Replica-specific table class. If not specified, uses the source table's
+     *             table class.</p>
+     */
+    TableClassOverride?: TableClass | string;
 }
 export declare namespace UpdateReplicationGroupMemberAction {
     /**
@@ -5000,6 +5056,11 @@ export interface UpdateTableInput {
      *         </note>
      */
     ReplicaUpdates?: ReplicationGroupUpdate[];
+    /**
+     * <p>The table class of the table to be updated. Valid values are <code>STANDARD</code> and
+     *                 <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
+     */
+    TableClass?: TableClass | string;
 }
 export declare namespace UpdateTableInput {
     /**
@@ -5895,6 +5956,34 @@ export interface ExecuteStatementInput {
      *             statement response.</p>
      */
     NextToken?: string;
+    /**
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                     <code>INDEXES</code> - The response includes the aggregate
+     *                         <code>ConsumedCapacity</code> for the operation, together with
+     *                         <code>ConsumedCapacity</code> for each table and secondary index that was
+     *                     accessed.</p>
+     *                 <p>Note that some operations, such as <code>GetItem</code> and
+     *                         <code>BatchGetItem</code>, do not access any indexes at all. In these cases,
+     *                     specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code>
+     *                     information for table(s).</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>TOTAL</code> - The response includes only the aggregate
+     *                         <code>ConsumedCapacity</code> for the operation.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the
+     *                     response.</p>
+     *             </li>
+     *          </ul>
+     */
+    ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
 }
 export declare namespace ExecuteStatementInput {
     /**
@@ -5971,8 +6060,8 @@ export interface GetItemInput {
      */
     ConsistentRead?: boolean;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -6201,6 +6290,14 @@ export interface ExecuteStatementOutput {
      *             request to get the remaining results.</p>
      */
     NextToken?: string;
+    /**
+     * <p>The capacity units consumed by an operation. The data returned includes the total
+     *             provisioned throughput consumed, along with statistics for the table and any indexes
+     *             involved in the operation. <code>ConsumedCapacity</code> is only returned if the request
+     *             asked for it. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer
+     *                 Guide</i>.</p>
+     */
+    ConsumedCapacity?: ConsumedCapacity;
 }
 export declare namespace ExecuteStatementOutput {
     /**
@@ -6331,6 +6428,34 @@ export interface BatchExecuteStatementInput {
      * <p>The list of PartiQL statements representing the batch to run.</p>
      */
     Statements: BatchStatementRequest[] | undefined;
+    /**
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                     <code>INDEXES</code> - The response includes the aggregate
+     *                         <code>ConsumedCapacity</code> for the operation, together with
+     *                         <code>ConsumedCapacity</code> for each table and secondary index that was
+     *                     accessed.</p>
+     *                 <p>Note that some operations, such as <code>GetItem</code> and
+     *                         <code>BatchGetItem</code>, do not access any indexes at all. In these cases,
+     *                     specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code>
+     *                     information for table(s).</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>TOTAL</code> - The response includes only the aggregate
+     *                         <code>ConsumedCapacity</code> for the operation.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                     <code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the
+     *                     response.</p>
+     *             </li>
+     *          </ul>
+     */
+    ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
 }
 export declare namespace BatchExecuteStatementInput {
     /**
@@ -6343,6 +6468,11 @@ export interface BatchExecuteStatementOutput {
      * <p>The response to each PartiQL statement in the batch.</p>
      */
     Responses?: BatchStatementResponse[];
+    /**
+     * <p>The capacity units consumed by the entire operation. The values of the list are
+     *             ordered according to the ordering of the statements.</p>
+     */
+    ConsumedCapacity?: ConsumedCapacity[];
 }
 export declare namespace BatchExecuteStatementOutput {
     /**
@@ -6360,6 +6490,11 @@ export interface ExecuteTransactionInput {
      *             statement response.</p>
      */
     ClientRequestToken?: string;
+    /**
+     * <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is
+     *             returned in the response. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html">TransactGetItems</a> and <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html">TransactWriteItems</a>.</p>
+     */
+    ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
 }
 export declare namespace ExecuteTransactionInput {
     /**
@@ -6372,6 +6507,11 @@ export interface ExecuteTransactionOutput {
      * <p>The response to a PartiQL transaction.</p>
      */
     Responses?: ItemResponse[];
+    /**
+     * <p>The capacity units consumed by the entire operation. The values of the list are
+     *             ordered according to the ordering of the statements.</p>
+     */
+    ConsumedCapacity?: ConsumedCapacity[];
 }
 export declare namespace ExecuteTransactionOutput {
     /**
@@ -6769,8 +6909,8 @@ export interface BatchGetItemInput {
         [key: string]: KeysAndAttributes;
     } | undefined;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -7815,8 +7955,8 @@ export interface ScanInput {
         [key: string]: AttributeValue;
     };
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -8056,8 +8196,8 @@ export interface BatchWriteItemInput {
         [key: string]: WriteRequest[];
     } | undefined;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -8153,8 +8293,8 @@ export interface DeleteItemInput {
      */
     ReturnValues?: ReturnValue | string;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -8365,8 +8505,8 @@ export interface PutItemInput {
      */
     ReturnValues?: ReturnValue | string;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -8662,8 +8802,8 @@ export interface QueryInput {
         [key: string]: AttributeValue;
     };
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -9112,8 +9252,8 @@ export interface UpdateItemInput {
      */
     ReturnValues?: ReturnValue | string;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>
@@ -9403,8 +9543,8 @@ export interface TransactWriteItemsInput {
      */
     TransactItems: TransactWriteItem[] | undefined;
     /**
-     * <p>Determines the level of detail about provisioned throughput consumption that is
-     *             returned in the response:</p>
+     * <p>Determines the level of detail about either provisioned or on-demand throughput
+     *             consumption that is returned in the response:</p>
      *         <ul>
      *             <li>
      *                 <p>