@depup/aws-sdk__client-dynamodb 3.1005.0-depup.0

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

@@ -0,0 +1,373 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
+import type { RestoreTableFromBackupInput, RestoreTableFromBackupOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RestoreTableFromBackupCommand}.
+ */
+export interface RestoreTableFromBackupCommandInput extends RestoreTableFromBackupInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RestoreTableFromBackupCommand}.
+ */
+export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBackupOutput, __MetadataBearer {
+}
+declare const RestoreTableFromBackupCommand_base: {
+    new (input: RestoreTableFromBackupCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: RestoreTableFromBackupCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a new table from an existing backup. Any number of users can execute up to 50
+ *             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
+ *             second.</p>
+ *          <p>You must manually set up the following on the restored table:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Auto scaling policies</p>
+ *             </li>
+ *             <li>
+ *                <p>IAM policies</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon CloudWatch metrics and alarms</p>
+ *             </li>
+ *             <li>
+ *                <p>Tags</p>
+ *             </li>
+ *             <li>
+ *                <p>Stream settings</p>
+ *             </li>
+ *             <li>
+ *                <p>Time to Live (TTL) settings</p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DynamoDBClient, RestoreTableFromBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
+ * // const { DynamoDBClient, RestoreTableFromBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
+ * // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
+ * const config = {}; // type is DynamoDBClientConfig
+ * const client = new DynamoDBClient(config);
+ * const input = { // RestoreTableFromBackupInput
+ *   TargetTableName: "STRING_VALUE", // required
+ *   BackupArn: "STRING_VALUE", // required
+ *   BillingModeOverride: "PROVISIONED" || "PAY_PER_REQUEST",
+ *   GlobalSecondaryIndexOverride: [ // GlobalSecondaryIndexList
+ *     { // GlobalSecondaryIndex
+ *       IndexName: "STRING_VALUE", // required
+ *       KeySchema: [ // KeySchema // required
+ *         { // KeySchemaElement
+ *           AttributeName: "STRING_VALUE", // required
+ *           KeyType: "HASH" || "RANGE", // required
+ *         },
+ *       ],
+ *       Projection: { // Projection
+ *         ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
+ *         NonKeyAttributes: [ // NonKeyAttributeNameList
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *       ProvisionedThroughput: { // ProvisionedThroughput
+ *         ReadCapacityUnits: Number("long"), // required
+ *         WriteCapacityUnits: Number("long"), // required
+ *       },
+ *       OnDemandThroughput: { // OnDemandThroughput
+ *         MaxReadRequestUnits: Number("long"),
+ *         MaxWriteRequestUnits: Number("long"),
+ *       },
+ *       WarmThroughput: { // WarmThroughput
+ *         ReadUnitsPerSecond: Number("long"),
+ *         WriteUnitsPerSecond: Number("long"),
+ *       },
+ *     },
+ *   ],
+ *   LocalSecondaryIndexOverride: [ // LocalSecondaryIndexList
+ *     { // LocalSecondaryIndex
+ *       IndexName: "STRING_VALUE", // required
+ *       KeySchema: [ // required
+ *         {
+ *           AttributeName: "STRING_VALUE", // required
+ *           KeyType: "HASH" || "RANGE", // required
+ *         },
+ *       ],
+ *       Projection: {
+ *         ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
+ *         NonKeyAttributes: [
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     },
+ *   ],
+ *   ProvisionedThroughputOverride: {
+ *     ReadCapacityUnits: Number("long"), // required
+ *     WriteCapacityUnits: Number("long"), // required
+ *   },
+ *   OnDemandThroughputOverride: {
+ *     MaxReadRequestUnits: Number("long"),
+ *     MaxWriteRequestUnits: Number("long"),
+ *   },
+ *   SSESpecificationOverride: { // SSESpecification
+ *     Enabled: true || false,
+ *     SSEType: "AES256" || "KMS",
+ *     KMSMasterKeyId: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new RestoreTableFromBackupCommand(input);
+ * const response = await client.send(command);
+ * // { // RestoreTableFromBackupOutput
+ * //   TableDescription: { // TableDescription
+ * //     AttributeDefinitions: [ // AttributeDefinitions
+ * //       { // AttributeDefinition
+ * //         AttributeName: "STRING_VALUE", // required
+ * //         AttributeType: "S" || "N" || "B", // required
+ * //       },
+ * //     ],
+ * //     TableName: "STRING_VALUE",
+ * //     KeySchema: [ // KeySchema
+ * //       { // KeySchemaElement
+ * //         AttributeName: "STRING_VALUE", // required
+ * //         KeyType: "HASH" || "RANGE", // required
+ * //       },
+ * //     ],
+ * //     TableStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
+ * //     CreationDateTime: new Date("TIMESTAMP"),
+ * //     ProvisionedThroughput: { // ProvisionedThroughputDescription
+ * //       LastIncreaseDateTime: new Date("TIMESTAMP"),
+ * //       LastDecreaseDateTime: new Date("TIMESTAMP"),
+ * //       NumberOfDecreasesToday: Number("long"),
+ * //       ReadCapacityUnits: Number("long"),
+ * //       WriteCapacityUnits: Number("long"),
+ * //     },
+ * //     TableSizeBytes: Number("long"),
+ * //     ItemCount: Number("long"),
+ * //     TableArn: "STRING_VALUE",
+ * //     TableId: "STRING_VALUE",
+ * //     BillingModeSummary: { // BillingModeSummary
+ * //       BillingMode: "PROVISIONED" || "PAY_PER_REQUEST",
+ * //       LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"),
+ * //     },
+ * //     LocalSecondaryIndexes: [ // LocalSecondaryIndexDescriptionList
+ * //       { // LocalSecondaryIndexDescription
+ * //         IndexName: "STRING_VALUE",
+ * //         KeySchema: [
+ * //           {
+ * //             AttributeName: "STRING_VALUE", // required
+ * //             KeyType: "HASH" || "RANGE", // required
+ * //           },
+ * //         ],
+ * //         Projection: { // Projection
+ * //           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
+ * //           NonKeyAttributes: [ // NonKeyAttributeNameList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         IndexSizeBytes: Number("long"),
+ * //         ItemCount: Number("long"),
+ * //         IndexArn: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     GlobalSecondaryIndexes: [ // GlobalSecondaryIndexDescriptionList
+ * //       { // GlobalSecondaryIndexDescription
+ * //         IndexName: "STRING_VALUE",
+ * //         KeySchema: [
+ * //           {
+ * //             AttributeName: "STRING_VALUE", // required
+ * //             KeyType: "HASH" || "RANGE", // required
+ * //           },
+ * //         ],
+ * //         Projection: {
+ * //           ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
+ * //           NonKeyAttributes: [
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
+ * //         Backfilling: true || false,
+ * //         ProvisionedThroughput: {
+ * //           LastIncreaseDateTime: new Date("TIMESTAMP"),
+ * //           LastDecreaseDateTime: new Date("TIMESTAMP"),
+ * //           NumberOfDecreasesToday: Number("long"),
+ * //           ReadCapacityUnits: Number("long"),
+ * //           WriteCapacityUnits: Number("long"),
+ * //         },
+ * //         IndexSizeBytes: Number("long"),
+ * //         ItemCount: Number("long"),
+ * //         IndexArn: "STRING_VALUE",
+ * //         OnDemandThroughput: { // OnDemandThroughput
+ * //           MaxReadRequestUnits: Number("long"),
+ * //           MaxWriteRequestUnits: Number("long"),
+ * //         },
+ * //         WarmThroughput: { // GlobalSecondaryIndexWarmThroughputDescription
+ * //           ReadUnitsPerSecond: Number("long"),
+ * //           WriteUnitsPerSecond: Number("long"),
+ * //           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
+ * //         },
+ * //       },
+ * //     ],
+ * //     StreamSpecification: { // StreamSpecification
+ * //       StreamEnabled: true || false, // required
+ * //       StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
+ * //     },
+ * //     LatestStreamLabel: "STRING_VALUE",
+ * //     LatestStreamArn: "STRING_VALUE",
+ * //     GlobalTableVersion: "STRING_VALUE",
+ * //     Replicas: [ // ReplicaDescriptionList
+ * //       { // ReplicaDescription
+ * //         RegionName: "STRING_VALUE",
+ * //         ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
+ * //         ReplicaStatusDescription: "STRING_VALUE",
+ * //         ReplicaStatusPercentProgress: "STRING_VALUE",
+ * //         KMSMasterKeyId: "STRING_VALUE",
+ * //         ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
+ * //           ReadCapacityUnits: Number("long"),
+ * //         },
+ * //         OnDemandThroughputOverride: { // OnDemandThroughputOverride
+ * //           MaxReadRequestUnits: Number("long"),
+ * //         },
+ * //         WarmThroughput: { // TableWarmThroughputDescription
+ * //           ReadUnitsPerSecond: Number("long"),
+ * //           WriteUnitsPerSecond: Number("long"),
+ * //           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
+ * //         },
+ * //         GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
+ * //           { // ReplicaGlobalSecondaryIndexDescription
+ * //             IndexName: "STRING_VALUE",
+ * //             ProvisionedThroughputOverride: {
+ * //               ReadCapacityUnits: Number("long"),
+ * //             },
+ * //             OnDemandThroughputOverride: {
+ * //               MaxReadRequestUnits: Number("long"),
+ * //             },
+ * //             WarmThroughput: {
+ * //               ReadUnitsPerSecond: Number("long"),
+ * //               WriteUnitsPerSecond: Number("long"),
+ * //               Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
+ * //             },
+ * //           },
+ * //         ],
+ * //         ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
+ * //         ReplicaTableClassSummary: { // TableClassSummary
+ * //           TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
+ * //           LastUpdateDateTime: new Date("TIMESTAMP"),
+ * //         },
+ * //         GlobalTableSettingsReplicationMode: "ENABLED" || "DISABLED" || "ENABLED_WITH_OVERRIDES",
+ * //       },
+ * //     ],
+ * //     GlobalTableWitnesses: [ // GlobalTableWitnessDescriptionList
+ * //       { // GlobalTableWitnessDescription
+ * //         RegionName: "STRING_VALUE",
+ * //         WitnessStatus: "CREATING" || "DELETING" || "ACTIVE",
+ * //       },
+ * //     ],
+ * //     GlobalTableSettingsReplicationMode: "ENABLED" || "DISABLED" || "ENABLED_WITH_OVERRIDES",
+ * //     RestoreSummary: { // RestoreSummary
+ * //       SourceBackupArn: "STRING_VALUE",
+ * //       SourceTableArn: "STRING_VALUE",
+ * //       RestoreDateTime: new Date("TIMESTAMP"), // required
+ * //       RestoreInProgress: true || false, // required
+ * //     },
+ * //     SSEDescription: { // SSEDescription
+ * //       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "UPDATING",
+ * //       SSEType: "AES256" || "KMS",
+ * //       KMSMasterKeyArn: "STRING_VALUE",
+ * //       InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
+ * //     },
+ * //     ArchivalSummary: { // ArchivalSummary
+ * //       ArchivalDateTime: new Date("TIMESTAMP"),
+ * //       ArchivalReason: "STRING_VALUE",
+ * //       ArchivalBackupArn: "STRING_VALUE",
+ * //     },
+ * //     TableClassSummary: {
+ * //       TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
+ * //       LastUpdateDateTime: new Date("TIMESTAMP"),
+ * //     },
+ * //     DeletionProtectionEnabled: true || false,
+ * //     OnDemandThroughput: {
+ * //       MaxReadRequestUnits: Number("long"),
+ * //       MaxWriteRequestUnits: Number("long"),
+ * //     },
+ * //     WarmThroughput: {
+ * //       ReadUnitsPerSecond: Number("long"),
+ * //       WriteUnitsPerSecond: Number("long"),
+ * //       Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
+ * //     },
+ * //     MultiRegionConsistency: "EVENTUAL" || "STRONG",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param RestoreTableFromBackupCommandInput - {@link RestoreTableFromBackupCommandInput}
+ * @returns {@link RestoreTableFromBackupCommandOutput}
+ * @see {@link RestoreTableFromBackupCommandInput} for command's `input` shape.
+ * @see {@link RestoreTableFromBackupCommandOutput} for command's `response` shape.
+ * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
+ *
+ * @throws {@link BackupInUseException} (client fault)
+ *  <p>There is another ongoing conflicting backup control plane operation on the table.
+ *             The backup is either being created, deleted or restored to a table.</p>
+ *
+ * @throws {@link BackupNotFoundException} (client fault)
+ *  <p>Backup not found for the given BackupARN. </p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
+ *          <p>For most purposes, up to 500 simultaneous table operations are allowed per account.
+ *             These operations include <code>CreateTable</code>, <code>UpdateTable</code>,
+ *                 <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
+ *                 <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
+ *          <p>When you are creating a table with one or more secondary indexes, you can have up
+ *             to 250 such requests running at a time. However, if the table or index specifications
+ *             are complex, then DynamoDB might temporarily reduce the number of concurrent
+ *             operations.</p>
+ *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are
+ *             allowed per account.</p>
+ *          <p>There is a soft account quota of 2,500 tables.</p>
+ *          <p>GetRecords was called with a value of more than 1000 for the limit request
+ *             parameter.</p>
+ *          <p>More than 2 processes are reading from the same streams shard at the same time.
+ *             Exceeding this limit may result in request throttling.</p>
+ *
+ * @throws {@link TableAlreadyExistsException} (client fault)
+ *  <p>A target table with the specified name already exists. </p>
+ *
+ * @throws {@link TableInUseException} (client fault)
+ *  <p>A target table with the specified name is either being created or deleted.
+ *         </p>
+ *
+ * @throws {@link DynamoDBServiceException}
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
+ *
+ *
+ * @public
+ */
+export declare class RestoreTableFromBackupCommand extends RestoreTableFromBackupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RestoreTableFromBackupInput;
+            output: RestoreTableFromBackupOutput;
+        };
+        sdk: {
+            input: RestoreTableFromBackupCommandInput;
+            output: RestoreTableFromBackupCommandOutput;
+        };
+    };
+}