@aws-sdk/client-dynamodb 3.296.0 → 3.297.0

package/dist-types/DynamoDB.d.ts

@@ -54,6 +54,7 @@ import { UpdateTableReplicaAutoScalingCommandInput, UpdateTableReplicaAutoScalin
 import { UpdateTimeToLiveCommandInput, UpdateTimeToLiveCommandOutput } from "./commands/UpdateTimeToLiveCommand";
 import { DynamoDBClient } from "./DynamoDBClient";
 /**
+ * @public
  * <fullname>Amazon DynamoDB</fullname>
  *          <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
  *             and predictable performance with seamless scalability. DynamoDB lets you
@@ -74,6 +75,7 @@ import { DynamoDBClient } from "./DynamoDBClient";
  */
 export declare class DynamoDB extends DynamoDBClient {
     /**
+     * @public
      * <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
      *             using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
      *             an equality condition on all key attributes. This enforces that each <code>SELECT</code>
@@ -92,6 +94,7 @@ export declare class DynamoDB extends DynamoDBClient {
     batchExecuteStatement(args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
     batchExecuteStatement(args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
      *             from one or more tables. You identify requested items by primary key.</p>
      *          <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
@@ -144,6 +147,7 @@ export declare class DynamoDB extends DynamoDBClient {
     batchGetItem(args: BatchGetItemCommandInput, cb: (err: any, data?: BatchGetItemCommandOutput) => void): void;
     batchGetItem(args: BatchGetItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or
      *             more tables. A single call to <code>BatchWriteItem</code> can transmit up to 16MB of
      *             data over the network, consisting of up to 25 item put or delete operations. While
@@ -231,6 +235,7 @@ export declare class DynamoDB extends DynamoDBClient {
     batchWriteItem(args: BatchWriteItemCommandInput, cb: (err: any, data?: BatchWriteItemCommandOutput) => void): void;
     batchWriteItem(args: BatchWriteItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchWriteItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a backup for an existing table.</p>
      *          <p> Each time you create an on-demand backup, the entire table data is backed up. There
      *             is no limit to the number of on-demand backups that can be taken. </p>
@@ -266,6 +271,7 @@ export declare class DynamoDB extends DynamoDBClient {
     createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void;
     createBackup(args: CreateBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a global table from an existing table. A global table creates a replication
      *             relationship between two or more DynamoDB tables with the same table name in the
      *             provided Regions. </p>
@@ -334,6 +340,7 @@ export declare class DynamoDB extends DynamoDBClient {
     createGlobalTable(args: CreateGlobalTableCommandInput, cb: (err: any, data?: CreateGlobalTableCommandOutput) => void): void;
     createGlobalTable(args: CreateGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>CreateTable</code> operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can
      *             have two tables with same name if you create the tables in different Regions.</p>
      *          <p>
@@ -352,6 +359,7 @@ export declare class DynamoDB extends DynamoDBClient {
     createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
     createTable(args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an existing backup of a table.</p>
      *          <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per
      *             second.</p>
@@ -360,6 +368,7 @@ export declare class DynamoDB extends DynamoDBClient {
     deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void;
     deleteBackup(args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a single item in a table by primary key. You can perform a conditional delete
      *             operation that deletes the item if it exists, or if it has an expected attribute
      *             value.</p>
@@ -376,6 +385,7 @@ export declare class DynamoDB extends DynamoDBClient {
     deleteItem(args: DeleteItemCommandInput, cb: (err: any, data?: DeleteItemCommandOutput) => void): void;
     deleteItem(args: DeleteItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>DeleteTable</code> operation deletes a table and all of its items. After a
      *                 <code>DeleteTable</code> request, the specified table is in the
      *                 <code>DELETING</code> state until DynamoDB completes the deletion. If the table is
@@ -404,6 +414,7 @@ export declare class DynamoDB extends DynamoDBClient {
     deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
     deleteTable(args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes an existing backup of a table.</p>
      *          <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per
      *             second.</p>
@@ -412,6 +423,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeBackup(args: DescribeBackupCommandInput, cb: (err: any, data?: DescribeBackupCommandOutput) => void): void;
     describeBackup(args: DescribeBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Checks the status of continuous backups and point in time recovery on the specified
      *             table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If
      *             point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to
@@ -429,6 +441,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeContinuousBackups(args: DescribeContinuousBackupsCommandInput, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void): void;
     describeContinuousBackups(args: DescribeContinuousBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about contributor insights for a given table or global secondary
      *             index.</p>
      */
@@ -436,6 +449,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeContributorInsights(args: DescribeContributorInsightsCommandInput, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void): void;
     describeContributorInsights(args: DescribeContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the regional endpoint information. This action must be included in your VPC
      *             endpoint policies, or access to the DescribeEndpoints API will be denied. For more information
      *             on policy permissions, please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
@@ -444,12 +458,14 @@ export declare class DynamoDB extends DynamoDBClient {
     describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
     describeEndpoints(args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes an existing table export.</p>
      */
     describeExport(args: DescribeExportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExportCommandOutput>;
     describeExport(args: DescribeExportCommandInput, cb: (err: any, data?: DescribeExportCommandOutput) => void): void;
     describeExport(args: DescribeExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about the specified global table.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
@@ -468,6 +484,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeGlobalTable(args: DescribeGlobalTableCommandInput, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void): void;
     describeGlobalTable(args: DescribeGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes Region-specific settings for a global table.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
@@ -486,18 +503,21 @@ export declare class DynamoDB extends DynamoDBClient {
     describeGlobalTableSettings(args: DescribeGlobalTableSettingsCommandInput, cb: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void): void;
     describeGlobalTableSettings(args: DescribeGlobalTableSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p> Represents the properties of the import. </p>
      */
     describeImport(args: DescribeImportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImportCommandOutput>;
     describeImport(args: DescribeImportCommandInput, cb: (err: any, data?: DescribeImportCommandOutput) => void): void;
     describeImport(args: DescribeImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about the status of Kinesis streaming.</p>
      */
     describeKinesisStreamingDestination(args: DescribeKinesisStreamingDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeKinesisStreamingDestinationCommandOutput>;
     describeKinesisStreamingDestination(args: DescribeKinesisStreamingDestinationCommandInput, cb: (err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void): void;
     describeKinesisStreamingDestination(args: DescribeKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the current provisioned-capacity quotas for your Amazon Web Services account in
      *             a Region, both for the Region as a whole and for any one DynamoDB table that you create
      *             there.</p>
@@ -573,6 +593,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeLimits(args: DescribeLimitsCommandInput, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void;
     describeLimits(args: DescribeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about the table, including the current status of the table, when
      *             it was created, the primary key schema, and any indexes on the table.</p>
      *          <important>
@@ -593,6 +614,7 @@ export declare class DynamoDB extends DynamoDBClient {
     describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
     describeTable(args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes auto scaling settings across replicas of the global table at once.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
@@ -603,12 +625,14 @@ export declare class DynamoDB extends DynamoDBClient {
     describeTableReplicaAutoScaling(args: DescribeTableReplicaAutoScalingCommandInput, cb: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void): void;
     describeTableReplicaAutoScaling(args: DescribeTableReplicaAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gives a description of the Time to Live (TTL) status on the specified table. </p>
      */
     describeTimeToLive(args: DescribeTimeToLiveCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTimeToLiveCommandOutput>;
     describeTimeToLive(args: DescribeTimeToLiveCommandInput, cb: (err: any, data?: DescribeTimeToLiveCommandOutput) => void): void;
     describeTimeToLive(args: DescribeTimeToLiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTimeToLiveCommandOutput) => void): void;
     /**
+     * @public
      * <p>Stops replication from the DynamoDB table to the Kinesis data stream. This is done
      *             without deleting either of the resources.</p>
      */
@@ -616,6 +640,7 @@ export declare class DynamoDB extends DynamoDBClient {
     disableKinesisStreamingDestination(args: DisableKinesisStreamingDestinationCommandInput, cb: (err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void): void;
     disableKinesisStreamingDestination(args: DisableKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Starts table data replication to the specified Kinesis data stream at a timestamp
      *             chosen during the enable workflow. If this operation doesn't return results immediately,
      *             use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream
@@ -625,6 +650,7 @@ export declare class DynamoDB extends DynamoDBClient {
     enableKinesisStreamingDestination(args: EnableKinesisStreamingDestinationCommandInput, cb: (err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void): void;
     enableKinesisStreamingDestination(args: EnableKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation allows you to perform reads and singleton writes on data stored in
      *             DynamoDB, using PartiQL.</p>
      *          <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
@@ -643,6 +669,7 @@ export declare class DynamoDB extends DynamoDBClient {
     executeStatement(args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
     executeStatement(args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation allows you to perform transactional reads or writes on data stored in
      *             DynamoDB, using PartiQL.</p>
      *          <note>
@@ -656,6 +683,7 @@ export declare class DynamoDB extends DynamoDBClient {
     executeTransaction(args: ExecuteTransactionCommandInput, cb: (err: any, data?: ExecuteTransactionCommandOutput) => void): void;
     executeTransaction(args: ExecuteTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteTransactionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Exports table data to an S3 bucket. The table must have point in time recovery
      *             enabled, and you can export data from any time within the point in time recovery
      *             window.</p>
@@ -664,6 +692,7 @@ export declare class DynamoDB extends DynamoDBClient {
     exportTableToPointInTime(args: ExportTableToPointInTimeCommandInput, cb: (err: any, data?: ExportTableToPointInTimeCommandOutput) => void): void;
     exportTableToPointInTime(args: ExportTableToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportTableToPointInTimeCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>GetItem</code> operation returns a set of attributes for the item with the
      *             given primary key. If there is no matching item, <code>GetItem</code> does not return
      *             any data and there will be no <code>Item</code> element in the response.</p>
@@ -677,12 +706,14 @@ export declare class DynamoDB extends DynamoDBClient {
     getItem(args: GetItemCommandInput, cb: (err: any, data?: GetItemCommandOutput) => void): void;
     getItem(args: GetItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetItemCommandOutput) => void): void;
     /**
+     * @public
      * <p> Imports table data from an S3 bucket. </p>
      */
     importTable(args: ImportTableCommandInput, options?: __HttpHandlerOptions): Promise<ImportTableCommandOutput>;
     importTable(args: ImportTableCommandInput, cb: (err: any, data?: ImportTableCommandOutput) => void): void;
     importTable(args: ImportTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>List backups associated with an Amazon Web Services account. To list backups for a
      *             given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
      *             paginated list of results with at most 1 MB worth of items in a page. You can also
@@ -695,6 +726,7 @@ export declare class DynamoDB extends DynamoDBClient {
     listBackups(args: ListBackupsCommandInput, cb: (err: any, data?: ListBackupsCommandOutput) => void): void;
     listBackups(args: ListBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of ContributorInsightsSummary for a table and all its global secondary
      *             indexes.</p>
      */
@@ -702,12 +734,14 @@ export declare class DynamoDB extends DynamoDBClient {
     listContributorInsights(args: ListContributorInsightsCommandInput, cb: (err: any, data?: ListContributorInsightsCommandOutput) => void): void;
     listContributorInsights(args: ListContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContributorInsightsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists completed exports within the past 90 days.</p>
      */
     listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListExportsCommandOutput>;
     listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void;
     listExports(args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all global tables that have a replica in the specified Region.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
@@ -726,12 +760,14 @@ export declare class DynamoDB extends DynamoDBClient {
     listGlobalTables(args: ListGlobalTablesCommandInput, cb: (err: any, data?: ListGlobalTablesCommandOutput) => void): void;
     listGlobalTables(args: ListGlobalTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGlobalTablesCommandOutput) => void): void;
     /**
+     * @public
      * <p> Lists completed imports within the past 90 days. </p>
      */
     listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise<ListImportsCommandOutput>;
     listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
     listImports(args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns an array of table names associated with the current account and endpoint. The
      *             output from <code>ListTables</code> is paginated, with each page returning a maximum of
      *             100 table names.</p>
@@ -740,6 +776,7 @@ export declare class DynamoDB extends DynamoDBClient {
     listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
     listTables(args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
     /**
+     * @public
      * <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
      *             times per second, per account.</p>
      *          <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
@@ -749,6 +786,7 @@ export declare class DynamoDB extends DynamoDBClient {
     listTagsOfResource(args: ListTagsOfResourceCommandInput, cb: (err: any, data?: ListTagsOfResourceCommandOutput) => void): void;
     listTagsOfResource(args: ListTagsOfResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsOfResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new item, or replaces an old item with a new item. If an item that has the
      *             same primary key as the new item already exists in the specified table, the new item
      *             completely replaces the existing item. You can perform a conditional put operation (add
@@ -776,6 +814,7 @@ export declare class DynamoDB extends DynamoDBClient {
     putItem(args: PutItemCommandInput, cb: (err: any, data?: PutItemCommandOutput) => void): void;
     putItem(args: PutItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>You must provide the name of the partition key attribute and a single value for that
      *             attribute. <code>Query</code> returns all items with that partition key value.
      *             Optionally, you can provide a sort key attribute and use a comparison operator to refine
@@ -832,6 +871,7 @@ export declare class DynamoDB extends DynamoDBClient {
     query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void;
     query(args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new table from an existing backup. Any number of users can execute up to 4
      *             concurrent restores (any type of restore) in a given account. </p>
      *          <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
@@ -862,6 +902,7 @@ export declare class DynamoDB extends DynamoDBClient {
     restoreTableFromBackup(args: RestoreTableFromBackupCommandInput, cb: (err: any, data?: RestoreTableFromBackupCommandOutput) => void): void;
     restoreTableFromBackup(args: RestoreTableFromBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableFromBackupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Restores the specified table to the specified point in time within
      *                 <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
      *             You can restore your table to any point in time during the last 35 days. Any number of
@@ -917,6 +958,7 @@ export declare class DynamoDB extends DynamoDBClient {
     restoreTableToPointInTime(args: RestoreTableToPointInTimeCommandInput, cb: (err: any, data?: RestoreTableToPointInTimeCommandOutput) => void): void;
     restoreTableToPointInTime(args: RestoreTableToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableToPointInTimeCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>Scan</code> operation returns one or more items and item attributes by
      *             accessing every item in a table or a secondary index. To have DynamoDB return fewer
      *             items, you can provide a <code>FilterExpression</code> operation.</p>
@@ -948,6 +990,7 @@ export declare class DynamoDB extends DynamoDBClient {
     scan(args: ScanCommandInput, cb: (err: any, data?: ScanCommandOutput) => void): void;
     scan(args: ScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScanCommandOutput) => void): void;
     /**
+     * @public
      * <p>Associate a set of tags with an Amazon DynamoDB resource. You can then activate these
      *             user-defined tags so that they appear on the Billing and Cost Management console for
      *             cost allocation tracking. You can call TagResource up to five times per second, per
@@ -959,6 +1002,7 @@ export declare class DynamoDB extends DynamoDBClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             <code>TransactGetItems</code> is a synchronous operation that atomically retrieves
      *             multiple items from one or more tables (but not from indexes) in a single account and
@@ -991,6 +1035,7 @@ export declare class DynamoDB extends DynamoDBClient {
     transactGetItems(args: TransactGetItemsCommandInput, cb: (err: any, data?: TransactGetItemsCommandOutput) => void): void;
     transactGetItems(args: TransactGetItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransactGetItemsCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             <code>TransactWriteItems</code> is a synchronous write operation that groups up to 100
      *             action requests. These actions can target items in different tables, but not in
@@ -1069,6 +1114,7 @@ export declare class DynamoDB extends DynamoDBClient {
     transactWriteItems(args: TransactWriteItemsCommandInput, cb: (err: any, data?: TransactWriteItemsCommandOutput) => void): void;
     transactWriteItems(args: TransactWriteItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransactWriteItemsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
      *                 <code>UntagResource</code> up to five times per second, per account. </p>
      *          <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
@@ -1078,6 +1124,7 @@ export declare class DynamoDB extends DynamoDBClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             <code>UpdateContinuousBackups</code> enables or disables point in time recovery for
      *             the specified table. A successful <code>UpdateContinuousBackups</code> call returns the
@@ -1095,6 +1142,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateContinuousBackups(args: UpdateContinuousBackupsCommandInput, cb: (err: any, data?: UpdateContinuousBackupsCommandOutput) => void): void;
     updateContinuousBackups(args: UpdateContinuousBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContinuousBackupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the status for contributor insights for a specific table or index. CloudWatch
      *             Contributor Insights for DynamoDB graphs display the partition key and (if applicable)
      *             sort key of frequently accessed items and frequently throttled items in plaintext. If
@@ -1107,6 +1155,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateContributorInsights(args: UpdateContributorInsightsCommandInput, cb: (err: any, data?: UpdateContributorInsightsCommandOutput) => void): void;
     updateContributorInsights(args: UpdateContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContributorInsightsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds or removes replicas in the specified global table. The global table must already
      *             exist to be able to use this operation. Any replica to be added must be empty, have the
      *             same name as the global table, have the same key schema, have DynamoDB Streams enabled,
@@ -1155,6 +1204,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateGlobalTable(args: UpdateGlobalTableCommandInput, cb: (err: any, data?: UpdateGlobalTableCommandOutput) => void): void;
     updateGlobalTable(args: UpdateGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates settings for a global table.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
@@ -1173,6 +1223,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateGlobalTableSettings(args: UpdateGlobalTableSettingsCommandInput, cb: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void): void;
     updateGlobalTableSettings(args: UpdateGlobalTableSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Edits an existing item's attributes, or adds a new item to the table if it does not
      *             already exist. You can put, delete, or add attribute values. You can also perform a
      *             conditional update on an existing item (insert a new attribute name-value pair if it
@@ -1185,6 +1236,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateItem(args: UpdateItemCommandInput, cb: (err: any, data?: UpdateItemCommandOutput) => void): void;
     updateItem(args: UpdateItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
      *             Streams settings for a given table.</p>
      *          <important>
@@ -1217,6 +1269,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
     updateTable(args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates auto scaling settings on your global tables at once.</p>
      *          <important>
      *             <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
@@ -1228,6 +1281,7 @@ export declare class DynamoDB extends DynamoDBClient {
     updateTableReplicaAutoScaling(args: UpdateTableReplicaAutoScalingCommandInput, cb: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void): void;
     updateTableReplicaAutoScaling(args: UpdateTableReplicaAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void): void;
     /**
+     * @public
      * <p>The <code>UpdateTimeToLive</code> method enables or disables Time to Live (TTL) for
      *             the specified table. A successful <code>UpdateTimeToLive</code> call returns the current
      *                 <code>TimeToLiveSpecification</code>. It can take up to one hour for the change to

package/dist-types/DynamoDBClient.d.ts

@@ -62,15 +62,24 @@ import { UpdateTableCommandInput, UpdateTableCommandOutput } from "./commands/Up
 import { UpdateTableReplicaAutoScalingCommandInput, UpdateTableReplicaAutoScalingCommandOutput } from "./commands/UpdateTableReplicaAutoScalingCommand";
 import { UpdateTimeToLiveCommandInput, UpdateTimeToLiveCommandOutput } from "./commands/UpdateTimeToLiveCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchExecuteStatementCommandInput | BatchGetItemCommandInput | BatchWriteItemCommandInput | CreateBackupCommandInput | CreateGlobalTableCommandInput | CreateTableCommandInput | DeleteBackupCommandInput | DeleteItemCommandInput | DeleteTableCommandInput | DescribeBackupCommandInput | DescribeContinuousBackupsCommandInput | DescribeContributorInsightsCommandInput | DescribeEndpointsCommandInput | DescribeExportCommandInput | DescribeGlobalTableCommandInput | DescribeGlobalTableSettingsCommandInput | DescribeImportCommandInput | DescribeKinesisStreamingDestinationCommandInput | DescribeLimitsCommandInput | DescribeTableCommandInput | DescribeTableReplicaAutoScalingCommandInput | DescribeTimeToLiveCommandInput | DisableKinesisStreamingDestinationCommandInput | EnableKinesisStreamingDestinationCommandInput | ExecuteStatementCommandInput | ExecuteTransactionCommandInput | ExportTableToPointInTimeCommandInput | GetItemCommandInput | ImportTableCommandInput | ListBackupsCommandInput | ListContributorInsightsCommandInput | ListExportsCommandInput | ListGlobalTablesCommandInput | ListImportsCommandInput | ListTablesCommandInput | ListTagsOfResourceCommandInput | PutItemCommandInput | QueryCommandInput | RestoreTableFromBackupCommandInput | RestoreTableToPointInTimeCommandInput | ScanCommandInput | TagResourceCommandInput | TransactGetItemsCommandInput | TransactWriteItemsCommandInput | UntagResourceCommandInput | UpdateContinuousBackupsCommandInput | UpdateContributorInsightsCommandInput | UpdateGlobalTableCommandInput | UpdateGlobalTableSettingsCommandInput | UpdateItemCommandInput | UpdateTableCommandInput | UpdateTableReplicaAutoScalingCommandInput | UpdateTimeToLiveCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchExecuteStatementCommandOutput | BatchGetItemCommandOutput | BatchWriteItemCommandOutput | CreateBackupCommandOutput | CreateGlobalTableCommandOutput | CreateTableCommandOutput | DeleteBackupCommandOutput | DeleteItemCommandOutput | DeleteTableCommandOutput | DescribeBackupCommandOutput | DescribeContinuousBackupsCommandOutput | DescribeContributorInsightsCommandOutput | DescribeEndpointsCommandOutput | DescribeExportCommandOutput | DescribeGlobalTableCommandOutput | DescribeGlobalTableSettingsCommandOutput | DescribeImportCommandOutput | DescribeKinesisStreamingDestinationCommandOutput | DescribeLimitsCommandOutput | DescribeTableCommandOutput | DescribeTableReplicaAutoScalingCommandOutput | DescribeTimeToLiveCommandOutput | DisableKinesisStreamingDestinationCommandOutput | EnableKinesisStreamingDestinationCommandOutput | ExecuteStatementCommandOutput | ExecuteTransactionCommandOutput | ExportTableToPointInTimeCommandOutput | GetItemCommandOutput | ImportTableCommandOutput | ListBackupsCommandOutput | ListContributorInsightsCommandOutput | ListExportsCommandOutput | ListGlobalTablesCommandOutput | ListImportsCommandOutput | ListTablesCommandOutput | ListTagsOfResourceCommandOutput | PutItemCommandOutput | QueryCommandOutput | RestoreTableFromBackupCommandOutput | RestoreTableToPointInTimeCommandOutput | ScanCommandOutput | TagResourceCommandOutput | TransactGetItemsCommandOutput | TransactWriteItemsCommandOutput | UntagResourceCommandOutput | UpdateContinuousBackupsCommandOutput | UpdateContributorInsightsCommandOutput | UpdateGlobalTableCommandOutput | UpdateGlobalTableSettingsCommandOutput | UpdateItemCommandOutput | UpdateTableCommandOutput | UpdateTableReplicaAutoScalingCommandOutput | UpdateTimeToLiveCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -166,23 +175,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type DynamoDBClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & EndpointDiscoveryInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of DynamoDBClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of DynamoDBClient class constructor that set the region, credentials and other options.
  */
 export interface DynamoDBClientConfig extends DynamoDBClientConfigType {
 }
+/**
+ * @public
+ */
 type DynamoDBClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & EndpointDiscoveryResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of DynamoDBClient class. This is resolved and normalized from the {@link DynamoDBClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of DynamoDBClient class. This is resolved and normalized from the {@link DynamoDBClientConfig | constructor configuration interface}.
  */
 export interface DynamoDBClientResolvedConfig extends DynamoDBClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon DynamoDB</fullname>
  *          <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
  *             and predictable performance with seamless scalability. DynamoDB lets you

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
 import { BatchExecuteStatementInput, BatchExecuteStatementOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchExecuteStatementCommand}.
  */
 export interface BatchExecuteStatementCommandInput extends BatchExecuteStatementInput {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchExecuteStatementCommand}.
  */
 export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatementOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
  *             using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
  *             an equality condition on all key attributes. This enforces that each <code>SELECT</code>
@@ -37,6 +42,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchExecuteStatementCommandInput - {@link BatchExecuteStatementCommandInput}
+ * @returns {@link BatchExecuteStatementCommandOutput}
  * @see {@link BatchExecuteStatementCommandInput} for command's `input` shape.
  * @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -54,11 +61,20 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
 export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: BatchExecuteStatementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchExecuteStatementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
 import { BatchGetItemInput, BatchGetItemOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetItemCommand}.
  */
 export interface BatchGetItemCommandInput extends BatchGetItemInput {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetItemCommand}.
  */
 export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
  *             from one or more tables. You identify requested items by primary key.</p>
  *          <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
@@ -71,6 +76,8 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetItemCommandInput - {@link BatchGetItemCommandInput}
+ * @returns {@link BatchGetItemCommandOutput}
  * @see {@link BatchGetItemCommandInput} for command's `input` shape.
  * @see {@link BatchGetItemCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -164,11 +171,20 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
 export declare class BatchGetItemCommand extends $Command<BatchGetItemCommandInput, BatchGetItemCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: BatchGetItemCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetItemCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetItemCommandInput, BatchGetItemCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
 import { BatchWriteItemInput, BatchWriteItemOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchWriteItemCommand}.
  */
 export interface BatchWriteItemCommandInput extends BatchWriteItemInput {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchWriteItemCommand}.
  */
 export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or
  *             more tables. A single call to <code>BatchWriteItem</code> can transmit up to 16MB of
  *             data over the network, consisting of up to 25 item put or delete operations. While
@@ -106,6 +111,8 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchWriteItemCommandInput - {@link BatchWriteItemCommandInput}
+ * @returns {@link BatchWriteItemCommandOutput}
  * @see {@link BatchWriteItemCommandInput} for command's `input` shape.
  * @see {@link BatchWriteItemCommandOutput} for command's `response` shape.
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -198,11 +205,20 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
 export declare class BatchWriteItemCommand extends $Command<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig> {
     readonly input: BatchWriteItemCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchWriteItemCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchWriteItemCommandInput, BatchWriteItemCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }