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

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

@@ -0,0 +1,130 @@
+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 { KinesisStreamingDestinationInput, KinesisStreamingDestinationOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link EnableKinesisStreamingDestinationCommand}.
+ */
+export interface EnableKinesisStreamingDestinationCommandInput extends KinesisStreamingDestinationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link EnableKinesisStreamingDestinationCommand}.
+ */
+export interface EnableKinesisStreamingDestinationCommandOutput extends KinesisStreamingDestinationOutput, __MetadataBearer {
+}
+declare const EnableKinesisStreamingDestinationCommand_base: {
+    new (input: EnableKinesisStreamingDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKinesisStreamingDestinationCommandInput, EnableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: EnableKinesisStreamingDestinationCommandInput): import("@smithy/smithy-client").CommandImpl<EnableKinesisStreamingDestinationCommandInput, EnableKinesisStreamingDestinationCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <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
+ *             is ACTIVE.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DynamoDBClient, EnableKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
+ * // const { DynamoDBClient, EnableKinesisStreamingDestinationCommand } = 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 = { // KinesisStreamingDestinationInput
+ *   TableName: "STRING_VALUE", // required
+ *   StreamArn: "STRING_VALUE", // required
+ *   EnableKinesisStreamingConfiguration: { // EnableKinesisStreamingConfiguration
+ *     ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND",
+ *   },
+ * };
+ * const command = new EnableKinesisStreamingDestinationCommand(input);
+ * const response = await client.send(command);
+ * // { // KinesisStreamingDestinationOutput
+ * //   TableName: "STRING_VALUE",
+ * //   StreamArn: "STRING_VALUE",
+ * //   DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED" || "UPDATING",
+ * //   EnableKinesisStreamingConfiguration: { // EnableKinesisStreamingConfiguration
+ * //     ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param EnableKinesisStreamingDestinationCommandInput - {@link EnableKinesisStreamingDestinationCommandInput}
+ * @returns {@link EnableKinesisStreamingDestinationCommandOutput}
+ * @see {@link EnableKinesisStreamingDestinationCommandInput} for command's `input` shape.
+ * @see {@link EnableKinesisStreamingDestinationCommandOutput} for command's `response` shape.
+ * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link InvalidEndpointException} (client fault)
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
+ *          <p>For most purposes, up to 500 simultaneous table operations are allowed per account.
+ *             These operations include <code>CreateTable</code>, <code>UpdateTable</code>,
+ *                 <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
+ *                 <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
+ *          <p>When you are creating a table with one or more secondary indexes, you can have up
+ *             to 250 such requests running at a time. However, if the table or index specifications
+ *             are complex, then DynamoDB might temporarily reduce the number of concurrent
+ *             operations.</p>
+ *          <p>When importing into DynamoDB, up to 50 simultaneous import table operations are
+ *             allowed per account.</p>
+ *          <p>There is a soft account quota of 2,500 tables.</p>
+ *          <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 ResourceInUseException} (client fault)
+ *  <p>The operation conflicts with the resource's availability. For example:</p>
+ *          <ul>
+ *             <li>
+ *                <p>You attempted to recreate an existing table.</p>
+ *             </li>
+ *             <li>
+ *                <p>You tried to delete a table currently in the <code>CREATING</code>
+ *                     state.</p>
+ *             </li>
+ *             <li>
+ *                <p>You tried to update a resource that was already being updated.</p>
+ *             </li>
+ *          </ul>
+ *          <p>When appropriate, wait for the ongoing update to complete and attempt the request
+ *             again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent table or index. The resource might not
+ *             be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link DynamoDBServiceException}
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
+ *
+ *
+ * @public
+ */
+export declare class EnableKinesisStreamingDestinationCommand extends EnableKinesisStreamingDestinationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: KinesisStreamingDestinationInput;
+            output: KinesisStreamingDestinationOutput;
+        };
+        sdk: {
+            input: EnableKinesisStreamingDestinationCommandInput;
+            output: EnableKinesisStreamingDestinationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,251 @@
+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 { ExecuteStatementInput, ExecuteStatementOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ExecuteStatementCommand}.
+ */
+export interface ExecuteStatementCommandInput extends ExecuteStatementInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ExecuteStatementCommand}.
+ */
+export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, __MetadataBearer {
+}
+declare const ExecuteStatementCommand_base: {
+    new (input: ExecuteStatementCommandInput): import("@smithy/smithy-client").CommandImpl<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ExecuteStatementCommandInput): import("@smithy/smithy-client").CommandImpl<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <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
+ *             items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
+ *             returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a
+ *             subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match
+ *             any data, the read will return an empty result set.</p>
+ *          <p>A single <code>SELECT</code> statement response can return up to the maximum number of
+ *             items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
+ *             filtering to the results using <code>WHERE</code> clause). If
+ *                 <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
+ *             result set. If <code>NextToken</code> is present, you need to paginate the result set
+ *             and include <code>NextToken</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DynamoDBClient, ExecuteStatementCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
+ * // const { DynamoDBClient, ExecuteStatementCommand } = 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 = { // ExecuteStatementInput
+ *   Statement: "STRING_VALUE", // required
+ *   Parameters: [ // PreparedStatementParameters
+ *     { // AttributeValue Union: only one key present
+ *       S: "STRING_VALUE",
+ *       N: "STRING_VALUE",
+ *       B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *       SS: [ // StringSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *       NS: [ // NumberSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *       BS: [ // BinarySetAttributeValue
+ *         new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *       ],
+ *       M: { // MapAttributeValue
+ *         "<keys>": {//  Union: only one key present
+ *           S: "STRING_VALUE",
+ *           N: "STRING_VALUE",
+ *           B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *           SS: [
+ *             "STRING_VALUE",
+ *           ],
+ *           NS: [
+ *             "STRING_VALUE",
+ *           ],
+ *           BS: [
+ *             new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *           ],
+ *           M: {
+ *             "<keys>": "<AttributeValue>",
+ *           },
+ *           L: [ // ListAttributeValue
+ *             "<AttributeValue>",
+ *           ],
+ *           NULL: true || false,
+ *           BOOL: true || false,
+ *         },
+ *       },
+ *       L: [
+ *         "<AttributeValue>",
+ *       ],
+ *       NULL: true || false,
+ *       BOOL: true || false,
+ *     },
+ *   ],
+ *   ConsistentRead: true || false,
+ *   NextToken: "STRING_VALUE",
+ *   ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE",
+ *   Limit: Number("int"),
+ *   ReturnValuesOnConditionCheckFailure: "ALL_OLD" || "NONE",
+ * };
+ * const command = new ExecuteStatementCommand(input);
+ * const response = await client.send(command);
+ * // { // ExecuteStatementOutput
+ * //   Items: [ // ItemList
+ * //     { // AttributeMap
+ * //       "<keys>": { // AttributeValue Union: only one key present
+ * //         S: "STRING_VALUE",
+ * //         N: "STRING_VALUE",
+ * //         B: new Uint8Array(),
+ * //         SS: [ // StringSetAttributeValue
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         NS: [ // NumberSetAttributeValue
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         BS: [ // BinarySetAttributeValue
+ * //           new Uint8Array(),
+ * //         ],
+ * //         M: { // MapAttributeValue
+ * //           "<keys>": {//  Union: only one key present
+ * //             S: "STRING_VALUE",
+ * //             N: "STRING_VALUE",
+ * //             B: new Uint8Array(),
+ * //             SS: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             NS: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             BS: [
+ * //               new Uint8Array(),
+ * //             ],
+ * //             M: {
+ * //               "<keys>": "<AttributeValue>",
+ * //             },
+ * //             L: [ // ListAttributeValue
+ * //               "<AttributeValue>",
+ * //             ],
+ * //             NULL: true || false,
+ * //             BOOL: true || false,
+ * //           },
+ * //         },
+ * //         L: [
+ * //           "<AttributeValue>",
+ * //         ],
+ * //         NULL: true || false,
+ * //         BOOL: true || false,
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   ConsumedCapacity: { // ConsumedCapacity
+ * //     TableName: "STRING_VALUE",
+ * //     CapacityUnits: Number("double"),
+ * //     ReadCapacityUnits: Number("double"),
+ * //     WriteCapacityUnits: Number("double"),
+ * //     Table: { // Capacity
+ * //       ReadCapacityUnits: Number("double"),
+ * //       WriteCapacityUnits: Number("double"),
+ * //       CapacityUnits: Number("double"),
+ * //     },
+ * //     LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap
+ * //       "<keys>": {
+ * //         ReadCapacityUnits: Number("double"),
+ * //         WriteCapacityUnits: Number("double"),
+ * //         CapacityUnits: Number("double"),
+ * //       },
+ * //     },
+ * //     GlobalSecondaryIndexes: {
+ * //       "<keys>": {
+ * //         ReadCapacityUnits: Number("double"),
+ * //         WriteCapacityUnits: Number("double"),
+ * //         CapacityUnits: Number("double"),
+ * //       },
+ * //     },
+ * //   },
+ * //   LastEvaluatedKey: { // Key
+ * //     "<keys>": "<AttributeValue>",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param ExecuteStatementCommandInput - {@link ExecuteStatementCommandInput}
+ * @returns {@link ExecuteStatementCommandOutput}
+ * @see {@link ExecuteStatementCommandInput} for command's `input` shape.
+ * @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
+ * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
+ *
+ * @throws {@link ConditionalCheckFailedException} (client fault)
+ *  <p>A condition specified in the operation failed to be evaluated.</p>
+ *
+ * @throws {@link DuplicateItemException} (client fault)
+ *  <p> There was an attempt to insert an item with the same primary key as an item that
+ *             already exists in the DynamoDB table.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An error occurred on the server side.</p>
+ *
+ * @throws {@link ItemCollectionSizeLimitExceededException} (client fault)
+ *  <p>An item collection is too large. This exception is only returned for tables that
+ *             have one or more local secondary indexes.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>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 <i>Amazon DynamoDB Developer Guide</i>.</p>
+ *
+ * @throws {@link RequestLimitExceeded} (client fault)
+ *  <p>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.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access a nonexistent table or index. The resource might not
+ *             be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>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.</p>
+ *
+ * @throws {@link TransactionConflictException} (client fault)
+ *  <p>Operation was rejected because there is an ongoing transaction for the
+ *             item.</p>
+ *
+ * @throws {@link DynamoDBServiceException}
+ * <p>Base exception class for all service exceptions from DynamoDB service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ExecuteStatementCommand extends ExecuteStatementCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ExecuteStatementInput;
+            output: ExecuteStatementOutput;
+        };
+        sdk: {
+            input: ExecuteStatementCommandInput;
+            output: ExecuteStatementCommandOutput;
+        };
+    };
+}