The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data +operations, including data loading, query execution, data inquiry, and machine learning. +It supports all three Neptune query languages (Gremlin, openCypher and SPARQL), and is +available in all SDK languages. It automatically signs API requests and greatly simplifies +integrating Neptune into your applications.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-neptunedata +using your favorite package manager: + +- `npm install @aws-sdk/client-neptunedata` +- `yarn add @aws-sdk/client-neptunedata` +- `pnpm add @aws-sdk/client-neptunedata` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `NeptunedataClient` and +the commands you need, for example `CancelGremlinQueryCommand`: + +```js +// ES5 example +const { NeptunedataClient, CancelGremlinQueryCommand } = require("@aws-sdk/client-neptunedata"); +``` + +```ts +// ES6+ example +import { NeptunedataClient, CancelGremlinQueryCommand } from "@aws-sdk/client-neptunedata"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new NeptunedataClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new CancelGremlinQueryCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-neptunedata"; +const client = new AWS.Neptunedata({ region: "REGION" }); + +// async/await. +try { + const data = await client.cancelGremlinQuery(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .cancelGremlinQuery(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.cancelGremlinQuery(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-neptunedata` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data + * operations, including data loading, query execution, data inquiry, and machine learning. + * It supports all three Neptune query languages (Gremlin, openCypher and SPARQL), and is + * available in all SDK languages. It automatically signs API requests and greatly simplifies + * integrating Neptune into your applications.
+ */ +export class Neptunedata extends NeptunedataClient implements Neptunedata {} +createAggregatedClient(commands, Neptunedata); diff --git a/clients/client-neptunedata/src/NeptunedataClient.ts b/clients/client-neptunedata/src/NeptunedataClient.ts new file mode 100644 index 0000000000000..822882c2c8656 --- /dev/null +++ b/clients/client-neptunedata/src/NeptunedataClient.ts @@ -0,0 +1,507 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { Credentials as __Credentials } from "@aws-sdk/types"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandler as __HttpHandler } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + Checksum as __Checksum, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + Hash as __Hash, + 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 { CancelGremlinQueryCommandInput, CancelGremlinQueryCommandOutput } from "./commands/CancelGremlinQueryCommand"; +import { CancelLoaderJobCommandInput, CancelLoaderJobCommandOutput } from "./commands/CancelLoaderJobCommand"; +import { + CancelMLDataProcessingJobCommandInput, + CancelMLDataProcessingJobCommandOutput, +} from "./commands/CancelMLDataProcessingJobCommand"; +import { + CancelMLModelTrainingJobCommandInput, + CancelMLModelTrainingJobCommandOutput, +} from "./commands/CancelMLModelTrainingJobCommand"; +import { + CancelMLModelTransformJobCommandInput, + CancelMLModelTransformJobCommandOutput, +} from "./commands/CancelMLModelTransformJobCommand"; +import { + CancelOpenCypherQueryCommandInput, + CancelOpenCypherQueryCommandOutput, +} from "./commands/CancelOpenCypherQueryCommand"; +import { CreateMLEndpointCommandInput, CreateMLEndpointCommandOutput } from "./commands/CreateMLEndpointCommand"; +import { DeleteMLEndpointCommandInput, DeleteMLEndpointCommandOutput } from "./commands/DeleteMLEndpointCommand"; +import { + DeletePropertygraphStatisticsCommandInput, + DeletePropertygraphStatisticsCommandOutput, +} from "./commands/DeletePropertygraphStatisticsCommand"; +import { + DeleteSparqlStatisticsCommandInput, + DeleteSparqlStatisticsCommandOutput, +} from "./commands/DeleteSparqlStatisticsCommand"; +import { ExecuteFastResetCommandInput, ExecuteFastResetCommandOutput } from "./commands/ExecuteFastResetCommand"; +import { + ExecuteGremlinExplainQueryCommandInput, + ExecuteGremlinExplainQueryCommandOutput, +} from "./commands/ExecuteGremlinExplainQueryCommand"; +import { + ExecuteGremlinProfileQueryCommandInput, + ExecuteGremlinProfileQueryCommandOutput, +} from "./commands/ExecuteGremlinProfileQueryCommand"; +import { + ExecuteGremlinQueryCommandInput, + ExecuteGremlinQueryCommandOutput, +} from "./commands/ExecuteGremlinQueryCommand"; +import { + ExecuteOpenCypherExplainQueryCommandInput, + ExecuteOpenCypherExplainQueryCommandOutput, +} from "./commands/ExecuteOpenCypherExplainQueryCommand"; +import { + ExecuteOpenCypherQueryCommandInput, + ExecuteOpenCypherQueryCommandOutput, +} from "./commands/ExecuteOpenCypherQueryCommand"; +import { GetEngineStatusCommandInput, GetEngineStatusCommandOutput } from "./commands/GetEngineStatusCommand"; +import { + GetGremlinQueryStatusCommandInput, + GetGremlinQueryStatusCommandOutput, +} from "./commands/GetGremlinQueryStatusCommand"; +import { GetLoaderJobStatusCommandInput, GetLoaderJobStatusCommandOutput } from "./commands/GetLoaderJobStatusCommand"; +import { + GetMLDataProcessingJobCommandInput, + GetMLDataProcessingJobCommandOutput, +} from "./commands/GetMLDataProcessingJobCommand"; +import { GetMLEndpointCommandInput, GetMLEndpointCommandOutput } from "./commands/GetMLEndpointCommand"; +import { + GetMLModelTrainingJobCommandInput, + GetMLModelTrainingJobCommandOutput, +} from "./commands/GetMLModelTrainingJobCommand"; +import { + GetMLModelTransformJobCommandInput, + GetMLModelTransformJobCommandOutput, +} from "./commands/GetMLModelTransformJobCommand"; +import { + GetOpenCypherQueryStatusCommandInput, + GetOpenCypherQueryStatusCommandOutput, +} from "./commands/GetOpenCypherQueryStatusCommand"; +import { + GetPropertygraphStatisticsCommandInput, + GetPropertygraphStatisticsCommandOutput, +} from "./commands/GetPropertygraphStatisticsCommand"; +import { + GetPropertygraphStreamCommandInput, + GetPropertygraphStreamCommandOutput, +} from "./commands/GetPropertygraphStreamCommand"; +import { + GetPropertygraphSummaryCommandInput, + GetPropertygraphSummaryCommandOutput, +} from "./commands/GetPropertygraphSummaryCommand"; +import { GetRDFGraphSummaryCommandInput, GetRDFGraphSummaryCommandOutput } from "./commands/GetRDFGraphSummaryCommand"; +import { + GetSparqlStatisticsCommandInput, + GetSparqlStatisticsCommandOutput, +} from "./commands/GetSparqlStatisticsCommand"; +import { GetSparqlStreamCommandInput, GetSparqlStreamCommandOutput } from "./commands/GetSparqlStreamCommand"; +import { ListGremlinQueriesCommandInput, ListGremlinQueriesCommandOutput } from "./commands/ListGremlinQueriesCommand"; +import { ListLoaderJobsCommandInput, ListLoaderJobsCommandOutput } from "./commands/ListLoaderJobsCommand"; +import { + ListMLDataProcessingJobsCommandInput, + ListMLDataProcessingJobsCommandOutput, +} from "./commands/ListMLDataProcessingJobsCommand"; +import { ListMLEndpointsCommandInput, ListMLEndpointsCommandOutput } from "./commands/ListMLEndpointsCommand"; +import { + ListMLModelTrainingJobsCommandInput, + ListMLModelTrainingJobsCommandOutput, +} from "./commands/ListMLModelTrainingJobsCommand"; +import { + ListMLModelTransformJobsCommandInput, + ListMLModelTransformJobsCommandOutput, +} from "./commands/ListMLModelTransformJobsCommand"; +import { + ListOpenCypherQueriesCommandInput, + ListOpenCypherQueriesCommandOutput, +} from "./commands/ListOpenCypherQueriesCommand"; +import { + ManagePropertygraphStatisticsCommandInput, + ManagePropertygraphStatisticsCommandOutput, +} from "./commands/ManagePropertygraphStatisticsCommand"; +import { + ManageSparqlStatisticsCommandInput, + ManageSparqlStatisticsCommandOutput, +} from "./commands/ManageSparqlStatisticsCommand"; +import { StartLoaderJobCommandInput, StartLoaderJobCommandOutput } from "./commands/StartLoaderJobCommand"; +import { + StartMLDataProcessingJobCommandInput, + StartMLDataProcessingJobCommandOutput, +} from "./commands/StartMLDataProcessingJobCommand"; +import { + StartMLModelTrainingJobCommandInput, + StartMLModelTrainingJobCommandOutput, +} from "./commands/StartMLModelTrainingJobCommand"; +import { + StartMLModelTransformJobCommandInput, + StartMLModelTransformJobCommandOutput, +} from "./commands/StartMLModelTransformJobCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CancelGremlinQueryCommandInput + | CancelLoaderJobCommandInput + | CancelMLDataProcessingJobCommandInput + | CancelMLModelTrainingJobCommandInput + | CancelMLModelTransformJobCommandInput + | CancelOpenCypherQueryCommandInput + | CreateMLEndpointCommandInput + | DeleteMLEndpointCommandInput + | DeletePropertygraphStatisticsCommandInput + | DeleteSparqlStatisticsCommandInput + | ExecuteFastResetCommandInput + | ExecuteGremlinExplainQueryCommandInput + | ExecuteGremlinProfileQueryCommandInput + | ExecuteGremlinQueryCommandInput + | ExecuteOpenCypherExplainQueryCommandInput + | ExecuteOpenCypherQueryCommandInput + | GetEngineStatusCommandInput + | GetGremlinQueryStatusCommandInput + | GetLoaderJobStatusCommandInput + | GetMLDataProcessingJobCommandInput + | GetMLEndpointCommandInput + | GetMLModelTrainingJobCommandInput + | GetMLModelTransformJobCommandInput + | GetOpenCypherQueryStatusCommandInput + | GetPropertygraphStatisticsCommandInput + | GetPropertygraphStreamCommandInput + | GetPropertygraphSummaryCommandInput + | GetRDFGraphSummaryCommandInput + | GetSparqlStatisticsCommandInput + | GetSparqlStreamCommandInput + | ListGremlinQueriesCommandInput + | ListLoaderJobsCommandInput + | ListMLDataProcessingJobsCommandInput + | ListMLEndpointsCommandInput + | ListMLModelTrainingJobsCommandInput + | ListMLModelTransformJobsCommandInput + | ListOpenCypherQueriesCommandInput + | ManagePropertygraphStatisticsCommandInput + | ManageSparqlStatisticsCommandInput + | StartLoaderJobCommandInput + | StartMLDataProcessingJobCommandInput + | StartMLModelTrainingJobCommandInput + | StartMLModelTransformJobCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CancelGremlinQueryCommandOutput + | CancelLoaderJobCommandOutput + | CancelMLDataProcessingJobCommandOutput + | CancelMLModelTrainingJobCommandOutput + | CancelMLModelTransformJobCommandOutput + | CancelOpenCypherQueryCommandOutput + | CreateMLEndpointCommandOutput + | DeleteMLEndpointCommandOutput + | DeletePropertygraphStatisticsCommandOutput + | DeleteSparqlStatisticsCommandOutput + | ExecuteFastResetCommandOutput + | ExecuteGremlinExplainQueryCommandOutput + | ExecuteGremlinProfileQueryCommandOutput + | ExecuteGremlinQueryCommandOutput + | ExecuteOpenCypherExplainQueryCommandOutput + | ExecuteOpenCypherQueryCommandOutput + | GetEngineStatusCommandOutput + | GetGremlinQueryStatusCommandOutput + | GetLoaderJobStatusCommandOutput + | GetMLDataProcessingJobCommandOutput + | GetMLEndpointCommandOutput + | GetMLModelTrainingJobCommandOutput + | GetMLModelTransformJobCommandOutput + | GetOpenCypherQueryStatusCommandOutput + | GetPropertygraphStatisticsCommandOutput + | GetPropertygraphStreamCommandOutput + | GetPropertygraphSummaryCommandOutput + | GetRDFGraphSummaryCommandOutput + | GetSparqlStatisticsCommandOutput + | GetSparqlStreamCommandOutput + | ListGremlinQueriesCommandOutput + | ListLoaderJobsCommandOutput + | ListMLDataProcessingJobsCommandOutput + | ListMLEndpointsCommandOutput + | ListMLModelTrainingJobsCommandOutput + | ListMLModelTransformJobsCommandOutput + | ListOpenCypherQueriesCommandOutput + | ManagePropertygraphStatisticsCommandOutput + | ManageSparqlStatisticsCommandOutput + | StartLoaderJobCommandOutput + | StartMLDataProcessingJobCommandOutput + | StartMLModelTrainingJobCommandOutput + | StartMLModelTransformJobCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandler; + + /** + * 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 | __ProviderThe Amazon Neptune data API provides SDK support for more than 40 of Neptune's data + * operations, including data loading, query execution, data inquiry, and machine learning. + * It supports all three Neptune query languages (Gremlin, openCypher and SPARQL), and is + * available in all SDK languages. It automatically signs API requests and greatly simplifies + * integrating Neptune into your applications.
+ */ +export class NeptunedataClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + NeptunedataClientResolvedConfig +> { + /** + * The resolved configuration of NeptunedataClient class. This is resolved and normalized from the {@link NeptunedataClientConfig | constructor configuration interface}. + */ + readonly config: NeptunedataClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigCancels a Gremlin query. See Gremlin + * query cancellation for more information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, CancelGremlinQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, CancelGremlinQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // CancelGremlinQueryInput + * queryId: "STRING_VALUE", // required + * }; + * const command = new CancelGremlinQueryCommand(input); + * const response = await client.send(command); + * // { // CancelGremlinQueryOutput + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CancelGremlinQueryCommandInput - {@link CancelGremlinQueryCommandInput} + * @returns {@link CancelGremlinQueryCommandOutput} + * @see {@link CancelGremlinQueryCommandInput} for command's `input` shape. + * @see {@link CancelGremlinQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelGremlinQueryCommand extends $Command< + CancelGremlinQueryCommandInput, + CancelGremlinQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelGremlinQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a specified load job. This is an HTTP DELETE
+ * request.
See Neptune + * Loader Get-Status API for more information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, CancelLoaderJobCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, CancelLoaderJobCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // CancelLoaderJobInput + * loadId: "STRING_VALUE", // required + * }; + * const command = new CancelLoaderJobCommand(input); + * const response = await client.send(command); + * // { // CancelLoaderJobOutput + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CancelLoaderJobCommandInput - {@link CancelLoaderJobCommandInput} + * @returns {@link CancelLoaderJobCommandOutput} + * @see {@link CancelLoaderJobCommandInput} for command's `input` shape. + * @see {@link CancelLoaderJobCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link BulkLoadIdNotFoundException} (client fault) + *Raised when a specified bulk-load job ID cannot be found.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InternalFailureException} (server fault) + *Raised when the processing of the request failed unexpectedly.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link LoadUrlAccessDeniedException} (client fault) + *Raised when access is denied to a specified load URL.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelLoaderJobCommand extends $Command< + CancelLoaderJobCommandInput, + CancelLoaderJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelLoaderJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a Neptune ML data processing job. See The
+ * dataprocessing command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelMLDataProcessingJobCommand extends $Command< + CancelMLDataProcessingJobCommandInput, + CancelMLDataProcessingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelMLDataProcessingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a Neptune ML model training job. See Model
+ * training using the modeltraining command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelMLModelTrainingJobCommand extends $Command< + CancelMLModelTrainingJobCommandInput, + CancelMLModelTrainingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelMLModelTrainingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a specified model transform job. See Use + * a trained model to generate new model artifacts.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, CancelMLModelTransformJobCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, CancelMLModelTransformJobCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // CancelMLModelTransformJobInput + * id: "STRING_VALUE", // required + * neptuneIamRoleArn: "STRING_VALUE", + * clean: true || false, + * }; + * const command = new CancelMLModelTransformJobCommand(input); + * const response = await client.send(command); + * // { // CancelMLModelTransformJobOutput + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CancelMLModelTransformJobCommandInput - {@link CancelMLModelTransformJobCommandInput} + * @returns {@link CancelMLModelTransformJobCommandOutput} + * @see {@link CancelMLModelTransformJobCommandInput} for command's `input` shape. + * @see {@link CancelMLModelTransformJobCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelMLModelTransformJobCommand extends $Command< + CancelMLModelTransformJobCommandInput, + CancelMLModelTransformJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelMLModelTransformJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels a specified openCypher query. See Neptune + * openCypher status endpoint for more information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, CancelOpenCypherQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, CancelOpenCypherQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // CancelOpenCypherQueryInput + * queryId: "STRING_VALUE", // required + * silent: true || false, + * }; + * const command = new CancelOpenCypherQueryCommand(input); + * const response = await client.send(command); + * // { // CancelOpenCypherQueryOutput + * // status: "STRING_VALUE", + * // payload: true || false, + * // }; + * + * ``` + * + * @param CancelOpenCypherQueryCommandInput - {@link CancelOpenCypherQueryCommandInput} + * @returns {@link CancelOpenCypherQueryCommandOutput} + * @see {@link CancelOpenCypherQueryCommandInput} for command's `input` shape. + * @see {@link CancelOpenCypherQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidNumericDataException} (client fault) + *Raised when invalid numerical data is encountered when servicing a request.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CancelOpenCypherQueryCommand extends $Command< + CancelOpenCypherQueryCommandInput, + CancelOpenCypherQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CancelOpenCypherQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a new Neptune ML inference endpoint that lets you query + * one specific model that the model-training process constructed. See + * Managing + * inference endpoints using the endpoints command.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, CreateMLEndpointCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, CreateMLEndpointCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // CreateMLEndpointInput + * id: "STRING_VALUE", + * mlModelTrainingJobId: "STRING_VALUE", + * mlModelTransformJobId: "STRING_VALUE", + * update: true || false, + * neptuneIamRoleArn: "STRING_VALUE", + * modelName: "STRING_VALUE", + * instanceType: "STRING_VALUE", + * instanceCount: Number("int"), + * volumeEncryptionKMSKey: "STRING_VALUE", + * }; + * const command = new CreateMLEndpointCommand(input); + * const response = await client.send(command); + * // { // CreateMLEndpointOutput + * // id: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // creationTimeInMillis: Number("long"), + * // }; + * + * ``` + * + * @param CreateMLEndpointCommandInput - {@link CreateMLEndpointCommandInput} + * @returns {@link CreateMLEndpointCommandOutput} + * @see {@link CreateMLEndpointCommandInput} for command's `input` shape. + * @see {@link CreateMLEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class CreateMLEndpointCommand extends $Command< + CreateMLEndpointCommandInput, + CreateMLEndpointCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateMLEndpointCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCancels the creation of a Neptune ML inference endpoint. See + * Managing + * inference endpoints using the endpoints command.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, DeleteMLEndpointCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, DeleteMLEndpointCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // DeleteMLEndpointInput + * id: "STRING_VALUE", // required + * neptuneIamRoleArn: "STRING_VALUE", + * clean: true || false, + * }; + * const command = new DeleteMLEndpointCommand(input); + * const response = await client.send(command); + * // { // DeleteMLEndpointOutput + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteMLEndpointCommandInput - {@link DeleteMLEndpointCommandInput} + * @returns {@link DeleteMLEndpointCommandOutput} + * @see {@link DeleteMLEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteMLEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class DeleteMLEndpointCommand extends $Command< + DeleteMLEndpointCommandInput, + DeleteMLEndpointCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteMLEndpointCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes statistics for Gremlin and openCypher (property graph) + * data.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, DeletePropertygraphStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, DeletePropertygraphStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = {}; + * const command = new DeletePropertygraphStatisticsCommand(input); + * const response = await client.send(command); + * // { // DeletePropertygraphStatisticsOutput + * // statusCode: Number("int"), + * // status: "STRING_VALUE", + * // payload: { // DeleteStatisticsValueMap + * // active: true || false, + * // statisticsId: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param DeletePropertygraphStatisticsCommandInput - {@link DeletePropertygraphStatisticsCommandInput} + * @returns {@link DeletePropertygraphStatisticsCommandOutput} + * @see {@link DeletePropertygraphStatisticsCommandInput} for command's `input` shape. + * @see {@link DeletePropertygraphStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class DeletePropertygraphStatisticsCommand extends $Command< + DeletePropertygraphStatisticsCommandInput, + DeletePropertygraphStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeletePropertygraphStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes SPARQL statistics
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, DeleteSparqlStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, DeleteSparqlStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = {}; + * const command = new DeleteSparqlStatisticsCommand(input); + * const response = await client.send(command); + * // { // DeleteSparqlStatisticsOutput + * // statusCode: Number("int"), + * // status: "STRING_VALUE", + * // payload: { // DeleteStatisticsValueMap + * // active: true || false, + * // statisticsId: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param DeleteSparqlStatisticsCommandInput - {@link DeleteSparqlStatisticsCommandInput} + * @returns {@link DeleteSparqlStatisticsCommandOutput} + * @see {@link DeleteSparqlStatisticsCommandInput} for command's `input` shape. + * @see {@link DeleteSparqlStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class DeleteSparqlStatisticsCommand extends $Command< + DeleteSparqlStatisticsCommandInput, + DeleteSparqlStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteSparqlStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe fast reset REST API lets you reset a Neptune graph quicky + * and easily, removing all of its data.
+ *Neptune fast reset is a two-step process. First you call ExecuteFastReset
+ * with action set to initiateDatabaseReset. This returns a
+ * UUID token which you then include when calling ExecuteFastReset again
+ * with action set to performDatabaseReset. See Empty an Amazon Neptune
+ * DB cluster using the fast reset API.
Raised in case of an authentication or authorization failure.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MethodNotAllowedException} (client fault) + *Raised when the HTTP method used by a request is not supported by the endpoint + * being used.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link ServerShutdownException} (server fault) + *Raised when the server shuts down while processing a request.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteFastResetCommand extends $Command< + ExecuteFastResetCommandInput, + ExecuteFastResetCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteFastResetCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExecutes a Gremlin Explain query.
+ *Amazon Neptune has added a Gremlin feature named explain
+ * that provides is a self-service tool for understanding the execution
+ * approach being taken by the Neptune engine for the query. You invoke
+ * it by adding an explain parameter to an HTTP call that
+ * submits a Gremlin query.
The explain feature provides information about the logical structure + * of query execution plans. You can use this information to identify + * potential evaluation and execution bottlenecks and to tune your query, + * as explained in Tuning + * Gremlin queries. You can also use query hints to improve + * query execution plans.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ExecuteGremlinExplainQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ExecuteGremlinExplainQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ExecuteGremlinExplainQueryInput + * gremlinQuery: "STRING_VALUE", // required + * }; + * const command = new ExecuteGremlinExplainQueryCommand(input); + * const response = await client.send(command); + * // { // ExecuteGremlinExplainQueryOutput + * // output: "BLOB_VALUE", + * // }; + * + * ``` + * + * @param ExecuteGremlinExplainQueryCommandInput - {@link ExecuteGremlinExplainQueryCommandInput} + * @returns {@link ExecuteGremlinExplainQueryCommandOutput} + * @see {@link ExecuteGremlinExplainQueryCommandInput} for command's `input` shape. + * @see {@link ExecuteGremlinExplainQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link CancelledByUserException} (server fault) + *Raised when a user cancelled a request.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MalformedQueryException} (client fault) + *Raised when a query is submitted that is syntactically incorrect or does not + * pass additional validation.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link QueryLimitExceededException} (server fault) + *Raised when the number of active queries exceeds what the server can process. + * The query in question can be retried when the system is less busy.
+ * + * @throws {@link QueryLimitException} (client fault) + *Raised when the size of a query exceeds the system limit.
+ * + * @throws {@link QueryTooLargeException} (client fault) + *Raised when the body of a query is too large.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteGremlinExplainQueryCommand extends $Command< + ExecuteGremlinExplainQueryCommandInput, + ExecuteGremlinExplainQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteGremlinExplainQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExecutes a Gremlin Profile query, which runs a specified traversal, + * collects various metrics about the run, and produces a profile report + * as output. See Gremlin profile + * API in Neptune for details.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ExecuteGremlinProfileQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ExecuteGremlinProfileQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ExecuteGremlinProfileQueryInput + * gremlinQuery: "STRING_VALUE", // required + * results: true || false, + * chop: Number("int"), + * serializer: "STRING_VALUE", + * indexOps: true || false, + * }; + * const command = new ExecuteGremlinProfileQueryCommand(input); + * const response = await client.send(command); + * // { // ExecuteGremlinProfileQueryOutput + * // output: "BLOB_VALUE", + * // }; + * + * ``` + * + * @param ExecuteGremlinProfileQueryCommandInput - {@link ExecuteGremlinProfileQueryCommandInput} + * @returns {@link ExecuteGremlinProfileQueryCommandOutput} + * @see {@link ExecuteGremlinProfileQueryCommandInput} for command's `input` shape. + * @see {@link ExecuteGremlinProfileQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link CancelledByUserException} (server fault) + *Raised when a user cancelled a request.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MalformedQueryException} (client fault) + *Raised when a query is submitted that is syntactically incorrect or does not + * pass additional validation.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link QueryLimitExceededException} (server fault) + *Raised when the number of active queries exceeds what the server can process. + * The query in question can be retried when the system is less busy.
+ * + * @throws {@link QueryLimitException} (client fault) + *Raised when the size of a query exceeds the system limit.
+ * + * @throws {@link QueryTooLargeException} (client fault) + *Raised when the body of a query is too large.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteGremlinProfileQueryCommand extends $Command< + ExecuteGremlinProfileQueryCommandInput, + ExecuteGremlinProfileQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteGremlinProfileQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThis commands executes a Gremlin query. Amazon Neptune is compatible + * with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal + * language to query the graph, as described under The + * Graph in the Apache TinkerPop3 documentation. + * More details can also be found in Accessing a + * Neptune graph with Gremlin.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ExecuteGremlinQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ExecuteGremlinQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ExecuteGremlinQueryInput + * gremlinQuery: "STRING_VALUE", // required + * serializer: "STRING_VALUE", + * }; + * const command = new ExecuteGremlinQueryCommand(input); + * const response = await client.send(command); + * // { // ExecuteGremlinQueryOutput + * // requestId: "STRING_VALUE", + * // status: { // GremlinQueryStatusAttributes + * // message: "STRING_VALUE", + * // code: Number("int"), + * // attributes: "DOCUMENT_VALUE", + * // }, + * // result: "DOCUMENT_VALUE", + * // meta: "DOCUMENT_VALUE", + * // }; + * + * ``` + * + * @param ExecuteGremlinQueryCommandInput - {@link ExecuteGremlinQueryCommandInput} + * @returns {@link ExecuteGremlinQueryCommandOutput} + * @see {@link ExecuteGremlinQueryCommandInput} for command's `input` shape. + * @see {@link ExecuteGremlinQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link CancelledByUserException} (server fault) + *Raised when a user cancelled a request.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MalformedQueryException} (client fault) + *Raised when a query is submitted that is syntactically incorrect or does not + * pass additional validation.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link QueryLimitExceededException} (server fault) + *Raised when the number of active queries exceeds what the server can process. + * The query in question can be retried when the system is less busy.
+ * + * @throws {@link QueryLimitException} (client fault) + *Raised when the size of a query exceeds the system limit.
+ * + * @throws {@link QueryTooLargeException} (client fault) + *Raised when the body of a query is too large.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteGremlinQueryCommand extends $Command< + ExecuteGremlinQueryCommandInput, + ExecuteGremlinQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteGremlinQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExecutes an openCypher explain request. See
+ * The
+ * openCypher explain feature for more information.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link CancelledByUserException} (server fault) + *Raised when a user cancelled a request.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidNumericDataException} (client fault) + *Raised when invalid numerical data is encountered when servicing a request.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MalformedQueryException} (client fault) + *Raised when a query is submitted that is syntactically incorrect or does not + * pass additional validation.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link QueryLimitExceededException} (server fault) + *Raised when the number of active queries exceeds what the server can process. + * The query in question can be retried when the system is less busy.
+ * + * @throws {@link QueryLimitException} (client fault) + *Raised when the size of a query exceeds the system limit.
+ * + * @throws {@link QueryTooLargeException} (client fault) + *Raised when the body of a query is too large.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteOpenCypherExplainQueryCommand extends $Command< + ExecuteOpenCypherExplainQueryCommandInput, + ExecuteOpenCypherExplainQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteOpenCypherExplainQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExecutes an openCypher query. See Accessing + * the Neptune Graph with openCypher for more information.
+ *Neptune supports building graph applications using openCypher, + * which is currently one of the most popular query languages among + * developers working with graph databases. Developers, business analysts, + * and data scientists like openCypher's declarative, SQL-inspired syntax + * because it provides a familiar structure in which to querying property + * graphs.
+ *The openCypher language was originally developed by Neo4j, then + * open-sourced in 2015 and contributed to the openCypher project under an Apache + * 2 open-source license.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ExecuteOpenCypherQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ExecuteOpenCypherQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ExecuteOpenCypherQueryInput + * openCypherQuery: "STRING_VALUE", // required + * parameters: "STRING_VALUE", + * }; + * const command = new ExecuteOpenCypherQueryCommand(input); + * const response = await client.send(command); + * // { // ExecuteOpenCypherQueryOutput + * // results: "DOCUMENT_VALUE", // required + * // }; + * + * ``` + * + * @param ExecuteOpenCypherQueryCommandInput - {@link ExecuteOpenCypherQueryCommandInput} + * @returns {@link ExecuteOpenCypherQueryCommandOutput} + * @see {@link ExecuteOpenCypherQueryCommandInput} for command's `input` shape. + * @see {@link ExecuteOpenCypherQueryCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link CancelledByUserException} (server fault) + *Raised when a user cancelled a request.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidNumericDataException} (client fault) + *Raised when invalid numerical data is encountered when servicing a request.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MalformedQueryException} (client fault) + *Raised when a query is submitted that is syntactically incorrect or does not + * pass additional validation.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link QueryLimitExceededException} (server fault) + *Raised when the number of active queries exceeds what the server can process. + * The query in question can be retried when the system is less busy.
+ * + * @throws {@link QueryLimitException} (client fault) + *Raised when the size of a query exceeds the system limit.
+ * + * @throws {@link QueryTooLargeException} (client fault) + *Raised when the body of a query is too large.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ExecuteOpenCypherQueryCommand extends $Command< + ExecuteOpenCypherQueryCommandInput, + ExecuteOpenCypherQueryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ExecuteOpenCypherQueryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCheck the status of the graph database on the host.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetEngineStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetEngineStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = {}; + * const command = new GetEngineStatusCommand(input); + * const response = await client.send(command); + * // { // GetEngineStatusOutput + * // status: "STRING_VALUE", + * // startTime: "STRING_VALUE", + * // dbEngineVersion: "STRING_VALUE", + * // role: "STRING_VALUE", + * // dfeQueryEngine: "STRING_VALUE", + * // gremlin: { // QueryLanguageVersion + * // version: "STRING_VALUE", // required + * // }, + * // sparql: { + * // version: "STRING_VALUE", // required + * // }, + * // opencypher: { + * // version: "STRING_VALUE", // required + * // }, + * // labMode: { // StringValuedMap + * // "Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InternalFailureException} (server fault) + *Raised when the processing of the request failed unexpectedly.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetEngineStatusCommand extends $Command< + GetEngineStatusCommandInput, + GetEngineStatusCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetEngineStatusCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the status of a specified Gremlin query.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetGremlinQueryStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetGremlinQueryStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetGremlinQueryStatusInput + * queryId: "STRING_VALUE", // required + * }; + * const command = new GetGremlinQueryStatusCommand(input); + * const response = await client.send(command); + * // { // GetGremlinQueryStatusOutput + * // queryId: "STRING_VALUE", + * // queryString: "STRING_VALUE", + * // queryEvalStats: { // QueryEvalStats + * // waited: Number("int"), + * // elapsed: Number("int"), + * // cancelled: true || false, + * // subqueries: "DOCUMENT_VALUE", + * // }, + * // }; + * + * ``` + * + * @param GetGremlinQueryStatusCommandInput - {@link GetGremlinQueryStatusCommandInput} + * @returns {@link GetGremlinQueryStatusCommandOutput} + * @see {@link GetGremlinQueryStatusCommandInput} for command's `input` shape. + * @see {@link GetGremlinQueryStatusCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetGremlinQueryStatusCommand extends $Command< + GetGremlinQueryStatusCommandInput, + GetGremlinQueryStatusCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetGremlinQueryStatusCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets status information about a specified load job. + * Neptune keeps track of the most recent 1,024 bulk load jobs, + * and stores the last 10,000 error details per job.
+ *See Neptune + * Loader Get-Status API for more information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetLoaderJobStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetLoaderJobStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetLoaderJobStatusInput + * loadId: "STRING_VALUE", // required + * details: true || false, + * errors: true || false, + * page: Number("int"), + * errorsPerPage: Number("int"), + * }; + * const command = new GetLoaderJobStatusCommand(input); + * const response = await client.send(command); + * // { // GetLoaderJobStatusOutput + * // status: "STRING_VALUE", // required + * // payload: "DOCUMENT_VALUE", // required + * // }; + * + * ``` + * + * @param GetLoaderJobStatusCommandInput - {@link GetLoaderJobStatusCommandInput} + * @returns {@link GetLoaderJobStatusCommandOutput} + * @see {@link GetLoaderJobStatusCommandInput} for command's `input` shape. + * @see {@link GetLoaderJobStatusCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link BulkLoadIdNotFoundException} (client fault) + *Raised when a specified bulk-load job ID cannot be found.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InternalFailureException} (server fault) + *Raised when the processing of the request failed unexpectedly.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link LoadUrlAccessDeniedException} (client fault) + *Raised when access is denied to a specified load URL.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetLoaderJobStatusCommand extends $Command< + GetLoaderJobStatusCommandInput, + GetLoaderJobStatusCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetLoaderJobStatusCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves information about a specified data processing job. See The
+ * dataprocessing command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetMLDataProcessingJobCommand extends $Command< + GetMLDataProcessingJobCommandInput, + GetMLDataProcessingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMLDataProcessingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves details about an inference endpoint. See Managing + * inference endpoints using the endpoints command.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetMLEndpointCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetMLEndpointCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetMLEndpointInput + * id: "STRING_VALUE", // required + * neptuneIamRoleArn: "STRING_VALUE", + * }; + * const command = new GetMLEndpointCommand(input); + * const response = await client.send(command); + * // { // GetMLEndpointOutput + * // status: "STRING_VALUE", + * // id: "STRING_VALUE", + * // endpoint: { // MlResourceDefinition + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // status: "STRING_VALUE", + * // outputLocation: "STRING_VALUE", + * // failureReason: "STRING_VALUE", + * // cloudwatchLogUrl: "STRING_VALUE", + * // }, + * // endpointConfig: { // MlConfigDefinition + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param GetMLEndpointCommandInput - {@link GetMLEndpointCommandInput} + * @returns {@link GetMLEndpointCommandOutput} + * @see {@link GetMLEndpointCommandInput} for command's `input` shape. + * @see {@link GetMLEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetMLEndpointCommand extends $Command< + GetMLEndpointCommandInput, + GetMLEndpointCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMLEndpointCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves information about a Neptune ML model training job. See Model
+ * training using the modeltraining command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetMLModelTrainingJobCommand extends $Command< + GetMLModelTrainingJobCommandInput, + GetMLModelTrainingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMLModelTrainingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about a specified model transform job. See Use + * a trained model to generate new model artifacts.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetMLModelTransformJobCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetMLModelTransformJobCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetMLModelTransformJobInput + * id: "STRING_VALUE", // required + * neptuneIamRoleArn: "STRING_VALUE", + * }; + * const command = new GetMLModelTransformJobCommand(input); + * const response = await client.send(command); + * // { // GetMLModelTransformJobOutput + * // status: "STRING_VALUE", + * // id: "STRING_VALUE", + * // baseProcessingJob: { // MlResourceDefinition + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // status: "STRING_VALUE", + * // outputLocation: "STRING_VALUE", + * // failureReason: "STRING_VALUE", + * // cloudwatchLogUrl: "STRING_VALUE", + * // }, + * // remoteModelTransformJob: { + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // status: "STRING_VALUE", + * // outputLocation: "STRING_VALUE", + * // failureReason: "STRING_VALUE", + * // cloudwatchLogUrl: "STRING_VALUE", + * // }, + * // models: [ // Models + * // { // MlConfigDefinition + * // name: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param GetMLModelTransformJobCommandInput - {@link GetMLModelTransformJobCommandInput} + * @returns {@link GetMLModelTransformJobCommandOutput} + * @see {@link GetMLModelTransformJobCommandInput} for command's `input` shape. + * @see {@link GetMLModelTransformJobCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetMLModelTransformJobCommand extends $Command< + GetMLModelTransformJobCommandInput, + GetMLModelTransformJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMLModelTransformJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves the status of a specified openCypher query.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetOpenCypherQueryStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetOpenCypherQueryStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetOpenCypherQueryStatusInput + * queryId: "STRING_VALUE", // required + * }; + * const command = new GetOpenCypherQueryStatusCommand(input); + * const response = await client.send(command); + * // { // GetOpenCypherQueryStatusOutput + * // queryId: "STRING_VALUE", + * // queryString: "STRING_VALUE", + * // queryEvalStats: { // QueryEvalStats + * // waited: Number("int"), + * // elapsed: Number("int"), + * // cancelled: true || false, + * // subqueries: "DOCUMENT_VALUE", + * // }, + * // }; + * + * ``` + * + * @param GetOpenCypherQueryStatusCommandInput - {@link GetOpenCypherQueryStatusCommandInput} + * @returns {@link GetOpenCypherQueryStatusCommandOutput} + * @see {@link GetOpenCypherQueryStatusCommandInput} for command's `input` shape. + * @see {@link GetOpenCypherQueryStatusCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidNumericDataException} (client fault) + *Raised when invalid numerical data is encountered when servicing a request.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetOpenCypherQueryStatusCommand extends $Command< + GetOpenCypherQueryStatusCommandInput, + GetOpenCypherQueryStatusCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetOpenCypherQueryStatusCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets property graph statistics (Gremlin and openCypher).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetPropertygraphStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetPropertygraphStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = {}; + * const command = new GetPropertygraphStatisticsCommand(input); + * const response = await client.send(command); + * // { // GetPropertygraphStatisticsOutput + * // status: "STRING_VALUE", // required + * // payload: { // Statistics + * // autoCompute: true || false, + * // active: true || false, + * // statisticsId: "STRING_VALUE", + * // date: new Date("TIMESTAMP"), + * // note: "STRING_VALUE", + * // signatureInfo: { // StatisticsSummary + * // signatureCount: Number("int"), + * // instanceCount: Number("int"), + * // predicateCount: Number("int"), + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetPropertygraphStatisticsCommandInput - {@link GetPropertygraphStatisticsCommandInput} + * @returns {@link GetPropertygraphStatisticsCommandOutput} + * @see {@link GetPropertygraphStatisticsCommandInput} for command's `input` shape. + * @see {@link GetPropertygraphStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetPropertygraphStatisticsCommand extends $Command< + GetPropertygraphStatisticsCommandInput, + GetPropertygraphStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPropertygraphStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a stream for a property graph.
+ *With the Neptune Streams feature, you can generate a complete
+ * sequence of change-log entries that record every change made to your
+ * graph data as it happens. GetPropertygraphStream lets
+ * you collect these change-log entries for a property graph.
The Neptune streams feature needs to be enabled on your Neptune
+ * DBcluster. To enable streams, set the neptune_streams
+ * DB cluster parameter to 1.
See Capturing + * graph changes in real time using Neptune streams.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetPropertygraphStreamCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetPropertygraphStreamCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetPropertygraphStreamInput + * limit: Number("long"), + * iteratorType: "AT_SEQUENCE_NUMBER" || "AFTER_SEQUENCE_NUMBER" || "TRIM_HORIZON" || "LATEST", + * commitNum: Number("long"), + * opNum: Number("long"), + * encoding: "gzip", + * }; + * const command = new GetPropertygraphStreamCommand(input); + * const response = await client.send(command); + * // { // GetPropertygraphStreamOutput + * // lastEventId: { // StringValuedMap // required + * // "Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link ExpiredStreamException} (client fault) + *Raised when a request attempts to access an stream that has expired.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link StreamRecordsNotFoundException} (client fault) + *Raised when stream records requested by a query cannot be found.
+ * + * @throws {@link ThrottlingException} (server fault) + *Raised when the rate of requests exceeds the maximum throughput. Requests can + * be retried after encountering this exception.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetPropertygraphStreamCommand extends $Command< + GetPropertygraphStreamCommandInput, + GetPropertygraphStreamCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPropertygraphStreamCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a graph summary for a property graph.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetPropertygraphSummaryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetPropertygraphSummaryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetPropertygraphSummaryInput + * mode: "basic" || "detailed", + * }; + * const command = new GetPropertygraphSummaryCommand(input); + * const response = await client.send(command); + * // { // GetPropertygraphSummaryOutput + * // statusCode: Number("int"), + * // payload: { // PropertygraphSummaryValueMap + * // version: "STRING_VALUE", + * // lastStatisticsComputationTime: new Date("TIMESTAMP"), + * // graphSummary: { // PropertygraphSummary + * // numNodes: Number("long"), + * // numEdges: Number("long"), + * // numNodeLabels: Number("long"), + * // numEdgeLabels: Number("long"), + * // nodeLabels: [ // NodeLabels + * // "STRING_VALUE", + * // ], + * // edgeLabels: [ // EdgeLabels + * // "STRING_VALUE", + * // ], + * // numNodeProperties: Number("long"), + * // numEdgeProperties: Number("long"), + * // nodeProperties: [ // LongValuedMapList + * // { // LongValuedMap + * // "Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetPropertygraphSummaryCommand extends $Command< + GetPropertygraphSummaryCommandInput, + GetPropertygraphSummaryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPropertygraphSummaryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a graph summary for an RDF graph.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetRDFGraphSummaryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetRDFGraphSummaryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetRDFGraphSummaryInput + * mode: "basic" || "detailed", + * }; + * const command = new GetRDFGraphSummaryCommand(input); + * const response = await client.send(command); + * // { // GetRDFGraphSummaryOutput + * // statusCode: Number("int"), + * // payload: { // RDFGraphSummaryValueMap + * // version: "STRING_VALUE", + * // lastStatisticsComputationTime: new Date("TIMESTAMP"), + * // graphSummary: { // RDFGraphSummary + * // numDistinctSubjects: Number("long"), + * // numDistinctPredicates: Number("long"), + * // numQuads: Number("long"), + * // numClasses: Number("long"), + * // classes: [ // Classes + * // "STRING_VALUE", + * // ], + * // predicates: [ // LongValuedMapList + * // { // LongValuedMap + * // "Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetRDFGraphSummaryCommand extends $Command< + GetRDFGraphSummaryCommandInput, + GetRDFGraphSummaryCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetRDFGraphSummaryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets RDF statistics (SPARQL).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetSparqlStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetSparqlStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = {}; + * const command = new GetSparqlStatisticsCommand(input); + * const response = await client.send(command); + * // { // GetSparqlStatisticsOutput + * // status: "STRING_VALUE", // required + * // payload: { // Statistics + * // autoCompute: true || false, + * // active: true || false, + * // statisticsId: "STRING_VALUE", + * // date: new Date("TIMESTAMP"), + * // note: "STRING_VALUE", + * // signatureInfo: { // StatisticsSummary + * // signatureCount: Number("int"), + * // instanceCount: Number("int"), + * // predicateCount: Number("int"), + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetSparqlStatisticsCommandInput - {@link GetSparqlStatisticsCommandInput} + * @returns {@link GetSparqlStatisticsCommandOutput} + * @see {@link GetSparqlStatisticsCommandInput} for command's `input` shape. + * @see {@link GetSparqlStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetSparqlStatisticsCommand extends $Command< + GetSparqlStatisticsCommandInput, + GetSparqlStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetSparqlStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a stream for an RDF graph.
+ *With the Neptune Streams feature, you can generate a complete
+ * sequence of change-log entries that record every change made to your
+ * graph data as it happens. GetSparqlStream lets
+ * you collect these change-log entries for an RDF graph.
The Neptune streams feature needs to be enabled on your Neptune
+ * DBcluster. To enable streams, set the neptune_streams
+ * DB cluster parameter to 1.
See Capturing + * graph changes in real time using Neptune streams.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, GetSparqlStreamCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, GetSparqlStreamCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // GetSparqlStreamInput + * limit: Number("long"), + * iteratorType: "AT_SEQUENCE_NUMBER" || "AFTER_SEQUENCE_NUMBER" || "TRIM_HORIZON" || "LATEST", + * commitNum: Number("long"), + * opNum: Number("long"), + * encoding: "gzip", + * }; + * const command = new GetSparqlStreamCommand(input); + * const response = await client.send(command); + * // { // GetSparqlStreamOutput + * // lastEventId: { // StringValuedMap // required + * // "Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link ExpiredStreamException} (client fault) + *Raised when a request attempts to access an stream that has expired.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MemoryLimitExceededException} (server fault) + *Raised when a request fails because of insufficient memory resources. The + * request can be retried.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link StreamRecordsNotFoundException} (client fault) + *Raised when stream records requested by a query cannot be found.
+ * + * @throws {@link ThrottlingException} (server fault) + *Raised when the rate of requests exceeds the maximum throughput. Requests can + * be retried after encountering this exception.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class GetSparqlStreamCommand extends $Command< + GetSparqlStreamCommandInput, + GetSparqlStreamCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetSparqlStreamCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists active Gremlin queries. See Gremlin query + * status API for details about the output.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ListGremlinQueriesCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ListGremlinQueriesCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ListGremlinQueriesInput + * includeWaiting: true || false, + * }; + * const command = new ListGremlinQueriesCommand(input); + * const response = await client.send(command); + * // { // ListGremlinQueriesOutput + * // acceptedQueryCount: Number("int"), + * // runningQueryCount: Number("int"), + * // queries: [ // GremlinQueries + * // { // GremlinQueryStatus + * // queryId: "STRING_VALUE", + * // queryString: "STRING_VALUE", + * // queryEvalStats: { // QueryEvalStats + * // waited: Number("int"), + * // elapsed: Number("int"), + * // cancelled: true || false, + * // subqueries: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListGremlinQueriesCommandInput - {@link ListGremlinQueriesCommandInput} + * @returns {@link ListGremlinQueriesCommandOutput} + * @see {@link ListGremlinQueriesCommandInput} for command's `input` shape. + * @see {@link ListGremlinQueriesCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListGremlinQueriesCommand extends $Command< + ListGremlinQueriesCommandInput, + ListGremlinQueriesCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListGremlinQueriesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieves a list of the loadIds for all active
+ * loader jobs.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link BulkLoadIdNotFoundException} (client fault) + *Raised when a specified bulk-load job ID cannot be found.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InternalFailureException} (server fault) + *Raised when the processing of the request failed unexpectedly.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link LoadUrlAccessDeniedException} (client fault) + *Raised when access is denied to a specified load URL.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListLoaderJobsCommand extends $Command< + ListLoaderJobsCommandInput, + ListLoaderJobsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListLoaderJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of Neptune ML data processing jobs. See Listing + * active data-processing jobs using the Neptune ML dataprocessing command.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ListMLDataProcessingJobsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ListMLDataProcessingJobsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ListMLDataProcessingJobsInput + * maxItems: Number("int"), + * neptuneIamRoleArn: "STRING_VALUE", + * }; + * const command = new ListMLDataProcessingJobsCommand(input); + * const response = await client.send(command); + * // { // ListMLDataProcessingJobsOutput + * // ids: [ // StringList + * // "STRING_VALUE", + * // ], + * // }; + * + * ``` + * + * @param ListMLDataProcessingJobsCommandInput - {@link ListMLDataProcessingJobsCommandInput} + * @returns {@link ListMLDataProcessingJobsCommandOutput} + * @see {@link ListMLDataProcessingJobsCommandInput} for command's `input` shape. + * @see {@link ListMLDataProcessingJobsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListMLDataProcessingJobsCommand extends $Command< + ListMLDataProcessingJobsCommandInput, + ListMLDataProcessingJobsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMLDataProcessingJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists existing inference endpoints. See Managing + * inference endpoints using the endpoints command.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ListMLEndpointsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ListMLEndpointsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ListMLEndpointsInput + * maxItems: Number("int"), + * neptuneIamRoleArn: "STRING_VALUE", + * }; + * const command = new ListMLEndpointsCommand(input); + * const response = await client.send(command); + * // { // ListMLEndpointsOutput + * // ids: [ // StringList + * // "STRING_VALUE", + * // ], + * // }; + * + * ``` + * + * @param ListMLEndpointsCommandInput - {@link ListMLEndpointsCommandInput} + * @returns {@link ListMLEndpointsCommandOutput} + * @see {@link ListMLEndpointsCommandInput} for command's `input` shape. + * @see {@link ListMLEndpointsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListMLEndpointsCommand extends $Command< + ListMLEndpointsCommandInput, + ListMLEndpointsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMLEndpointsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists Neptune ML model-training jobs. See Model
+ * training using the modeltraining command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListMLModelTrainingJobsCommand extends $Command< + ListMLModelTrainingJobsCommandInput, + ListMLModelTrainingJobsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMLModelTrainingJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of model transform job IDs. See Use + * a trained model to generate new model artifacts.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ListMLModelTransformJobsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ListMLModelTransformJobsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ListMLModelTransformJobsInput + * maxItems: Number("int"), + * neptuneIamRoleArn: "STRING_VALUE", + * }; + * const command = new ListMLModelTransformJobsCommand(input); + * const response = await client.send(command); + * // { // ListMLModelTransformJobsOutput + * // ids: [ // StringList + * // "STRING_VALUE", + * // ], + * // }; + * + * ``` + * + * @param ListMLModelTransformJobsCommandInput - {@link ListMLModelTransformJobsCommandInput} + * @returns {@link ListMLModelTransformJobsCommandOutput} + * @see {@link ListMLModelTransformJobsCommandInput} for command's `input` shape. + * @see {@link ListMLModelTransformJobsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListMLModelTransformJobsCommand extends $Command< + ListMLModelTransformJobsCommandInput, + ListMLModelTransformJobsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMLModelTransformJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists active openCypher queries. See Neptune + * openCypher status endpoint for more information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ListOpenCypherQueriesCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ListOpenCypherQueriesCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ListOpenCypherQueriesInput + * includeWaiting: true || false, + * }; + * const command = new ListOpenCypherQueriesCommand(input); + * const response = await client.send(command); + * // { // ListOpenCypherQueriesOutput + * // acceptedQueryCount: Number("int"), + * // runningQueryCount: Number("int"), + * // queries: [ // OpenCypherQueries + * // { // GremlinQueryStatus + * // queryId: "STRING_VALUE", + * // queryString: "STRING_VALUE", + * // queryEvalStats: { // QueryEvalStats + * // waited: Number("int"), + * // elapsed: Number("int"), + * // cancelled: true || false, + * // subqueries: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListOpenCypherQueriesCommandInput - {@link ListOpenCypherQueriesCommandInput} + * @returns {@link ListOpenCypherQueriesCommandOutput} + * @see {@link ListOpenCypherQueriesCommandInput} for command's `input` shape. + * @see {@link ListOpenCypherQueriesCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConcurrentModificationException} (server fault) + *Raised when a request attempts to modify data that is concurrently being + * modified by another process.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link FailureByQueryException} (server fault) + *Raised when a request fails.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidNumericDataException} (client fault) + *Raised when invalid numerical data is encountered when servicing a request.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link ParsingException} (client fault) + *Raised when a parsing issue is encountered.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link TimeLimitExceededException} (server fault) + *Raised when the an operation exceeds the time limit allowed for it.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ListOpenCypherQueriesCommand extends $Command< + ListOpenCypherQueriesCommandInput, + ListOpenCypherQueriesCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListOpenCypherQueriesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackManages the generation and use of property graph statistics.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ManagePropertygraphStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ManagePropertygraphStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ManagePropertygraphStatisticsInput + * mode: "disableAutoCompute" || "enableAutoCompute" || "refresh", + * }; + * const command = new ManagePropertygraphStatisticsCommand(input); + * const response = await client.send(command); + * // { // ManagePropertygraphStatisticsOutput + * // status: "STRING_VALUE", // required + * // payload: { // RefreshStatisticsIdMap + * // statisticsId: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param ManagePropertygraphStatisticsCommandInput - {@link ManagePropertygraphStatisticsCommandInput} + * @returns {@link ManagePropertygraphStatisticsCommandOutput} + * @see {@link ManagePropertygraphStatisticsCommandInput} for command's `input` shape. + * @see {@link ManagePropertygraphStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ManagePropertygraphStatisticsCommand extends $Command< + ManagePropertygraphStatisticsCommandInput, + ManagePropertygraphStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ManagePropertygraphStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackManages the generation and use of RDF graph statistics.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, ManageSparqlStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, ManageSparqlStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // ManageSparqlStatisticsInput + * mode: "disableAutoCompute" || "enableAutoCompute" || "refresh", + * }; + * const command = new ManageSparqlStatisticsCommand(input); + * const response = await client.send(command); + * // { // ManageSparqlStatisticsOutput + * // status: "STRING_VALUE", // required + * // payload: { // RefreshStatisticsIdMap + * // statisticsId: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param ManageSparqlStatisticsCommandInput - {@link ManageSparqlStatisticsCommandInput} + * @returns {@link ManageSparqlStatisticsCommandOutput} + * @see {@link ManageSparqlStatisticsCommandInput} for command's `input` shape. + * @see {@link ManageSparqlStatisticsCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *Raised in case of an authentication or authorization failure.
+ * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link ReadOnlyViolationException} (client fault) + *Raised when a request attempts to write to a read-only resource.
+ * + * @throws {@link StatisticsNotAvailableException} (client fault) + *Raised when statistics needed to satisfy a request are not available.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class ManageSparqlStatisticsCommand extends $Command< + ManageSparqlStatisticsCommandInput, + ManageSparqlStatisticsCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ManageSparqlStatisticsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts a Neptune bulk loader job to load data from an Amazon S3 + * bucket into a Neptune DB instance. See Using the Amazon Neptune + * Bulk Loader to Ingest Data.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, StartLoaderJobCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, StartLoaderJobCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // StartLoaderJobInput + * source: "STRING_VALUE", // required + * format: "csv" || "opencypher" || "ntriples" || "nquads" || "rdfxml" || "turtle", // required + * s3BucketRegion: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "ca-central-1" || "sa-east-1" || "eu-north-1" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "me-south-1" || "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-south-1" || "cn-north-1" || "cn-northwest-1" || "us-gov-west-1" || "us-gov-east-1", // required + * iamRoleArn: "STRING_VALUE", // required + * mode: "RESUME" || "NEW" || "AUTO", + * failOnError: true || false, + * parallelism: "LOW" || "MEDIUM" || "HIGH" || "OVERSUBSCRIBE", + * parserConfiguration: { // StringValuedMap + * "Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link BulkLoadIdNotFoundException} (client fault) + *Raised when a specified bulk-load job ID cannot be found.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InternalFailureException} (server fault) + *Raised when the processing of the request failed unexpectedly.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link LoadUrlAccessDeniedException} (client fault) + *Raised when access is denied to a specified load URL.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link S3Exception} (client fault) + *Raised when there is a problem accessing Amazon S3.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class StartLoaderJobCommand extends $Command< + StartLoaderJobCommandInput, + StartLoaderJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartLoaderJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a new Neptune ML data processing job for processing the
+ * graph data exported from Neptune for training. See The
+ * dataprocessing command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class StartMLDataProcessingJobCommand extends $Command< + StartMLDataProcessingJobCommandInput, + StartMLDataProcessingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartMLDataProcessingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a new Neptune ML model training job. See Model
+ * training using the modeltraining command.
Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class StartMLModelTrainingJobCommand extends $Command< + StartMLModelTrainingJobCommandInput, + StartMLModelTrainingJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartMLModelTrainingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a new model transform job. See Use + * a trained model to generate new model artifacts.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptunedataClient, StartMLModelTransformJobCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import + * // const { NeptunedataClient, StartMLModelTransformJobCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import + * const client = new NeptunedataClient(config); + * const input = { // StartMLModelTransformJobInput + * id: "STRING_VALUE", + * dataProcessingJobId: "STRING_VALUE", + * mlModelTrainingJobId: "STRING_VALUE", + * trainingJobName: "STRING_VALUE", + * modelTransformOutputS3Location: "STRING_VALUE", // required + * sagemakerIamRoleArn: "STRING_VALUE", + * neptuneIamRoleArn: "STRING_VALUE", + * customModelTransformParameters: { // CustomModelTransformParameters + * sourceS3DirectoryPath: "STRING_VALUE", // required + * transformEntryPointScript: "STRING_VALUE", + * }, + * baseProcessingInstanceType: "STRING_VALUE", + * baseProcessingInstanceVolumeSizeInGB: Number("int"), + * subnets: [ // StringList + * "STRING_VALUE", + * ], + * securityGroupIds: [ + * "STRING_VALUE", + * ], + * volumeEncryptionKMSKey: "STRING_VALUE", + * s3OutputEncryptionKMSKey: "STRING_VALUE", + * }; + * const command = new StartMLModelTransformJobCommand(input); + * const response = await client.send(command); + * // { // StartMLModelTransformJobOutput + * // id: "STRING_VALUE", + * // arn: "STRING_VALUE", + * // creationTimeInMillis: Number("long"), + * // }; + * + * ``` + * + * @param StartMLModelTransformJobCommandInput - {@link StartMLModelTransformJobCommandInput} + * @returns {@link StartMLModelTransformJobCommandOutput} + * @see {@link StartMLModelTransformJobCommandInput} for command's `input` shape. + * @see {@link StartMLModelTransformJobCommandOutput} for command's `response` shape. + * @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Raised when a request is submitted that cannot be processed.
+ * + * @throws {@link ClientTimeoutException} (client fault) + *Raised when a request timed out in the client.
+ * + * @throws {@link ConstraintViolationException} (client fault) + *Raised when a value in a request field did not satisfy required constraints.
+ * + * @throws {@link IllegalArgumentException} (client fault) + *Raised when an argument in a request is not supported.
+ * + * @throws {@link InvalidArgumentException} (client fault) + *Raised when an argument in a request has an invalid value.
+ * + * @throws {@link InvalidParameterException} (client fault) + *Raised when a parameter value is not valid.
+ * + * @throws {@link MissingParameterException} (client fault) + *Raised when a required parameter is missing.
+ * + * @throws {@link MLResourceNotFoundException} (client fault) + *Raised when a specified machine-learning resource could not be found.
+ * + * @throws {@link PreconditionsFailedException} (client fault) + *Raised when a precondition for processing a request is not satisfied.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Raised when the number of requests being processed exceeds the limit.
+ * + * @throws {@link UnsupportedOperationException} (client fault) + *Raised when a request attempts to initiate an operation that is not supported.
+ * + * @throws {@link NeptunedataServiceException} + *Base exception class for all service exceptions from Neptunedata service.
+ * + */ +export class StartMLModelTransformJobCommand extends $Command< + StartMLModelTransformJobCommandInput, + StartMLModelTransformJobCommandOutput, + NeptunedataClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartMLModelTransformJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe Amazon Neptune data API provides SDK support for more than 40 of Neptune's data + * operations, including data loading, query execution, data inquiry, and machine learning. + * It supports all three Neptune query languages (Gremlin, openCypher and SPARQL), and is + * available in all SDK languages. It automatically signs API requests and greatly simplifies + * integrating Neptune into your applications.
+ * + * @packageDocumentation + */ +export * from "./NeptunedataClient"; +export * from "./Neptunedata"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export * from "./commands"; +export * from "./models"; + +export { NeptunedataServiceException } from "./models/NeptunedataServiceException"; diff --git a/clients/client-neptunedata/src/models/NeptunedataServiceException.ts b/clients/client-neptunedata/src/models/NeptunedataServiceException.ts new file mode 100644 index 0000000000000..c11fd21d95fb9 --- /dev/null +++ b/clients/client-neptunedata/src/models/NeptunedataServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export { __ServiceException, __ServiceExceptionOptions }; + +/** + * @public + * + * Base exception class for all service exceptions from Neptunedata service. + */ +export class NeptunedataServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, NeptunedataServiceException.prototype); + } +} diff --git a/clients/client-neptunedata/src/models/index.ts b/clients/client-neptunedata/src/models/index.ts new file mode 100644 index 0000000000000..9eaceb12865f8 --- /dev/null +++ b/clients/client-neptunedata/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-neptunedata/src/models/models_0.ts b/clients/client-neptunedata/src/models/models_0.ts new file mode 100644 index 0000000000000..66bdc0e5114a7 --- /dev/null +++ b/clients/client-neptunedata/src/models/models_0.ts @@ -0,0 +1,4831 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; +import { DocumentType as __DocumentType } from "@smithy/types"; + +import { NeptunedataServiceException as __BaseException } from "./NeptunedataServiceException"; + +/** + * @public + *Raised in case of an authentication or authorization failure.
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRaised when a request is submitted that cannot be processed.
+ */ +export class BadRequestException extends __BaseException { + readonly name: "BadRequestException" = "BadRequestException"; + readonly $fault: "client" = "client"; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the bad request.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe unique identifier that identifies the query to be canceled.
+ */ + queryId: string | undefined; +} + +/** + * @public + */ +export interface CancelGremlinQueryOutput { + /** + * @public + *The status of the cancelation
+ */ + status?: string; +} + +/** + * @public + *Raised when a request timed out in the client.
+ */ +export class ClientTimeoutException extends __BaseException { + readonly name: "ClientTimeoutException" = "ClientTimeoutException"; + readonly $fault: "client" = "client"; + $retryable = {}; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRaised when a request attempts to modify data that is concurrently being + * modified by another process.
+ */ +export class ConcurrentModificationException extends __BaseException { + readonly name: "ConcurrentModificationException" = "ConcurrentModificationException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRaised when a value in a request field did not satisfy required constraints.
+ */ +export class ConstraintViolationException extends __BaseException { + readonly name: "ConstraintViolationException" = "ConstraintViolationException"; + readonly $fault: "client" = "client"; + $retryable = {}; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRaised when a request fails.
+ */ +export class FailureByQueryException extends __BaseException { + readonly name: "FailureByQueryException" = "FailureByQueryException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRaised when an argument in a request is not supported.
+ */ +export class IllegalArgumentException extends __BaseException { + readonly name: "IllegalArgumentException" = "IllegalArgumentException"; + readonly $fault: "client" = "client"; + /** + * @public + *A detailed message describing the problem.
+ */ + detailedMessage: string | undefined; + + /** + * @public + *The ID of the request in question.
+ */ + requestId: string | undefined; + + /** + * @public + *The HTTP status code returned with the exception.
+ */ + code: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType