@aws-sdk/client-neptune-graph 3.876.0 → 3.877.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +17 -3
  2. package/dist-cjs/index.js +175 -12
  3. package/dist-es/NeptuneGraph.js +4 -0
  4. package/dist-es/commands/StartGraphCommand.js +25 -0
  5. package/dist-es/commands/StopGraphCommand.js +25 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +3 -0
  8. package/dist-es/protocols/Aws_restJson1.js +74 -0
  9. package/dist-es/waiters/index.js +1 -0
  10. package/dist-es/waiters/waitForGraphStopped.js +40 -0
  11. package/dist-types/NeptuneGraph.d.ts +15 -3
  12. package/dist-types/NeptuneGraphClient.d.ts +5 -5
  13. package/dist-types/commands/CreateGraphCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +1 -5
  15. package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +1 -5
  16. package/dist-types/commands/DeleteGraphCommand.d.ts +1 -1
  17. package/dist-types/commands/ExecuteQueryCommand.d.ts +1 -16
  18. package/dist-types/commands/GetGraphCommand.d.ts +1 -1
  19. package/dist-types/commands/GetQueryCommand.d.ts +1 -7
  20. package/dist-types/commands/ListGraphsCommand.d.ts +1 -1
  21. package/dist-types/commands/ResetGraphCommand.d.ts +1 -1
  22. package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +1 -1
  23. package/dist-types/commands/StartGraphCommand.d.ts +103 -0
  24. package/dist-types/commands/StopGraphCommand.d.ts +103 -0
  25. package/dist-types/commands/UpdateGraphCommand.d.ts +1 -1
  26. package/dist-types/commands/index.d.ts +2 -0
  27. package/dist-types/index.d.ts +1 -3
  28. package/dist-types/models/models_0.d.ts +268 -338
  29. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  30. package/dist-types/ts3.4/NeptuneGraph.d.ts +34 -0
  31. package/dist-types/ts3.4/NeptuneGraphClient.d.ts +12 -0
  32. package/dist-types/ts3.4/commands/StartGraphCommand.d.ts +47 -0
  33. package/dist-types/ts3.4/commands/StopGraphCommand.d.ts +47 -0
  34. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +43 -0
  36. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  37. package/dist-types/ts3.4/waiters/index.d.ts +1 -0
  38. package/dist-types/ts3.4/waiters/waitForGraphStopped.d.ts +11 -0
  39. package/dist-types/waiters/index.d.ts +1 -0
  40. package/dist-types/waiters/waitForGraphStopped.d.ts +14 -0
  41. package/package.json +1 -1
@@ -27,7 +27,9 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
27
27
  import { ResetGraphCommandInput, ResetGraphCommandOutput } from "./commands/ResetGraphCommand";
28
28
  import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput } from "./commands/RestoreGraphFromSnapshotCommand";
29
29
  import { StartExportTaskCommandInput, StartExportTaskCommandOutput } from "./commands/StartExportTaskCommand";
30
+ import { StartGraphCommandInput, StartGraphCommandOutput } from "./commands/StartGraphCommand";
30
31
  import { StartImportTaskCommandInput, StartImportTaskCommandOutput } from "./commands/StartImportTaskCommand";
32
+ import { StopGraphCommandInput, StopGraphCommandOutput } from "./commands/StopGraphCommand";
31
33
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
32
34
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
33
35
  import { UpdateGraphCommandInput, UpdateGraphCommandOutput } from "./commands/UpdateGraphCommand";
@@ -205,12 +207,24 @@ export interface NeptuneGraph {
205
207
  startExportTask(args: StartExportTaskCommandInput, options?: __HttpHandlerOptions): Promise<StartExportTaskCommandOutput>;
206
208
  startExportTask(args: StartExportTaskCommandInput, cb: (err: any, data?: StartExportTaskCommandOutput) => void): void;
207
209
  startExportTask(args: StartExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExportTaskCommandOutput) => void): void;
210
+ /**
211
+ * @see {@link StartGraphCommand}
212
+ */
213
+ startGraph(args: StartGraphCommandInput, options?: __HttpHandlerOptions): Promise<StartGraphCommandOutput>;
214
+ startGraph(args: StartGraphCommandInput, cb: (err: any, data?: StartGraphCommandOutput) => void): void;
215
+ startGraph(args: StartGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGraphCommandOutput) => void): void;
208
216
  /**
209
217
  * @see {@link StartImportTaskCommand}
210
218
  */
211
219
  startImportTask(args: StartImportTaskCommandInput, options?: __HttpHandlerOptions): Promise<StartImportTaskCommandOutput>;
212
220
  startImportTask(args: StartImportTaskCommandInput, cb: (err: any, data?: StartImportTaskCommandOutput) => void): void;
213
221
  startImportTask(args: StartImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportTaskCommandOutput) => void): void;
222
+ /**
223
+ * @see {@link StopGraphCommand}
224
+ */
225
+ stopGraph(args: StopGraphCommandInput, options?: __HttpHandlerOptions): Promise<StopGraphCommandOutput>;
226
+ stopGraph(args: StopGraphCommandInput, cb: (err: any, data?: StopGraphCommandOutput) => void): void;
227
+ stopGraph(args: StopGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopGraphCommandOutput) => void): void;
214
228
  /**
215
229
  * @see {@link TagResourceCommand}
216
230
  */
@@ -231,9 +245,7 @@ export interface NeptuneGraph {
231
245
  updateGraph(args: UpdateGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGraphCommandOutput) => void): void;
232
246
  }
233
247
  /**
234
- * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to
235
- * insights faster by quickly processing large amounts of graph data, invoking popular graph analytic
236
- * algorithms in low-latency queries, and getting analytics results in seconds.</p>
248
+ * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.</p>
237
249
  * @public
238
250
  */
239
251
  export declare class NeptuneGraph extends NeptuneGraphClient implements NeptuneGraph {
@@ -35,7 +35,9 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
35
35
  import { ResetGraphCommandInput, ResetGraphCommandOutput } from "./commands/ResetGraphCommand";
36
36
  import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput } from "./commands/RestoreGraphFromSnapshotCommand";
37
37
  import { StartExportTaskCommandInput, StartExportTaskCommandOutput } from "./commands/StartExportTaskCommand";
38
+ import { StartGraphCommandInput, StartGraphCommandOutput } from "./commands/StartGraphCommand";
38
39
  import { StartImportTaskCommandInput, StartImportTaskCommandOutput } from "./commands/StartImportTaskCommand";
40
+ import { StopGraphCommandInput, StopGraphCommandOutput } from "./commands/StopGraphCommand";
39
41
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
40
42
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
41
43
  import { UpdateGraphCommandInput, UpdateGraphCommandOutput } from "./commands/UpdateGraphCommand";
@@ -45,11 +47,11 @@ export { __Client };
45
47
  /**
46
48
  * @public
47
49
  */
48
- export type ServiceInputTypes = CancelExportTaskCommandInput | CancelImportTaskCommandInput | CancelQueryCommandInput | CreateGraphCommandInput | CreateGraphSnapshotCommandInput | CreateGraphUsingImportTaskCommandInput | CreatePrivateGraphEndpointCommandInput | DeleteGraphCommandInput | DeleteGraphSnapshotCommandInput | DeletePrivateGraphEndpointCommandInput | ExecuteQueryCommandInput | GetExportTaskCommandInput | GetGraphCommandInput | GetGraphSnapshotCommandInput | GetGraphSummaryCommandInput | GetImportTaskCommandInput | GetPrivateGraphEndpointCommandInput | GetQueryCommandInput | ListExportTasksCommandInput | ListGraphSnapshotsCommandInput | ListGraphsCommandInput | ListImportTasksCommandInput | ListPrivateGraphEndpointsCommandInput | ListQueriesCommandInput | ListTagsForResourceCommandInput | ResetGraphCommandInput | RestoreGraphFromSnapshotCommandInput | StartExportTaskCommandInput | StartImportTaskCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGraphCommandInput;
50
+ export type ServiceInputTypes = CancelExportTaskCommandInput | CancelImportTaskCommandInput | CancelQueryCommandInput | CreateGraphCommandInput | CreateGraphSnapshotCommandInput | CreateGraphUsingImportTaskCommandInput | CreatePrivateGraphEndpointCommandInput | DeleteGraphCommandInput | DeleteGraphSnapshotCommandInput | DeletePrivateGraphEndpointCommandInput | ExecuteQueryCommandInput | GetExportTaskCommandInput | GetGraphCommandInput | GetGraphSnapshotCommandInput | GetGraphSummaryCommandInput | GetImportTaskCommandInput | GetPrivateGraphEndpointCommandInput | GetQueryCommandInput | ListExportTasksCommandInput | ListGraphSnapshotsCommandInput | ListGraphsCommandInput | ListImportTasksCommandInput | ListPrivateGraphEndpointsCommandInput | ListQueriesCommandInput | ListTagsForResourceCommandInput | ResetGraphCommandInput | RestoreGraphFromSnapshotCommandInput | StartExportTaskCommandInput | StartGraphCommandInput | StartImportTaskCommandInput | StopGraphCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGraphCommandInput;
49
51
  /**
50
52
  * @public
51
53
  */
52
- export type ServiceOutputTypes = CancelExportTaskCommandOutput | CancelImportTaskCommandOutput | CancelQueryCommandOutput | CreateGraphCommandOutput | CreateGraphSnapshotCommandOutput | CreateGraphUsingImportTaskCommandOutput | CreatePrivateGraphEndpointCommandOutput | DeleteGraphCommandOutput | DeleteGraphSnapshotCommandOutput | DeletePrivateGraphEndpointCommandOutput | ExecuteQueryCommandOutput | GetExportTaskCommandOutput | GetGraphCommandOutput | GetGraphSnapshotCommandOutput | GetGraphSummaryCommandOutput | GetImportTaskCommandOutput | GetPrivateGraphEndpointCommandOutput | GetQueryCommandOutput | ListExportTasksCommandOutput | ListGraphSnapshotsCommandOutput | ListGraphsCommandOutput | ListImportTasksCommandOutput | ListPrivateGraphEndpointsCommandOutput | ListQueriesCommandOutput | ListTagsForResourceCommandOutput | ResetGraphCommandOutput | RestoreGraphFromSnapshotCommandOutput | StartExportTaskCommandOutput | StartImportTaskCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGraphCommandOutput;
54
+ export type ServiceOutputTypes = CancelExportTaskCommandOutput | CancelImportTaskCommandOutput | CancelQueryCommandOutput | CreateGraphCommandOutput | CreateGraphSnapshotCommandOutput | CreateGraphUsingImportTaskCommandOutput | CreatePrivateGraphEndpointCommandOutput | DeleteGraphCommandOutput | DeleteGraphSnapshotCommandOutput | DeletePrivateGraphEndpointCommandOutput | ExecuteQueryCommandOutput | GetExportTaskCommandOutput | GetGraphCommandOutput | GetGraphSnapshotCommandOutput | GetGraphSummaryCommandOutput | GetImportTaskCommandOutput | GetPrivateGraphEndpointCommandOutput | GetQueryCommandOutput | ListExportTasksCommandOutput | ListGraphSnapshotsCommandOutput | ListGraphsCommandOutput | ListImportTasksCommandOutput | ListPrivateGraphEndpointsCommandOutput | ListQueriesCommandOutput | ListTagsForResourceCommandOutput | ResetGraphCommandOutput | RestoreGraphFromSnapshotCommandOutput | StartExportTaskCommandOutput | StartGraphCommandOutput | StartImportTaskCommandOutput | StopGraphCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGraphCommandOutput;
53
55
  /**
54
56
  * @public
55
57
  */
@@ -206,9 +208,7 @@ export type NeptuneGraphClientResolvedConfigType = __SmithyResolvedConfiguration
206
208
  export interface NeptuneGraphClientResolvedConfig extends NeptuneGraphClientResolvedConfigType {
207
209
  }
208
210
  /**
209
- * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to
210
- * insights faster by quickly processing large amounts of graph data, invoking popular graph analytic
211
- * algorithms in low-latency queries, and getting analytics results in seconds.</p>
211
+ * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.</p>
212
212
  * @public
213
213
  */
214
214
  export declare class NeptuneGraphClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, NeptuneGraphClientResolvedConfig> {
@@ -54,7 +54,7 @@ declare const CreateGraphCommand_base: {
54
54
  * // id: "STRING_VALUE", // required
55
55
  * // name: "STRING_VALUE", // required
56
56
  * // arn: "STRING_VALUE", // required
57
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
57
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
58
58
  * // statusReason: "STRING_VALUE",
59
59
  * // createTime: new Date("TIMESTAMP"),
60
60
  * // provisionedMemory: Number("int"),
@@ -27,11 +27,7 @@ declare const CreateGraphUsingImportTaskCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database
31
- * or a Neptune database snapshot.</p>
32
- * <p>The data can be loaded from files in S3 that in either the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV
33
- * format</a> or the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
34
- * load format</a>.</p>
30
+ * <p>Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.</p> <p>The data can be loaded from files in S3 that in either the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV format</a> or the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher load format</a>.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const CreatePrivateGraphEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a private graph endpoint to allow private access from to the graph from within
31
- * a VPC. You can attach security groups to the private graph endpoint.</p>
32
- * <note>
33
- * <p>VPC endpoint charges apply.</p>
34
- * </note>
30
+ * <p>Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.</p> <note> <p>VPC endpoint charges apply.</p> </note>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -44,7 +44,7 @@ declare const DeleteGraphCommand_base: {
44
44
  * // id: "STRING_VALUE", // required
45
45
  * // name: "STRING_VALUE", // required
46
46
  * // arn: "STRING_VALUE", // required
47
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
47
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
48
48
  * // statusReason: "STRING_VALUE",
49
49
  * // createTime: new Date("TIMESTAMP"),
50
50
  * // provisionedMemory: Number("int"),
@@ -28,22 +28,7 @@ declare const ExecuteQueryCommand_base: {
28
28
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
29
  };
30
30
  /**
31
- * <p>Execute an openCypher query.</p>
32
- * <p>
33
- * When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached
34
- * that allows one of the following IAM actions in that cluster, depending on the query:
35
- * </p>
36
- * <ul>
37
- * <li>
38
- * <p>neptune-graph:ReadDataViaQuery</p>
39
- * </li>
40
- * <li>
41
- * <p>neptune-graph:WriteDataViaQuery</p>
42
- * </li>
43
- * <li>
44
- * <p>neptune-graph:DeleteDataViaQuery</p>
45
- * </li>
46
- * </ul>
31
+ * <p>Execute an openCypher query.</p> <p> When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query: </p> <ul> <li> <p>neptune-graph:ReadDataViaQuery</p> </li> <li> <p>neptune-graph:WriteDataViaQuery</p> </li> <li> <p>neptune-graph:DeleteDataViaQuery</p> </li> </ul>
47
32
  * @example
48
33
  * Use a bare-bones client and the command you need to make an API call.
49
34
  * ```javascript
@@ -43,7 +43,7 @@ declare const GetGraphCommand_base: {
43
43
  * // id: "STRING_VALUE", // required
44
44
  * // name: "STRING_VALUE", // required
45
45
  * // arn: "STRING_VALUE", // required
46
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
46
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
47
47
  * // statusReason: "STRING_VALUE",
48
48
  * // createTime: new Date("TIMESTAMP"),
49
49
  * // provisionedMemory: Number("int"),
@@ -27,13 +27,7 @@ declare const GetQueryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the status of a specified query.</p>
31
- * <note>
32
- * <p>
33
- * When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the
34
- * <code>neptune-graph:GetQueryStatus</code> IAM action attached.
35
- * </p>
36
- * </note>
30
+ * <p>Retrieves the status of a specified query.</p> <note> <p> When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the <code>neptune-graph:GetQueryStatus</code> IAM action attached. </p> </note>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -46,7 +46,7 @@ declare const ListGraphsCommand_base: {
46
46
  * // id: "STRING_VALUE", // required
47
47
  * // name: "STRING_VALUE", // required
48
48
  * // arn: "STRING_VALUE", // required
49
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
49
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
50
50
  * // provisionedMemory: Number("int"),
51
51
  * // publicConnectivity: true || false,
52
52
  * // endpoint: "STRING_VALUE",
@@ -44,7 +44,7 @@ declare const ResetGraphCommand_base: {
44
44
  * // id: "STRING_VALUE", // required
45
45
  * // name: "STRING_VALUE", // required
46
46
  * // arn: "STRING_VALUE", // required
47
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
47
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
48
48
  * // statusReason: "STRING_VALUE",
49
49
  * // createTime: new Date("TIMESTAMP"),
50
50
  * // provisionedMemory: Number("int"),
@@ -51,7 +51,7 @@ declare const RestoreGraphFromSnapshotCommand_base: {
51
51
  * // id: "STRING_VALUE", // required
52
52
  * // name: "STRING_VALUE", // required
53
53
  * // arn: "STRING_VALUE", // required
54
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
54
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
55
55
  * // statusReason: "STRING_VALUE",
56
56
  * // createTime: new Date("TIMESTAMP"),
57
57
  * // provisionedMemory: Number("int"),
@@ -0,0 +1,103 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StartGraphInput, StartGraphOutput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartGraphCommand}.
14
+ */
15
+ export interface StartGraphCommandInput extends StartGraphInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartGraphCommand}.
21
+ */
22
+ export interface StartGraphCommandOutput extends StartGraphOutput, __MetadataBearer {
23
+ }
24
+ declare const StartGraphCommand_base: {
25
+ new (input: StartGraphCommandInput): import("@smithy/smithy-client").CommandImpl<StartGraphCommandInput, StartGraphCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartGraphCommandInput): import("@smithy/smithy-client").CommandImpl<StartGraphCommandInput, StartGraphCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Starts the specific graph.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NeptuneGraphClient, StartGraphCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
35
+ * // const { NeptuneGraphClient, StartGraphCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
36
+ * const client = new NeptuneGraphClient(config);
37
+ * const input = { // StartGraphInput
38
+ * graphIdentifier: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new StartGraphCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // StartGraphOutput
43
+ * // id: "STRING_VALUE", // required
44
+ * // name: "STRING_VALUE", // required
45
+ * // arn: "STRING_VALUE", // required
46
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
47
+ * // statusReason: "STRING_VALUE",
48
+ * // createTime: new Date("TIMESTAMP"),
49
+ * // provisionedMemory: Number("int"),
50
+ * // endpoint: "STRING_VALUE",
51
+ * // publicConnectivity: true || false,
52
+ * // vectorSearchConfiguration: { // VectorSearchConfiguration
53
+ * // dimension: Number("int"), // required
54
+ * // },
55
+ * // replicaCount: Number("int"),
56
+ * // kmsKeyIdentifier: "STRING_VALUE",
57
+ * // sourceSnapshotId: "STRING_VALUE",
58
+ * // deletionProtection: true || false,
59
+ * // buildNumber: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param StartGraphCommandInput - {@link StartGraphCommandInput}
65
+ * @returns {@link StartGraphCommandOutput}
66
+ * @see {@link StartGraphCommandInput} for command's `input` shape.
67
+ * @see {@link StartGraphCommandOutput} for command's `response` shape.
68
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
69
+ *
70
+ * @throws {@link ConflictException} (client fault)
71
+ * <p>Raised when a conflict is encountered.</p>
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>A failure occurred on the server.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>A specified resource could not be located.</p>
78
+ *
79
+ * @throws {@link ThrottlingException} (client fault)
80
+ * <p>The exception was interrupted by throttling.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>A resource could not be validated.</p>
84
+ *
85
+ * @throws {@link NeptuneGraphServiceException}
86
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
87
+ *
88
+ *
89
+ * @public
90
+ */
91
+ export declare class StartGraphCommand extends StartGraphCommand_base {
92
+ /** @internal type navigation helper, not in runtime. */
93
+ protected static __types: {
94
+ api: {
95
+ input: StartGraphInput;
96
+ output: StartGraphOutput;
97
+ };
98
+ sdk: {
99
+ input: StartGraphCommandInput;
100
+ output: StartGraphCommandOutput;
101
+ };
102
+ };
103
+ }
@@ -0,0 +1,103 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StopGraphInput, StopGraphOutput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopGraphCommand}.
14
+ */
15
+ export interface StopGraphCommandInput extends StopGraphInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopGraphCommand}.
21
+ */
22
+ export interface StopGraphCommandOutput extends StopGraphOutput, __MetadataBearer {
23
+ }
24
+ declare const StopGraphCommand_base: {
25
+ new (input: StopGraphCommandInput): import("@smithy/smithy-client").CommandImpl<StopGraphCommandInput, StopGraphCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StopGraphCommandInput): import("@smithy/smithy-client").CommandImpl<StopGraphCommandInput, StopGraphCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Stops the specific graph.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NeptuneGraphClient, StopGraphCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
35
+ * // const { NeptuneGraphClient, StopGraphCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
36
+ * const client = new NeptuneGraphClient(config);
37
+ * const input = { // StopGraphInput
38
+ * graphIdentifier: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new StopGraphCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // StopGraphOutput
43
+ * // id: "STRING_VALUE", // required
44
+ * // name: "STRING_VALUE", // required
45
+ * // arn: "STRING_VALUE", // required
46
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
47
+ * // statusReason: "STRING_VALUE",
48
+ * // createTime: new Date("TIMESTAMP"),
49
+ * // provisionedMemory: Number("int"),
50
+ * // endpoint: "STRING_VALUE",
51
+ * // publicConnectivity: true || false,
52
+ * // vectorSearchConfiguration: { // VectorSearchConfiguration
53
+ * // dimension: Number("int"), // required
54
+ * // },
55
+ * // replicaCount: Number("int"),
56
+ * // kmsKeyIdentifier: "STRING_VALUE",
57
+ * // sourceSnapshotId: "STRING_VALUE",
58
+ * // deletionProtection: true || false,
59
+ * // buildNumber: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param StopGraphCommandInput - {@link StopGraphCommandInput}
65
+ * @returns {@link StopGraphCommandOutput}
66
+ * @see {@link StopGraphCommandInput} for command's `input` shape.
67
+ * @see {@link StopGraphCommandOutput} for command's `response` shape.
68
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
69
+ *
70
+ * @throws {@link ConflictException} (client fault)
71
+ * <p>Raised when a conflict is encountered.</p>
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>A failure occurred on the server.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>A specified resource could not be located.</p>
78
+ *
79
+ * @throws {@link ThrottlingException} (client fault)
80
+ * <p>The exception was interrupted by throttling.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>A resource could not be validated.</p>
84
+ *
85
+ * @throws {@link NeptuneGraphServiceException}
86
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
87
+ *
88
+ *
89
+ * @public
90
+ */
91
+ export declare class StopGraphCommand extends StopGraphCommand_base {
92
+ /** @internal type navigation helper, not in runtime. */
93
+ protected static __types: {
94
+ api: {
95
+ input: StopGraphInput;
96
+ output: StopGraphOutput;
97
+ };
98
+ sdk: {
99
+ input: StopGraphCommandInput;
100
+ output: StopGraphCommandOutput;
101
+ };
102
+ };
103
+ }
@@ -46,7 +46,7 @@ declare const UpdateGraphCommand_base: {
46
46
  * // id: "STRING_VALUE", // required
47
47
  * // name: "STRING_VALUE", // required
48
48
  * // arn: "STRING_VALUE", // required
49
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
49
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING" || "STARTING" || "STOPPING" || "STOPPED",
50
50
  * // statusReason: "STRING_VALUE",
51
51
  * // createTime: new Date("TIMESTAMP"),
52
52
  * // provisionedMemory: Number("int"),
@@ -26,7 +26,9 @@ export * from "./ListTagsForResourceCommand";
26
26
  export * from "./ResetGraphCommand";
27
27
  export * from "./RestoreGraphFromSnapshotCommand";
28
28
  export * from "./StartExportTaskCommand";
29
+ export * from "./StartGraphCommand";
29
30
  export * from "./StartImportTaskCommand";
31
+ export * from "./StopGraphCommand";
30
32
  export * from "./TagResourceCommand";
31
33
  export * from "./UntagResourceCommand";
32
34
  export * from "./UpdateGraphCommand";
@@ -1,7 +1,5 @@
1
1
  /**
2
- * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to
3
- * insights faster by quickly processing large amounts of graph data, invoking popular graph analytic
4
- * algorithms in low-latency queries, and getting analytics results in seconds.</p>
2
+ * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.</p>
5
3
  *
6
4
  * @packageDocumentation
7
5
  */