@aws-sdk/client-keyspacesstreams 3.838.0

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

@@ -0,0 +1,112 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesStreamsClient";
+import { GetStreamInput, GetStreamOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetStreamCommand}.
+ */
+export interface GetStreamCommandInput extends GetStreamInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetStreamCommand}.
+ */
+export interface GetStreamCommandOutput extends GetStreamOutput, __MetadataBearer {
+}
+declare const GetStreamCommand_base: {
+    new (input: GetStreamCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamCommandInput, GetStreamCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetStreamCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamCommandInput, GetStreamCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream's Amazon Resource Name (ARN), creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KeyspacesStreamsClient, GetStreamCommand } from "@aws-sdk/client-keyspacesstreams"; // ES Modules import
+ * // const { KeyspacesStreamsClient, GetStreamCommand } = require("@aws-sdk/client-keyspacesstreams"); // CommonJS import
+ * const client = new KeyspacesStreamsClient(config);
+ * const input = { // GetStreamInput
+ *   streamArn: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   shardFilter: { // ShardFilter
+ *     type: "CHILD_SHARDS",
+ *     shardId: "STRING_VALUE",
+ *   },
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new GetStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // GetStreamOutput
+ * //   streamArn: "STRING_VALUE", // required
+ * //   streamLabel: "STRING_VALUE", // required
+ * //   streamStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED", // required
+ * //   streamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY", // required
+ * //   creationRequestDateTime: new Date("TIMESTAMP"), // required
+ * //   keyspaceName: "STRING_VALUE", // required
+ * //   tableName: "STRING_VALUE", // required
+ * //   shards: [ // ShardDescriptionList
+ * //     { // Shard
+ * //       shardId: "STRING_VALUE",
+ * //       sequenceNumberRange: { // SequenceNumberRange
+ * //         startingSequenceNumber: "STRING_VALUE",
+ * //         endingSequenceNumber: "STRING_VALUE",
+ * //       },
+ * //       parentShardIds: [ // ShardIdList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetStreamCommandInput - {@link GetStreamCommandInput}
+ * @returns {@link GetStreamCommandOutput}
+ * @see {@link GetStreamCommandInput} for command's `input` shape.
+ * @see {@link GetStreamCommandOutput} 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 GetStreamCommand extends GetStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetStreamInput;
+            output: GetStreamOutput;
+        };
+        sdk: {
+            input: GetStreamCommandInput;
+            output: GetStreamCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesStreamsClient";
+import { ListStreamsInput, ListStreamsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListStreamsCommand}.
+ */
+export interface ListStreamsCommandInput extends ListStreamsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListStreamsCommand}.
+ */
+export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataBearer {
+}
+declare const ListStreamsCommand_base: {
+    new (input: ListStreamsCommandInput): import("@smithy/smithy-client").CommandImpl<ListStreamsCommandInput, ListStreamsCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListStreamsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListStreamsCommandInput, ListStreamsCommandOutput, KeyspacesStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KeyspacesStreamsClient, ListStreamsCommand } from "@aws-sdk/client-keyspacesstreams"; // ES Modules import
+ * // const { KeyspacesStreamsClient, ListStreamsCommand } = require("@aws-sdk/client-keyspacesstreams"); // CommonJS import
+ * const client = new KeyspacesStreamsClient(config);
+ * const input = { // ListStreamsInput
+ *   keyspaceName: "STRING_VALUE",
+ *   tableName: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListStreamsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListStreamsOutput
+ * //   streams: [ // StreamList
+ * //     { // Stream
+ * //       streamArn: "STRING_VALUE", // required
+ * //       keyspaceName: "STRING_VALUE", // required
+ * //       tableName: "STRING_VALUE", // required
+ * //       streamLabel: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
+ * @returns {@link ListStreamsCommandOutput}
+ * @see {@link ListStreamsCommandInput} for command's `input` shape.
+ * @see {@link ListStreamsCommandOutput} 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 ListStreamsCommand extends ListStreamsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListStreamsInput;
+            output: ListStreamsOutput;
+        };
+        sdk: {
+            input: ListStreamsCommandInput;
+            output: ListStreamsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,4 @@
+export * from "./GetRecordsCommand";
+export * from "./GetShardIteratorCommand";
+export * from "./GetStreamCommand";
+export * from "./ListStreamsCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,32 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | undefined | Provider<string | undefined>;
+}
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+    Region?: string | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface KeyspacesStreamsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * <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>
+ *
+ * @packageDocumentation
+ */
+export * from "./KeyspacesStreamsClient";
+export * from "./KeyspacesStreams";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { KeyspacesStreamsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { KeyspacesStreamsServiceException } from "./models/KeyspacesStreamsServiceException";

package/dist-types/models/KeyspacesStreamsServiceException.d.ts

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from KeyspacesStreams service.
+ */
+export declare class KeyspacesStreamsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";