@aws-sdk/client-dynamodb

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; }; /** * This operation allows you to perform reads and singleton writes on data stored in * DynamoDB, using PartiQL. * 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. * 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>. * @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) * A condition specified in the operation failed to be evaluated. * * @throws {@link DuplicateItemException} (client fault) * There was an attempt to insert an item with the same primary key as an item that * already exists in the DynamoDB table. * * @throws {@link InternalServerError} (server fault) * An error occurred on the server side. * * @throws {@link ItemCollectionSizeLimitExceededException} (client fault) * An item collection is too large. This exception is only returned for tables that * have one or more local secondary indexes. * * @throws {@link ProvisionedThroughputExceededException} (client fault) * The request was denied due to request throttling. For detailed information about * why the request was throttled and the ARN of the impacted resource, find the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html">ThrottlingReason</a> field in the returned exception. The Amazon Web Services * SDKs for DynamoDB automatically retry requests that receive this exception. * Your request is eventually successful, unless your retry queue is too large to finish. * Reduce the frequency of requests and use exponential backoff. For more information, go * to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide. * * @throws {@link RequestLimitExceeded} (client fault) * 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. * * @throws {@link ResourceNotFoundException} (client fault) * 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>. * * @throws {@link ThrottlingException} (client fault) * 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. * * @throws {@link TransactionConflictException} (client fault) * Operation was rejected because there is an ongoing transaction for the * item. * * @throws {@link DynamoDBServiceException} * Base exception class for all service exceptions from DynamoDB service. * * * @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; }; }; }