@aws-sdk/client-simpledbv2 3.1007.0

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

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListExportsRequest, ListExportsResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SimpleDBv2ClientResolvedConfig } from "../SimpleDBv2Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListExportsCommand}.
+ */
+export interface ListExportsCommandInput extends ListExportsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListExportsCommand}.
+ */
+export interface ListExportsCommandOutput extends ListExportsResponse, __MetadataBearer {
+}
+declare const ListExportsCommand_base: {
+    new (input: ListExportsCommandInput): import("@smithy/smithy-client").CommandImpl<ListExportsCommandInput, ListExportsCommandOutput, SimpleDBv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListExportsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListExportsCommandInput, ListExportsCommandOutput, SimpleDBv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Lists all exports that were created. The results are paginated and can be filtered by domain name.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SimpleDBv2Client, ListExportsCommand } from "@aws-sdk/client-simpledbv2"; // ES Modules import
+ * // const { SimpleDBv2Client, ListExportsCommand } = require("@aws-sdk/client-simpledbv2"); // CommonJS import
+ * // import type { SimpleDBv2ClientConfig } from "@aws-sdk/client-simpledbv2";
+ * const config = {}; // type is SimpleDBv2ClientConfig
+ * const client = new SimpleDBv2Client(config);
+ * const input = { // ListExportsRequest
+ *   domainName: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListExportsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListExportsResponse
+ * //   exportSummaries: [ // ExportSummaries // required
+ * //     { // ExportSummary
+ * //       exportArn: "STRING_VALUE", // required
+ * //       exportStatus: "PENDING" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED", // required
+ * //       requestedAt: new Date("TIMESTAMP"), // required
+ * //       domainName: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListExportsCommandInput - {@link ListExportsCommandInput}
+ * @returns {@link ListExportsCommandOutput}
+ * @see {@link ListExportsCommandInput} for command's `input` shape.
+ * @see {@link ListExportsCommandOutput} for command's `response` shape.
+ * @see {@link SimpleDBv2ClientResolvedConfig | config} for SimpleDBv2Client's `config` shape.
+ *
+ * @throws {@link InvalidNextTokenException} (client fault)
+ *  The specified next token is not valid.
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  The specified parameter value is not valid.
+ *
+ * @throws {@link NoSuchDomainException} (client fault)
+ *  The specified domain does not exist.
+ *
+ * @throws {@link SimpleDBv2ServiceException}
+ * <p>Base exception class for all service exceptions from SimpleDBv2 service.</p>
+ *
+ *
+ * @example List all exports
+ * ```javascript
+ * //
+ * const input = { /* empty *\/ };
+ * const command = new ListExportsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   exportSummaries: [
+ *     {
+ *       domainName: "my-domain",
+ *       exportArn: "arn:aws:sdb:us-east-1:123456789012:export/abc123",
+ *       exportStatus: "SUCCEEDED",
+ *       requestedAt: 1234567890
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListExportsCommand extends ListExportsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListExportsRequest;
+            output: ListExportsResponse;
+        };
+        sdk: {
+            input: ListExportsCommandInput;
+            output: ListExportsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,115 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { StartDomainExportRequest, StartDomainExportResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SimpleDBv2ClientResolvedConfig } from "../SimpleDBv2Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartDomainExportCommand}.
+ */
+export interface StartDomainExportCommandInput extends StartDomainExportRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartDomainExportCommand}.
+ */
+export interface StartDomainExportCommandOutput extends StartDomainExportResponse, __MetadataBearer {
+}
+declare const StartDomainExportCommand_base: {
+    new (input: StartDomainExportCommandInput): import("@smithy/smithy-client").CommandImpl<StartDomainExportCommandInput, StartDomainExportCommandOutput, SimpleDBv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartDomainExportCommandInput): import("@smithy/smithy-client").CommandImpl<StartDomainExportCommandInput, StartDomainExportCommandOutput, SimpleDBv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Initiates the export of a SimpleDB domain to an S3 bucket.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SimpleDBv2Client, StartDomainExportCommand } from "@aws-sdk/client-simpledbv2"; // ES Modules import
+ * // const { SimpleDBv2Client, StartDomainExportCommand } = require("@aws-sdk/client-simpledbv2"); // CommonJS import
+ * // import type { SimpleDBv2ClientConfig } from "@aws-sdk/client-simpledbv2";
+ * const config = {}; // type is SimpleDBv2ClientConfig
+ * const client = new SimpleDBv2Client(config);
+ * const input = { // StartDomainExportRequest
+ *   clientToken: "STRING_VALUE",
+ *   domainName: "STRING_VALUE", // required
+ *   s3Bucket: "STRING_VALUE", // required
+ *   s3KeyPrefix: "STRING_VALUE",
+ *   s3SseAlgorithm: "AES256" || "KMS",
+ *   s3SseKmsKeyId: "STRING_VALUE",
+ *   s3BucketOwner: "STRING_VALUE",
+ * };
+ * const command = new StartDomainExportCommand(input);
+ * const response = await client.send(command);
+ * // { // StartDomainExportResponse
+ * //   clientToken: "STRING_VALUE", // required
+ * //   exportArn: "STRING_VALUE", // required
+ * //   requestedAt: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartDomainExportCommandInput - {@link StartDomainExportCommandInput}
+ * @returns {@link StartDomainExportCommandOutput}
+ * @see {@link StartDomainExportCommandInput} for command's `input` shape.
+ * @see {@link StartDomainExportCommandOutput} for command's `response` shape.
+ * @see {@link SimpleDBv2ClientResolvedConfig | config} for SimpleDBv2Client's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  Indicates a conflict with one or more parameters of the request.
+ *
+ * @throws {@link InvalidParameterCombinationException} (client fault)
+ *  Parameters that must not be used together were used together in the request.
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  The specified parameter value is not valid.
+ *
+ * @throws {@link NoSuchDomainException} (client fault)
+ *  The specified domain does not exist.
+ *
+ * @throws {@link NumberExportsLimitExceeded} (client fault)
+ *  Cannot start export as export quota limit was exceeded
+ *
+ * @throws {@link SimpleDBv2ServiceException}
+ * <p>Base exception class for all service exceptions from SimpleDBv2 service.</p>
+ *
+ *
+ * @example Start a domain export
+ * ```javascript
+ * //
+ * const input = {
+ *   domainName: "my-domain",
+ *   s3Bucket: "my-export-bucket"
+ * };
+ * const command = new StartDomainExportCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   clientToken: "abc123-def456-ghi789",
+ *   exportArn: "arn:aws:sdb:us-east-1:123456789012:export/abc123",
+ *   requestedAt: 1234567890
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class StartDomainExportCommand extends StartDomainExportCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartDomainExportRequest;
+            output: StartDomainExportResponse;
+        };
+        sdk: {
+            input: StartDomainExportCommandInput;
+            output: StartDomainExportCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,3 @@
+export * from "./GetExportCommand";
+export * from "./ListExportsCommand";
+export * from "./StartDomainExportCommand";

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

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

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

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+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 type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface SimpleDBv2ExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Amazon SimpleDB is a web service providing the core database functions of data indexing and
+ *      querying in the cloud. By offloading the time and effort associated with building and operating a web-scale
+ *      database, SimpleDB provides developers the freedom to focus on application development.
+ *
+ *      A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design,
+ *      and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler,
+ *      requiring no schema, automatically indexing your data and providing a simple API for storage and access.
+ *      This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning.
+ *      Developers gain access to this functionality within Amazon's proven computing environment, are able to scale
+ *      instantly, and pay only for what they use.
+ *
+ * @packageDocumentation
+ */
+export * from "./SimpleDBv2Client";
+export * from "./SimpleDBv2";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { SimpleDBv2ExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./waiters";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { SimpleDBv2ServiceException } from "./models/SimpleDBv2ServiceException";

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

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

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

@@ -0,0 +1,26 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ExportStatus: {
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly PENDING: "PENDING";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type ExportStatus = (typeof ExportStatus)[keyof typeof ExportStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const S3SseAlgorithm: {
+    readonly AES256: "AES256";
+    readonly KMS: "KMS";
+};
+/**
+ * @public
+ */
+export type S3SseAlgorithm = (typeof S3SseAlgorithm)[keyof typeof S3SseAlgorithm];

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

@@ -0,0 +1,86 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { SimpleDBv2ServiceException as __BaseException } from "./SimpleDBv2ServiceException";
+/**
+ * Indicates a conflict with one or more parameters of the request.
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * The specified parameter value is not valid.
+ * @public
+ */
+export declare class InvalidParameterValueException extends __BaseException {
+    readonly name: "InvalidParameterValueException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
+}
+/**
+ * Export with specified ARN does not exist.
+ * @public
+ */
+export declare class NoSuchExportException extends __BaseException {
+    readonly name: "NoSuchExportException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NoSuchExportException, __BaseException>);
+}
+/**
+ * The specified next token is not valid.
+ * @public
+ */
+export declare class InvalidNextTokenException extends __BaseException {
+    readonly name: "InvalidNextTokenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
+}
+/**
+ * Parameters that must not be used together were used together in the request.
+ * @public
+ */
+export declare class InvalidParameterCombinationException extends __BaseException {
+    readonly name: "InvalidParameterCombinationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterCombinationException, __BaseException>);
+}
+/**
+ * The specified domain does not exist.
+ * @public
+ */
+export declare class NoSuchDomainException extends __BaseException {
+    readonly name: "NoSuchDomainException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NoSuchDomainException, __BaseException>);
+}
+/**
+ * Cannot start export as export quota limit was exceeded
+ * @public
+ */
+export declare class NumberExportsLimitExceeded extends __BaseException {
+    readonly name: "NumberExportsLimitExceeded";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NumberExportsLimitExceeded, __BaseException>);
+}