@aws-sdk/client-neptunedata 3.1158.0 → 3.1160.0

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

@@ -0,0 +1,126 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { StartIndexRebuildInput, StartIndexRebuildOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link StartIndexRebuildCommand}.
+ */
+export interface StartIndexRebuildCommandInput extends StartIndexRebuildInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartIndexRebuildCommand}.
+ */
+export interface StartIndexRebuildCommandOutput extends StartIndexRebuildOutput, __MetadataBearer {
+}
+declare const StartIndexRebuildCommand_base: {
+    new (input: StartIndexRebuildCommandInput): import("@smithy/core/client").CommandImpl<StartIndexRebuildCommandInput, StartIndexRebuildCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (...[input]: [] | [StartIndexRebuildCommandInput]): import("@smithy/core/client").CommandImpl<StartIndexRebuildCommandInput, StartIndexRebuildCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Initiates an index rebuild operation to optimize storage and improve query performance. The rebuild operation reorganizes index to reclaim space and improve efficiency.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startindexrebuild">neptune-db:StartIndexRebuild</a> IAM action in that cluster.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { NeptunedataClient, StartIndexRebuildCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
+ * // const { NeptunedataClient, StartIndexRebuildCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
+ * // import type { NeptunedataClientConfig } from "@aws-sdk/client-neptunedata";
+ * const config = {}; // type is NeptunedataClientConfig
+ * const client = new NeptunedataClient(config);
+ * const input = { // StartIndexRebuildInput
+ *   scope: "ALL" || "QUADS" || "DICTIONARIES",
+ *   concurrency: Number("int"),
+ *   writeBufferSize: "LOW" || "MEDIUM" || "HIGH",
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StartIndexRebuildCommand(input);
+ * const response = await client.send(command);
+ * // { // StartIndexRebuildOutput
+ * //   status: "PREPARING" || "REBUILDING" || "COMPLETED" || "FAILED" || "CANCELLED" || "CANCELLING", // required
+ * //   rebuildId: "STRING_VALUE", // required
+ * //   scope: "ALL" || "QUADS" || "DICTIONARIES", // required
+ * //   concurrency: Number("int"), // required
+ * //   writeBufferSize: "LOW" || "MEDIUM" || "HIGH", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartIndexRebuildCommandInput - {@link StartIndexRebuildCommandInput}
+ * @returns {@link StartIndexRebuildCommandOutput}
+ * @see {@link StartIndexRebuildCommandInput} for command's `input` shape.
+ * @see {@link StartIndexRebuildCommandOutput} for command's `response` shape.
+ * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Raised in case of an authentication or authorization failure.</p>
+ *
+ * @throws {@link ClientTimeoutException} (client fault)
+ *  <p>Raised when a request timed out in the client.</p>
+ *
+ * @throws {@link ConcurrentModificationException} (server fault)
+ *  <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
+ *
+ * @throws {@link ConstraintViolationException} (client fault)
+ *  <p>Raised when a value in a request field did not satisfy required constraints.</p>
+ *
+ * @throws {@link IllegalArgumentException} (client fault)
+ *  <p>Raised when an argument in a request is not supported.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>Raised when the processing of the request failed unexpectedly.</p>
+ *
+ * @throws {@link InvalidArgumentException} (client fault)
+ *  <p>Raised when an argument in a request has an invalid value.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Raised when a parameter value is not valid.</p>
+ *
+ * @throws {@link MemoryLimitExceededException} (server fault)
+ *  <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
+ *
+ * @throws {@link MethodNotAllowedException} (client fault)
+ *  <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
+ *
+ * @throws {@link PreconditionsFailedException} (client fault)
+ *  <p>Raised when a precondition for processing a request is not satisfied.</p>
+ *
+ * @throws {@link ReadOnlyViolationException} (client fault)
+ *  <p>Raised when a request attempts to write to a read-only resource.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Raised when the specified resource could not be found. The resource might have been deleted or the identifier might be incorrect.</p>
+ *
+ * @throws {@link ServerShutdownException} (server fault)
+ *  <p>Raised when the server shuts down while processing a request.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Raised when the number of requests being processed exceeds the limit.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>Raised when a request attempts to initiate an operation that is not supported.</p>
+ *
+ * @throws {@link NeptunedataServiceException}
+ * <p>Base exception class for all service exceptions from Neptunedata service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartIndexRebuildCommand extends StartIndexRebuildCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartIndexRebuildInput;
+            output: StartIndexRebuildOutput;
+        };
+        sdk: {
+            input: StartIndexRebuildCommandInput;
+            output: StartIndexRebuildCommandOutput;
+        };
+    };
+}

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

@@ -1,4 +1,5 @@
 export * from "./CancelGremlinQueryCommand";
+export * from "./CancelIndexRebuildCommand";
 export * from "./CancelLoaderJobCommand";
 export * from "./CancelMLDataProcessingJobCommand";
 export * from "./CancelMLModelTrainingJobCommand";
@@ -16,6 +17,7 @@ export * from "./ExecuteOpenCypherExplainQueryCommand";
 export * from "./ExecuteOpenCypherQueryCommand";
 export * from "./GetEngineStatusCommand";
 export * from "./GetGremlinQueryStatusCommand";
+export * from "./GetIndexRebuildStatusCommand";
 export * from "./GetLoaderJobStatusCommand";
 export * from "./GetMLDataProcessingJobCommand";
 export * from "./GetMLEndpointCommand";
@@ -28,7 +30,9 @@ export * from "./GetPropertygraphSummaryCommand";
 export * from "./GetRDFGraphSummaryCommand";
 export * from "./GetSparqlStatisticsCommand";
 export * from "./GetSparqlStreamCommand";
+export * from "./GetStorageInfoCommand";
 export * from "./ListGremlinQueriesCommand";
+export * from "./ListIndexRebuildsCommand";
 export * from "./ListLoaderJobsCommand";
 export * from "./ListMLDataProcessingJobsCommand";
 export * from "./ListMLEndpointsCommand";
@@ -37,6 +41,7 @@ export * from "./ListMLModelTransformJobsCommand";
 export * from "./ListOpenCypherQueriesCommand";
 export * from "./ManagePropertygraphStatisticsCommand";
 export * from "./ManageSparqlStatisticsCommand";
+export * from "./StartIndexRebuildCommand";
 export * from "./StartLoaderJobCommand";
 export * from "./StartMLDataProcessingJobCommand";
 export * from "./StartMLModelTrainingJobCommand";

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

@@ -10,6 +10,62 @@ export declare const Action: {
  * @public
  */
 export type Action = (typeof Action)[keyof typeof Action];
+/**
+ * @public
+ * @enum
+ */
+export declare const RebuildStatus: {
+    /**
+     * <p>The rebuild operation was cancelled by the user.</p>
+     */
+    readonly CANCELLED: "CANCELLED";
+    /**
+     * <p>The rebuild operation was cancelled by the user and is in cancelling phase.</p>
+     */
+    readonly CANCELLING: "CANCELLING";
+    /**
+     * <p>The rebuild operation has completed successfully.</p>
+     */
+    readonly COMPLETED: "COMPLETED";
+    /**
+     * <p>The rebuild operation has failed (completely or partially).</p>
+     */
+    readonly FAILED: "FAILED";
+    /**
+     * <p>The rebuild operation is being prepared.</p>
+     */
+    readonly PREPARING: "PREPARING";
+    /**
+     * <p>The rebuild operation is actively rebuilding indexes.</p>
+     */
+    readonly REBUILDING: "REBUILDING";
+};
+/**
+ * @public
+ */
+export type RebuildStatus = (typeof RebuildStatus)[keyof typeof RebuildStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const WriteBufferSize: {
+    /**
+     * <p>Use when rebuilding indexes during heavy write workloads or continuous bulk data ingestion.</p>
+     */
+    readonly HIGH: "HIGH";
+    /**
+     * <p>Suitable for databases with light to moderate write activity. This is the default.</p>
+     */
+    readonly LOW: "LOW";
+    /**
+     * <p>Recommended for databases with sustained write traffic or bulk loading.</p>
+     */
+    readonly MEDIUM: "MEDIUM";
+};
+/**
+ * @public
+ */
+export type WriteBufferSize = (typeof WriteBufferSize)[keyof typeof WriteBufferSize];
 /**
  * @public
  * @enum
@@ -23,6 +79,28 @@ export declare const OpenCypherExplainMode: {
  * @public
  */
 export type OpenCypherExplainMode = (typeof OpenCypherExplainMode)[keyof typeof OpenCypherExplainMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const Scope: {
+    /**
+     * <p>Rebuild all (quads and dictionaries). This is the default option.</p>
+     */
+    readonly ALL: "ALL";
+    /**
+     * <p>Rebuild only the dictionaries.</p>
+     */
+    readonly DICTIONARIES: "DICTIONARIES";
+    /**
+     * <p>Rebuild only the quad indexes.</p>
+     */
+    readonly QUADS: "QUADS";
+};
+/**
+ * @public
+ */
+export type Scope = (typeof Scope)[keyof typeof Scope];
 /**
  * @public
  * @enum

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

@@ -427,13 +427,13 @@ export declare class UnsupportedOperationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
 }
 /**
- * <p>Raised when a specified bulk-load job ID cannot be found.</p>
+ * <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
  * @public
  */
-export declare class BulkLoadIdNotFoundException extends __BaseException {
+export declare class CancelledByMaintenanceException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "BulkLoadIdNotFoundException";
-    readonly $fault: "client";
+    readonly name: "CancelledByMaintenanceException";
+    readonly $fault: "server";
     $retryable: {};
     /**
      * <p>A detailed message describing the problem.</p>
@@ -441,7 +441,7 @@ export declare class BulkLoadIdNotFoundException extends __BaseException {
      */
     detailedMessage: string | undefined;
     /**
-     * <p>The bulk-load job ID that could not be found.</p>
+     * <p>The ID of the request in question.</p>
      * @public
      */
     requestId: string | undefined;
@@ -453,7 +453,35 @@ export declare class BulkLoadIdNotFoundException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<BulkLoadIdNotFoundException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<CancelledByMaintenanceException, __BaseException>);
+}
+/**
+ * <p>Raised when a user cancelled a request.</p>
+ * @public
+ */
+export declare class CancelledByUserException extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "CancelledByUserException";
+    readonly $fault: "server";
+    /**
+     * <p>A detailed message describing the problem.</p>
+     * @public
+     */
+    detailedMessage: string | undefined;
+    /**
+     * <p>The ID of the request in question.</p>
+     * @public
+     */
+    requestId: string | undefined;
+    /**
+     * <p>The HTTP status code returned with the exception.</p>
+     * @public
+     */
+    code: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CancelledByUserException, __BaseException>);
 }
 /**
  * <p>Raised when the processing of the request failed unexpectedly.</p>
@@ -484,12 +512,12 @@ export declare class InternalFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
 }
 /**
- * <p>Raised when access is denied to a specified load URL.</p>
+ * <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
  * @public
  */
-export declare class LoadUrlAccessDeniedException extends __BaseException {
+export declare class MethodNotAllowedException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "LoadUrlAccessDeniedException";
+    readonly name: "MethodNotAllowedException";
     readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
@@ -509,21 +537,49 @@ export declare class LoadUrlAccessDeniedException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<LoadUrlAccessDeniedException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
 }
 /**
- * <p>Raised when a specified machine-learning resource could not be found.</p>
+ * <p>Raised when a request attempts to write to a read-only resource.</p>
  * @public
  */
-export declare class MLResourceNotFoundException extends __BaseException {
+export declare class ReadOnlyViolationException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "MLResourceNotFoundException";
+    readonly name: "ReadOnlyViolationException";
     readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
      * @public
      */
     detailedMessage: string | undefined;
+    /**
+     * <p>The ID of the request in which the parameter is missing.</p>
+     * @public
+     */
+    requestId: string | undefined;
+    /**
+     * <p>The HTTP status code returned with the exception.</p>
+     * @public
+     */
+    code: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ReadOnlyViolationException, __BaseException>);
+}
+/**
+ * <p>Raised when the server shuts down while processing a request.</p>
+ * @public
+ */
+export declare class ServerShutdownException extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "ServerShutdownException";
+    readonly $fault: "server";
+    /**
+     * <p>A detailed message describing the problem.</p>
+     * @public
+     */
+    detailedMessage: string | undefined;
     /**
      * <p>The ID of the request in question.</p>
      * @public
@@ -537,15 +593,15 @@ export declare class MLResourceNotFoundException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<MLResourceNotFoundException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<ServerShutdownException, __BaseException>);
 }
 /**
- * <p>Raised when invalid numerical data is encountered when servicing a request.</p>
+ * <p>Raised when a parameter value is not valid or is malformed.</p>
  * @public
  */
-export declare class InvalidNumericDataException extends __BaseException {
+export declare class ValidationException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "InvalidNumericDataException";
+    readonly name: "ValidationException";
     readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
@@ -565,23 +621,24 @@ export declare class InvalidNumericDataException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<InvalidNumericDataException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
- * <p>Raised when a request attempts to write to a read-only resource.</p>
+ * <p>Raised when a specified bulk-load job ID cannot be found.</p>
  * @public
  */
-export declare class ReadOnlyViolationException extends __BaseException {
+export declare class BulkLoadIdNotFoundException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "ReadOnlyViolationException";
+    readonly name: "BulkLoadIdNotFoundException";
     readonly $fault: "client";
+    $retryable: {};
     /**
      * <p>A detailed message describing the problem.</p>
      * @public
      */
     detailedMessage: string | undefined;
     /**
-     * <p>The ID of the request in which the parameter is missing.</p>
+     * <p>The bulk-load job ID that could not be found.</p>
      * @public
      */
     requestId: string | undefined;
@@ -593,15 +650,15 @@ export declare class ReadOnlyViolationException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<ReadOnlyViolationException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<BulkLoadIdNotFoundException, __BaseException>);
 }
 /**
- * <p>Raised when statistics needed to satisfy a request are not available.</p>
+ * <p>Raised when access is denied to a specified load URL.</p>
  * @public
  */
-export declare class StatisticsNotAvailableException extends __BaseException {
+export declare class LoadUrlAccessDeniedException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "StatisticsNotAvailableException";
+    readonly name: "LoadUrlAccessDeniedException";
     readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
@@ -621,15 +678,15 @@ export declare class StatisticsNotAvailableException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<StatisticsNotAvailableException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<LoadUrlAccessDeniedException, __BaseException>);
 }
 /**
- * <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
+ * <p>Raised when a specified machine-learning resource could not be found.</p>
  * @public
  */
-export declare class MethodNotAllowedException extends __BaseException {
+export declare class MLResourceNotFoundException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "MethodNotAllowedException";
+    readonly name: "MLResourceNotFoundException";
     readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
@@ -649,16 +706,16 @@ export declare class MethodNotAllowedException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<MLResourceNotFoundException, __BaseException>);
 }
 /**
- * <p>Raised when the server shuts down while processing a request.</p>
+ * <p>Raised when invalid numerical data is encountered when servicing a request.</p>
  * @public
  */
-export declare class ServerShutdownException extends __BaseException {
+export declare class InvalidNumericDataException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "ServerShutdownException";
-    readonly $fault: "server";
+    readonly name: "InvalidNumericDataException";
+    readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
      * @public
@@ -677,16 +734,16 @@ export declare class ServerShutdownException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<ServerShutdownException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<InvalidNumericDataException, __BaseException>);
 }
 /**
- * <p>Raised when a user cancelled a request.</p>
+ * <p>Raised when statistics needed to satisfy a request are not available.</p>
  * @public
  */
-export declare class CancelledByUserException extends __BaseException {
+export declare class StatisticsNotAvailableException extends __BaseException {
     static readonly shapeId: string;
-    readonly name: "CancelledByUserException";
-    readonly $fault: "server";
+    readonly name: "StatisticsNotAvailableException";
+    readonly $fault: "client";
     /**
      * <p>A detailed message describing the problem.</p>
      * @public
@@ -705,7 +762,7 @@ export declare class CancelledByUserException extends __BaseException {
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<CancelledByUserException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<StatisticsNotAvailableException, __BaseException>);
 }
 /**
  * <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
@@ -934,6 +991,34 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * <p>Raised when the specified resource could not be found. The resource might have been deleted or the identifier might be incorrect.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * <p>A detailed message describing the problem.</p>
+     * @public
+     */
+    detailedMessage: string | undefined;
+    /**
+     * <p>The ID of the request in question.</p>
+     * @public
+     */
+    requestId: string | undefined;
+    /**
+     * <p>The HTTP status code returned with the exception.</p>
+     * @public
+     */
+    code: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
 /**
  * <p>Raised when there is a problem accessing Amazon S3.</p>
  * @public