@aws-sdk/client-keyspacesstreams 3.838.0

package/dist-types/KeyspacesStreamsClient.d.ts

@@ -0,0 +1,191 @@
+import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
+import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
+import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
+import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
+import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
+import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
+import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
+import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
+import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
+import { GetRecordsCommandInput, GetRecordsCommandOutput } from "./commands/GetRecordsCommand";
+import { GetShardIteratorCommandInput, GetShardIteratorCommandOutput } from "./commands/GetShardIteratorCommand";
+import { GetStreamCommandInput, GetStreamCommandOutput } from "./commands/GetStreamCommand";
+import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand";
+import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
+export { __Client };
+/**
+ * @public
+ */
+export type ServiceInputTypes = GetRecordsCommandInput | GetShardIteratorCommandInput | GetStreamCommandInput | ListStreamsCommandInput;
+/**
+ * @public
+ */
+export type ServiceOutputTypes = GetRecordsCommandOutput | GetShardIteratorCommandOutput | GetStreamCommandOutput | ListStreamsCommandOutput;
+/**
+ * @public
+ */
+export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
+    /**
+     * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
+     */
+    requestHandler?: __HttpHandlerUserInput;
+    /**
+     * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
+     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
+     * @internal
+     */
+    sha256?: __ChecksumConstructor | __HashConstructor;
+    /**
+     * The function that will be used to convert strings into HTTP endpoints.
+     * @internal
+     */
+    urlParser?: __UrlParser;
+    /**
+     * A function that can calculate the length of a request body.
+     * @internal
+     */
+    bodyLengthChecker?: __BodyLengthCalculator;
+    /**
+     * A function that converts a stream into an array of bytes.
+     * @internal
+     */
+    streamCollector?: __StreamCollector;
+    /**
+     * The function that will be used to convert a base64-encoded string to a byte array.
+     * @internal
+     */
+    base64Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a base64-encoded string.
+     * @internal
+     */
+    base64Encoder?: __Encoder;
+    /**
+     * The function that will be used to convert a UTF8-encoded string to a byte array.
+     * @internal
+     */
+    utf8Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a UTF-8 encoded string.
+     * @internal
+     */
+    utf8Encoder?: __Encoder;
+    /**
+     * The runtime environment.
+     * @internal
+     */
+    runtime?: string;
+    /**
+     * Disable dynamically changing the endpoint of the client based on the hostPrefix
+     * trait of an operation.
+     */
+    disableHostPrefix?: boolean;
+    /**
+     * Unique service identifier.
+     * @internal
+     */
+    serviceId?: string;
+    /**
+     * Enables IPv6/IPv4 dualstack endpoint.
+     */
+    useDualstackEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * Enables FIPS compatible endpoints.
+     */
+    useFipsEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * The AWS region to which this client will send requests
+     */
+    region?: string | __Provider<string>;
+    /**
+     * Setting a client profile is similar to setting a value for the
+     * AWS_PROFILE environment variable. Setting a profile on a client
+     * in code only affects the single client instance, unlike AWS_PROFILE.
+     *
+     * When set, and only for environments where an AWS configuration
+     * file exists, fields configurable by this file will be retrieved
+     * from the specified profile within that file.
+     * Conflicting code configuration and environment variables will
+     * still have higher priority.
+     *
+     * For client credential resolution that involves checking the AWS
+     * configuration file, the client's profile (this value) will be
+     * used unless a different profile is set in the credential
+     * provider options.
+     *
+     */
+    profile?: string;
+    /**
+     * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+     * @internal
+     */
+    defaultUserAgentProvider?: Provider<__UserAgent>;
+    /**
+     * Default credentials provider; Not available in browser runtime.
+     * @deprecated
+     * @internal
+     */
+    credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
+    /**
+     * Value for how many times a request will be made at most in case of retry.
+     */
+    maxAttempts?: number | __Provider<number>;
+    /**
+     * Specifies which retry algorithm to use.
+     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
+     *
+     */
+    retryMode?: string | __Provider<string>;
+    /**
+     * Optional logger for logging debug/info/warn/error.
+     */
+    logger?: __Logger;
+    /**
+     * Optional extensions
+     */
+    extensions?: RuntimeExtension[];
+    /**
+     * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
+}
+/**
+ * @public
+ */
+export type KeyspacesStreamsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig<EndpointParameters> & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
+/**
+ * @public
+ *
+ *  The configuration interface of KeyspacesStreamsClient class constructor that set the region, credentials and other options.
+ */
+export interface KeyspacesStreamsClientConfig extends KeyspacesStreamsClientConfigType {
+}
+/**
+ * @public
+ */
+export type KeyspacesStreamsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & RegionResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
+/**
+ * @public
+ *
+ *  The resolved configuration interface of KeyspacesStreamsClient class. This is resolved and normalized from the {@link KeyspacesStreamsClientConfig | constructor configuration interface}.
+ */
+export interface KeyspacesStreamsClientResolvedConfig extends KeyspacesStreamsClientResolvedConfigType {
+}
+/**
+ * <p>Amazon Keyspaces (for Apache Cassandra) change data capture (CDC) records change events for Amazon Keyspaces tables. The change events captured in a stream are time-ordered and de-duplicated write operations. Using stream data you can build event driven applications that incorporate near-real time change events from Amazon Keyspaces tables. </p> <p>Amazon Keyspaces CDC is serverless and scales the infrastructure for change events automatically based on the volume of changes on your table. </p> <p> This API reference describes the Amazon Keyspaces CDC stream API in detail. </p> <p>For more information about Amazon Keyspaces CDC, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cdc.html">Working with change data capture (CDC) streams in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To learn how Amazon Keyspaces CDC API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To see the metrics Amazon Keyspaces CDC sends to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/metrics-dimensions.html#keyspaces-cdc-metrics">Amazon Keyspaces change data capture (CDC) CloudWatch metrics</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
+ * @public
+ */
+export declare class KeyspacesStreamsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KeyspacesStreamsClientResolvedConfig> {
+    /**
+     * The resolved configuration of KeyspacesStreamsClient class. This is resolved and normalized from the {@link KeyspacesStreamsClientConfig | constructor configuration interface}.
+     */
+    readonly config: KeyspacesStreamsClientResolvedConfig;
+    constructor(...[configuration]: __CheckOptionalClientConfig<KeyspacesStreamsClientConfig>);
+    /**
+     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+     */
+    destroy(): void;
+}

package/dist-types/auth/httpAuthExtensionConfiguration.d.ts

@@ -0,0 +1,29 @@
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
+import { KeyspacesStreamsHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
+/**
+ * @internal
+ */
+export interface HttpAuthExtensionConfiguration {
+    setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
+    httpAuthSchemes(): HttpAuthScheme[];
+    setHttpAuthSchemeProvider(httpAuthSchemeProvider: KeyspacesStreamsHttpAuthSchemeProvider): void;
+    httpAuthSchemeProvider(): KeyspacesStreamsHttpAuthSchemeProvider;
+    setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
+    credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
+}
+/**
+ * @internal
+ */
+export type HttpAuthRuntimeConfig = Partial<{
+    httpAuthSchemes: HttpAuthScheme[];
+    httpAuthSchemeProvider: KeyspacesStreamsHttpAuthSchemeProvider;
+    credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+}>;
+/**
+ * @internal
+ */
+export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -0,0 +1,75 @@
+import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
+import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
+import { KeyspacesStreamsClientResolvedConfig } from "../KeyspacesStreamsClient";
+/**
+ * @internal
+ */
+export interface KeyspacesStreamsHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
+    region?: string;
+}
+/**
+ * @internal
+ */
+export interface KeyspacesStreamsHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<KeyspacesStreamsClientResolvedConfig, HandlerExecutionContext, KeyspacesStreamsHttpAuthSchemeParameters, object> {
+}
+/**
+ * @internal
+ */
+export declare const defaultKeyspacesStreamsHttpAuthSchemeParametersProvider: (config: KeyspacesStreamsClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<KeyspacesStreamsHttpAuthSchemeParameters>;
+/**
+ * @internal
+ */
+export interface KeyspacesStreamsHttpAuthSchemeProvider extends HttpAuthSchemeProvider<KeyspacesStreamsHttpAuthSchemeParameters> {
+}
+/**
+ * @internal
+ */
+export declare const defaultKeyspacesStreamsHttpAuthSchemeProvider: KeyspacesStreamsHttpAuthSchemeProvider;
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    authSchemePreference?: string[] | Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    httpAuthSchemes?: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    httpAuthSchemeProvider?: KeyspacesStreamsHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    readonly authSchemePreference: Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    readonly httpAuthSchemes: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    readonly httpAuthSchemeProvider: KeyspacesStreamsHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;

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

@@ -0,0 +1,228 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesStreamsClient";
+import { GetRecordsInput, GetRecordsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetRecordsCommand}.
+ */
+export interface GetRecordsCommandInput extends GetRecordsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetRecordsCommand}.
+ */
+export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBearer {
+}
+declare const GetRecordsCommand_base: {
+    new (input: GetRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecordsCommandInput, GetRecordsCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecordsCommandInput, GetRecordsCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KeyspacesStreamsClient, GetRecordsCommand } from "@aws-sdk/client-keyspacesstreams"; // ES Modules import
+ * // const { KeyspacesStreamsClient, GetRecordsCommand } = require("@aws-sdk/client-keyspacesstreams"); // CommonJS import
+ * const client = new KeyspacesStreamsClient(config);
+ * const input = { // GetRecordsInput
+ *   shardIterator: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ * };
+ * const command = new GetRecordsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetRecordsOutput
+ * //   changeRecords: [ // RecordList
+ * //     { // Record
+ * //       eventVersion: "STRING_VALUE",
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       origin: "USER" || "REPLICATION" || "TTL",
+ * //       partitionKeys: { // KeyspacesKeysMap
+ * //         "<keys>": { // KeyspacesCellValue Union: only one key present
+ * //           asciiT: "STRING_VALUE",
+ * //           bigintT: "STRING_VALUE",
+ * //           blobT: new Uint8Array(),
+ * //           boolT: true || false,
+ * //           counterT: "STRING_VALUE",
+ * //           dateT: "STRING_VALUE",
+ * //           decimalT: "STRING_VALUE",
+ * //           doubleT: "STRING_VALUE",
+ * //           floatT: "STRING_VALUE",
+ * //           inetT: "STRING_VALUE",
+ * //           intT: "STRING_VALUE",
+ * //           listT: [ // KeyspacesCellList
+ * //             { // KeyspacesCell
+ * //               value: {//  Union: only one key present
+ * //                 asciiT: "STRING_VALUE",
+ * //                 bigintT: "STRING_VALUE",
+ * //                 blobT: new Uint8Array(),
+ * //                 boolT: true || false,
+ * //                 counterT: "STRING_VALUE",
+ * //                 dateT: "STRING_VALUE",
+ * //                 decimalT: "STRING_VALUE",
+ * //                 doubleT: "STRING_VALUE",
+ * //                 floatT: "STRING_VALUE",
+ * //                 inetT: "STRING_VALUE",
+ * //                 intT: "STRING_VALUE",
+ * //                 listT: [
+ * //                   {
+ * //                     value: "<KeyspacesCellValue>",
+ * //                     metadata: { // KeyspacesMetadata
+ * //                       expirationTime: "STRING_VALUE",
+ * //                       writeTime: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                 ],
+ * //                 mapT: [ // KeyspacesCellMap
+ * //                   { // KeyspacesCellMapDefinition
+ * //                     key: "<KeyspacesCellValue>",
+ * //                     value: "<KeyspacesCellValue>",
+ * //                     metadata: {
+ * //                       expirationTime: "STRING_VALUE",
+ * //                       writeTime: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                 ],
+ * //                 setT: [
+ * //                   {
+ * //                     value: "<KeyspacesCellValue>",
+ * //                     metadata: {
+ * //                       expirationTime: "STRING_VALUE",
+ * //                       writeTime: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                 ],
+ * //                 smallintT: "STRING_VALUE",
+ * //                 textT: "STRING_VALUE",
+ * //                 timeT: "STRING_VALUE",
+ * //                 timestampT: "STRING_VALUE",
+ * //                 timeuuidT: "STRING_VALUE",
+ * //                 tinyintT: "STRING_VALUE",
+ * //                 tupleT: [
+ * //                   {
+ * //                     value: "<KeyspacesCellValue>",
+ * //                     metadata: {
+ * //                       expirationTime: "STRING_VALUE",
+ * //                       writeTime: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                 ],
+ * //                 uuidT: "STRING_VALUE",
+ * //                 varcharT: "STRING_VALUE",
+ * //                 varintT: "STRING_VALUE",
+ * //                 udtT: { // KeyspacesUdtMap
+ * //                   "<keys>": {
+ * //                     value: "<KeyspacesCellValue>",
+ * //                     metadata: {
+ * //                       expirationTime: "STRING_VALUE",
+ * //                       writeTime: "STRING_VALUE",
+ * //                     },
+ * //                   },
+ * //                 },
+ * //               },
+ * //               metadata: "<KeyspacesMetadata>",
+ * //             },
+ * //           ],
+ * //           mapT: [
+ * //             {
+ * //               key: "<KeyspacesCellValue>",
+ * //               value: "<KeyspacesCellValue>",
+ * //               metadata: "<KeyspacesMetadata>",
+ * //             },
+ * //           ],
+ * //           setT: [
+ * //             "<KeyspacesCell>",
+ * //           ],
+ * //           smallintT: "STRING_VALUE",
+ * //           textT: "STRING_VALUE",
+ * //           timeT: "STRING_VALUE",
+ * //           timestampT: "STRING_VALUE",
+ * //           timeuuidT: "STRING_VALUE",
+ * //           tinyintT: "STRING_VALUE",
+ * //           tupleT: "<KeyspacesCellList>",
+ * //           uuidT: "STRING_VALUE",
+ * //           varcharT: "STRING_VALUE",
+ * //           varintT: "STRING_VALUE",
+ * //           udtT: {
+ * //             "<keys>": "<KeyspacesCell>",
+ * //           },
+ * //         },
+ * //       },
+ * //       clusteringKeys: {
+ * //         "<keys>": "<KeyspacesCellValue>",
+ * //       },
+ * //       newImage: { // KeyspacesRow
+ * //         valueCells: { // KeyspacesCells
+ * //           "<keys>": "<KeyspacesCell>",
+ * //         },
+ * //         staticCells: {
+ * //           "<keys>": "<KeyspacesCell>",
+ * //         },
+ * //         rowMetadata: "<KeyspacesMetadata>",
+ * //       },
+ * //       oldImage: {
+ * //         valueCells: {
+ * //           "<keys>": "<KeyspacesCell>",
+ * //         },
+ * //         staticCells: {
+ * //           "<keys>": "<KeyspacesCell>",
+ * //         },
+ * //         rowMetadata: "<KeyspacesMetadata>",
+ * //       },
+ * //       sequenceNumber: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextShardIterator: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetRecordsCommandInput - {@link GetRecordsCommandInput}
+ * @returns {@link GetRecordsCommandOutput}
+ * @see {@link GetRecordsCommandInput} for command's `input` shape.
+ * @see {@link GetRecordsCommandOutput} for command's `response` shape.
+ * @see {@link KeyspacesStreamsClientResolvedConfig | config} for KeyspacesStreamsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access permissions to perform this operation. </p> <p>This exception occurs when your IAM user or role lacks the required permissions to access the Amazon Keyspaces resource or perform the requested action. Check your IAM policies and ensure they grant the necessary permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The Amazon Keyspaces service encountered an unexpected error while processing the request. </p> <p>This internal server error is not related to your request parameters. Retry your request after a brief delay. If the issue persists, contact Amazon Web Services Support with details of your request to help identify and resolve the problem.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource doesn't exist or could not be found. </p> <p>This exception occurs when you attempt to access a keyspace, table, stream, or other Amazon Keyspaces resource that doesn't exist or that has been deleted. Verify that the resource identifier is correct and that the resource exists in your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request rate is too high and exceeds the service's throughput limits. </p> <p>This exception occurs when you send too many requests in a short period of time. Implement exponential backoff in your retry strategy to handle this exception. Reducing your request frequency or distributing requests more evenly can help avoid throughput exceptions.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation failed because one or more input parameters failed validation. </p> <p>This exception occurs when there are syntax errors in the request, field constraints are violated, or required parameters are missing. To help you fix the issue, the exception message provides details about which parameter failed and why.</p>
+ *
+ * @throws {@link KeyspacesStreamsServiceException}
+ * <p>Base exception class for all service exceptions from KeyspacesStreams service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetRecordsCommand extends GetRecordsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetRecordsInput;
+            output: GetRecordsOutput;
+        };
+        sdk: {
+            input: GetRecordsCommandInput;
+            output: GetRecordsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesStreamsClient";
+import { GetShardIteratorInput, GetShardIteratorOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetShardIteratorCommand}.
+ */
+export interface GetShardIteratorCommandInput extends GetShardIteratorInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetShardIteratorCommand}.
+ */
+export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, __MetadataBearer {
+}
+declare const GetShardIteratorCommand_base: {
+    new (input: GetShardIteratorCommandInput): import("@smithy/smithy-client").CommandImpl<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetShardIteratorCommandInput): import("@smithy/smithy-client").CommandImpl<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard. The shard iterator specifies the shard position from which to start reading data records sequentially. You can specify whether to begin reading at the latest record, the oldest record, or at a particular sequence number within the shard.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KeyspacesStreamsClient, GetShardIteratorCommand } from "@aws-sdk/client-keyspacesstreams"; // ES Modules import
+ * // const { KeyspacesStreamsClient, GetShardIteratorCommand } = require("@aws-sdk/client-keyspacesstreams"); // CommonJS import
+ * const client = new KeyspacesStreamsClient(config);
+ * const input = { // GetShardIteratorInput
+ *   streamArn: "STRING_VALUE", // required
+ *   shardId: "STRING_VALUE", // required
+ *   shardIteratorType: "TRIM_HORIZON" || "LATEST" || "AT_SEQUENCE_NUMBER" || "AFTER_SEQUENCE_NUMBER", // required
+ *   sequenceNumber: "STRING_VALUE",
+ * };
+ * const command = new GetShardIteratorCommand(input);
+ * const response = await client.send(command);
+ * // { // GetShardIteratorOutput
+ * //   shardIterator: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetShardIteratorCommandInput - {@link GetShardIteratorCommandInput}
+ * @returns {@link GetShardIteratorCommandOutput}
+ * @see {@link GetShardIteratorCommandInput} for command's `input` shape.
+ * @see {@link GetShardIteratorCommandOutput} for command's `response` shape.
+ * @see {@link KeyspacesStreamsClientResolvedConfig | config} for KeyspacesStreamsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access permissions to perform this operation. </p> <p>This exception occurs when your IAM user or role lacks the required permissions to access the Amazon Keyspaces resource or perform the requested action. Check your IAM policies and ensure they grant the necessary permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The Amazon Keyspaces service encountered an unexpected error while processing the request. </p> <p>This internal server error is not related to your request parameters. Retry your request after a brief delay. If the issue persists, contact Amazon Web Services Support with details of your request to help identify and resolve the problem.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource doesn't exist or could not be found. </p> <p>This exception occurs when you attempt to access a keyspace, table, stream, or other Amazon Keyspaces resource that doesn't exist or that has been deleted. Verify that the resource identifier is correct and that the resource exists in your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request rate is too high and exceeds the service's throughput limits. </p> <p>This exception occurs when you send too many requests in a short period of time. Implement exponential backoff in your retry strategy to handle this exception. Reducing your request frequency or distributing requests more evenly can help avoid throughput exceptions.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation failed because one or more input parameters failed validation. </p> <p>This exception occurs when there are syntax errors in the request, field constraints are violated, or required parameters are missing. To help you fix the issue, the exception message provides details about which parameter failed and why.</p>
+ *
+ * @throws {@link KeyspacesStreamsServiceException}
+ * <p>Base exception class for all service exceptions from KeyspacesStreams service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetShardIteratorCommand extends GetShardIteratorCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetShardIteratorInput;
+            output: GetShardIteratorOutput;
+        };
+        sdk: {
+            input: GetShardIteratorCommandInput;
+            output: GetShardIteratorCommandOutput;
+        };
+    };
+}