@aws-sdk/client-dynamodb 3.51.0 → 3.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -585,6 +585,16 @@ export declare class DynamoDB extends DynamoDBClient {
585
585
  /**
586
586
  * <p>This operation allows you to perform reads and singleton writes on data stored in
587
587
  * DynamoDB, using PartiQL.</p>
588
+ * <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
589
+ * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
590
+ * returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a
591
+ * subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match
592
+ * any data, the read will return an empty result set.</p>
593
+ * <p>A single <code>SELECT</code> statement response can return up to the maximum number of
594
+ * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
595
+ * filtering to the results using <code>WHERE</code> clause). If
596
+ * <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
597
+ * result set.</p>
588
598
  */
589
599
  executeStatement(args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteStatementCommandOutput>;
590
600
  executeStatement(args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
@@ -6,7 +6,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
6
6
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
7
7
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
8
8
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
9
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
10
10
  import { BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput } from "./commands/BatchExecuteStatementCommand";
11
11
  import { BatchGetItemCommandInput, BatchGetItemCommandOutput } from "./commands/BatchGetItemCommand";
12
12
  import { BatchWriteItemCommandInput, BatchWriteItemCommandOutput } from "./commands/BatchWriteItemCommand";
@@ -79,7 +79,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
79
79
  * A function that can calculate the length of a request body.
80
80
  * @internal
81
81
  */
82
- bodyLengthChecker?: (body: any) => number | undefined;
82
+ bodyLengthChecker?: __BodyLengthCalculator;
83
83
  /**
84
84
  * A function that converts a stream into an array of bytes.
85
85
  * @internal
@@ -9,6 +9,16 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
9
9
  /**
10
10
  * <p>This operation allows you to perform reads and singleton writes on data stored in
11
11
  * DynamoDB, using PartiQL.</p>
12
+ * <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
13
+ * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
14
+ * returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a
15
+ * subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match
16
+ * any data, the read will return an empty result set.</p>
17
+ * <p>A single <code>SELECT</code> statement response can return up to the maximum number of
18
+ * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
19
+ * filtering to the results using <code>WHERE</code> clause). If
20
+ * <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
21
+ * result set.</p>
12
22
  * @example
13
23
  * Use a bare-bones client and the command you need to make an API call.
14
24
  * ```javascript
@@ -4,3 +4,4 @@ export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
6
  export * from "./waiters";
7
+ export { DynamoDBServiceException } from "./models/DynamoDBServiceException";
@@ -0,0 +1,10 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * Base exception class for all service exceptions from DynamoDB service.
4
+ */
5
+ export declare class DynamoDBServiceException extends __ServiceException {
6
+ /**
7
+ * @internal
8
+ */
9
+ constructor(options: __ServiceExceptionOptions);
10
+ }