@aws-sdk/client-neptunedata 3.1157.0 → 3.1159.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.
- package/README.md +42 -7
- package/dist-cjs/index.js +333 -58
- package/dist-es/Neptunedata.js +10 -0
- package/dist-es/commands/CancelIndexRebuildCommand.js +4 -0
- package/dist-es/commands/GetIndexRebuildStatusCommand.js +4 -0
- package/dist-es/commands/GetStorageInfoCommand.js +4 -0
- package/dist-es/commands/ListIndexRebuildsCommand.js +4 -0
- package/dist-es/commands/StartIndexRebuildCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +18 -0
- package/dist-es/models/errors.js +109 -51
- package/dist-es/schemas/schemas_0.js +155 -7
- package/dist-types/Neptunedata.d.ts +38 -0
- package/dist-types/NeptunedataClient.d.ts +7 -2
- package/dist-types/commands/CancelIndexRebuildCommand.d.ts +121 -0
- package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +3 -0
- package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +3 -0
- package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +3 -0
- package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +3 -0
- package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +3 -0
- package/dist-types/commands/GetIndexRebuildStatusCommand.d.ts +115 -0
- package/dist-types/commands/GetStorageInfoCommand.d.ts +148 -0
- package/dist-types/commands/ListIndexRebuildsCommand.d.ts +104 -0
- package/dist-types/commands/StartIndexRebuildCommand.d.ts +126 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +78 -0
- package/dist-types/models/errors.d.ts +126 -41
- package/dist-types/models/models_0.d.ts +296 -1
- package/dist-types/schemas/schemas_0.d.ts +21 -0
- package/dist-types/ts3.4/Neptunedata.d.ts +88 -0
- package/dist-types/ts3.4/NeptunedataClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CancelIndexRebuildCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetIndexRebuildStatusCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetStorageInfoCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListIndexRebuildsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartIndexRebuildCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/enums.d.ts +21 -0
- package/dist-types/ts3.4/models/errors.d.ts +58 -30
- package/dist-types/ts3.4/models/models_0.d.ts +74 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +21 -0
- package/package.json +3 -3
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelIndexRebuildInput, CancelIndexRebuildOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelIndexRebuildCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelIndexRebuildCommandInput extends CancelIndexRebuildInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelIndexRebuildCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelIndexRebuildCommandOutput extends CancelIndexRebuildOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelIndexRebuildCommand_base: {
|
|
22
|
+
new (input: CancelIndexRebuildCommandInput): import("@smithy/core/client").CommandImpl<CancelIndexRebuildCommandInput, CancelIndexRebuildCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelIndexRebuildCommandInput): import("@smithy/core/client").CommandImpl<CancelIndexRebuildCommandInput, CancelIndexRebuildCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels an in-progress index rebuild operation.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelindexrebuild">neptune-db:CancelIndexRebuild</a> IAM action in that cluster.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { NeptunedataClient, CancelIndexRebuildCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
32
|
+
* // const { NeptunedataClient, CancelIndexRebuildCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
33
|
+
* // import type { NeptunedataClientConfig } from "@aws-sdk/client-neptunedata";
|
|
34
|
+
* const config = {}; // type is NeptunedataClientConfig
|
|
35
|
+
* const client = new NeptunedataClient(config);
|
|
36
|
+
* const input = { // CancelIndexRebuildInput
|
|
37
|
+
* rebuildId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new CancelIndexRebuildCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // CancelIndexRebuildOutput
|
|
42
|
+
* // status: "PREPARING" || "REBUILDING" || "COMPLETED" || "FAILED" || "CANCELLED" || "CANCELLING", // required
|
|
43
|
+
* // concurrency: Number("int"), // required
|
|
44
|
+
* // writeBufferSize: "LOW" || "MEDIUM" || "HIGH", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param CancelIndexRebuildCommandInput - {@link CancelIndexRebuildCommandInput}
|
|
50
|
+
* @returns {@link CancelIndexRebuildCommandOutput}
|
|
51
|
+
* @see {@link CancelIndexRebuildCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link CancelIndexRebuildCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
59
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link CancelledByUserException} (server fault)
|
|
62
|
+
* <p>Raised when a user cancelled a request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
65
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
68
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
71
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
74
|
+
* <p>Raised when the processing of the request failed unexpectedly.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
77
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
80
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
83
|
+
* <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
86
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ReadOnlyViolationException} (client fault)
|
|
89
|
+
* <p>Raised when a request attempts to write to a read-only resource.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ServerShutdownException} (server fault)
|
|
92
|
+
* <p>Raised when the server shuts down while processing a request.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
95
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
98
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ValidationException} (client fault)
|
|
101
|
+
* <p>Raised when a parameter value is not valid or is malformed.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link NeptunedataServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
105
|
+
*
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class CancelIndexRebuildCommand extends CancelIndexRebuildCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: CancelIndexRebuildInput;
|
|
114
|
+
output: CancelIndexRebuildOutput;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: CancelIndexRebuildCommandInput;
|
|
118
|
+
output: CancelIndexRebuildCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -60,6 +60,9 @@ declare const ExecuteGremlinExplainQueryCommand_base: {
|
|
|
60
60
|
* @throws {@link BadRequestException} (client fault)
|
|
61
61
|
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
62
62
|
*
|
|
63
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
64
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
65
|
+
*
|
|
63
66
|
* @throws {@link CancelledByUserException} (server fault)
|
|
64
67
|
* <p>Raised when a user cancelled a request.</p>
|
|
65
68
|
*
|
|
@@ -64,6 +64,9 @@ declare const ExecuteGremlinProfileQueryCommand_base: {
|
|
|
64
64
|
* @throws {@link BadRequestException} (client fault)
|
|
65
65
|
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
68
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
69
|
+
*
|
|
67
70
|
* @throws {@link CancelledByUserException} (server fault)
|
|
68
71
|
* <p>Raised when a user cancelled a request.</p>
|
|
69
72
|
*
|
|
@@ -61,6 +61,9 @@ declare const ExecuteGremlinQueryCommand_base: {
|
|
|
61
61
|
* @throws {@link BadRequestException} (client fault)
|
|
62
62
|
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
63
63
|
*
|
|
64
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
65
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
66
|
+
*
|
|
64
67
|
* @throws {@link CancelledByUserException} (server fault)
|
|
65
68
|
* <p>Raised when a user cancelled a request.</p>
|
|
66
69
|
*
|
|
@@ -62,6 +62,9 @@ declare const ExecuteOpenCypherExplainQueryCommand_base: {
|
|
|
62
62
|
* @throws {@link BadRequestException} (client fault)
|
|
63
63
|
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
64
64
|
*
|
|
65
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
66
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
67
|
+
*
|
|
65
68
|
* @throws {@link CancelledByUserException} (server fault)
|
|
66
69
|
* <p>Raised when a user cancelled a request.</p>
|
|
67
70
|
*
|
|
@@ -54,6 +54,9 @@ declare const ExecuteOpenCypherQueryCommand_base: {
|
|
|
54
54
|
* @throws {@link BadRequestException} (client fault)
|
|
55
55
|
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
56
56
|
*
|
|
57
|
+
* @throws {@link CancelledByMaintenanceException} (server fault)
|
|
58
|
+
* <p>Raised when a request is cancelled because the storage layer entered maintenance mode. This typically happens during a customer-initiated operation such as an index rebuild. It should be treated like <code>ConcurrentModificationException</code>.</p>
|
|
59
|
+
*
|
|
57
60
|
* @throws {@link CancelledByUserException} (server fault)
|
|
58
61
|
* <p>Raised when a user cancelled a request.</p>
|
|
59
62
|
*
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetIndexRebuildStatusInput, GetIndexRebuildStatusOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetIndexRebuildStatusCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetIndexRebuildStatusCommandInput extends GetIndexRebuildStatusInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetIndexRebuildStatusCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetIndexRebuildStatusCommandOutput extends GetIndexRebuildStatusOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetIndexRebuildStatusCommand_base: {
|
|
22
|
+
new (input: GetIndexRebuildStatusCommandInput): import("@smithy/core/client").CommandImpl<GetIndexRebuildStatusCommandInput, GetIndexRebuildStatusCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetIndexRebuildStatusCommandInput): import("@smithy/core/client").CommandImpl<GetIndexRebuildStatusCommandInput, GetIndexRebuildStatusCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the status of an index rebuild operation.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getindexrebuildstatus">neptune-db:GetIndexRebuildStatus</a> IAM action in that cluster.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { NeptunedataClient, GetIndexRebuildStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
32
|
+
* // const { NeptunedataClient, GetIndexRebuildStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
33
|
+
* // import type { NeptunedataClientConfig } from "@aws-sdk/client-neptunedata";
|
|
34
|
+
* const config = {}; // type is NeptunedataClientConfig
|
|
35
|
+
* const client = new NeptunedataClient(config);
|
|
36
|
+
* const input = { // GetIndexRebuildStatusInput
|
|
37
|
+
* rebuildId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetIndexRebuildStatusCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetIndexRebuildStatusOutput
|
|
42
|
+
* // status: "PREPARING" || "REBUILDING" || "COMPLETED" || "FAILED" || "CANCELLED" || "CANCELLING", // required
|
|
43
|
+
* // scope: "ALL" || "QUADS" || "DICTIONARIES", // required
|
|
44
|
+
* // concurrency: Number("int"), // required
|
|
45
|
+
* // writeBufferSize: "LOW" || "MEDIUM" || "HIGH", // required
|
|
46
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
47
|
+
* // progressPercentage: Number("int"), // required
|
|
48
|
+
* // estimatedEndTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // failureReason: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetIndexRebuildStatusCommandInput - {@link GetIndexRebuildStatusCommandInput}
|
|
56
|
+
* @returns {@link GetIndexRebuildStatusCommandOutput}
|
|
57
|
+
* @see {@link GetIndexRebuildStatusCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetIndexRebuildStatusCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
65
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
68
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
71
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
74
|
+
* <p>Raised when the processing of the request failed unexpectedly.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
77
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
80
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
83
|
+
* <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
86
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
89
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
92
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
* <p>Raised when a parameter value is not valid or is malformed.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link NeptunedataServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class GetIndexRebuildStatusCommand extends GetIndexRebuildStatusCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: GetIndexRebuildStatusInput;
|
|
108
|
+
output: GetIndexRebuildStatusOutput;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: GetIndexRebuildStatusCommandInput;
|
|
112
|
+
output: GetIndexRebuildStatusCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetStorageOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetStorageInfoCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetStorageInfoCommandInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetStorageInfoCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetStorageInfoCommandOutput extends GetStorageOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetStorageInfoCommand_base: {
|
|
22
|
+
new (input: GetStorageInfoCommandInput): import("@smithy/core/client").CommandImpl<GetStorageInfoCommandInput, GetStorageInfoCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [GetStorageInfoCommandInput]): import("@smithy/core/client").CommandImpl<GetStorageInfoCommandInput, GetStorageInfoCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves storage information for the Neptune database instance, including approximate total storage used and per-category size and entry counts. Storage categories include:</p> <ul> <li> <p> <i>Quad indexes</i> - the indexes that store graph data, for both RDF (SPARQL) and Property Graph (Gremlin/openCypher) models.</p> </li> <li> <p> <i>Dictionaries</i> - the term dictionaries, including total dictionary storage and the portion used by blob (large value) entries.</p> </li> <li> <p> <i>Undo logs</i> - the undo logs, reported as a total size and the number of entries in the undo log list.</p> </li> <li> <p> <i>Streams</i> - the change-log streams.</p> </li> <li> <p> <i>Schema</i> - the schema.</p> </li> <li> <p> <i>DFE statistics</i> - the DFE engine statistics.</p> </li> <li> <p> <i>System metadata</i> - internal system metadata.</p> </li> </ul> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstorageinfo">neptune-db:GetStorageInfo</a> IAM action in that cluster.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { NeptunedataClient, GetStorageInfoCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
32
|
+
* // const { NeptunedataClient, GetStorageInfoCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
33
|
+
* // import type { NeptunedataClientConfig } from "@aws-sdk/client-neptunedata";
|
|
34
|
+
* const config = {}; // type is NeptunedataClientConfig
|
|
35
|
+
* const client = new NeptunedataClient(config);
|
|
36
|
+
* const input = {};
|
|
37
|
+
* const command = new GetStorageInfoCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetStorageOutput
|
|
40
|
+
* // totalStorageBytesUsed: Number("long"),
|
|
41
|
+
* // quads: { // QuadsIndexesInfo
|
|
42
|
+
* // RDF: { // QuadsInfo
|
|
43
|
+
* // SPOG: { // StorageMetrics
|
|
44
|
+
* // sizeInBytes: Number("long"), // required
|
|
45
|
+
* // count: Number("long"), // required
|
|
46
|
+
* // },
|
|
47
|
+
* // POGS: {
|
|
48
|
+
* // sizeInBytes: Number("long"), // required
|
|
49
|
+
* // count: Number("long"), // required
|
|
50
|
+
* // },
|
|
51
|
+
* // GPSO: {
|
|
52
|
+
* // sizeInBytes: Number("long"), // required
|
|
53
|
+
* // count: Number("long"), // required
|
|
54
|
+
* // },
|
|
55
|
+
* // OSGP: {
|
|
56
|
+
* // sizeInBytes: Number("long"), // required
|
|
57
|
+
* // count: Number("long"), // required
|
|
58
|
+
* // },
|
|
59
|
+
* // PZSOG: {
|
|
60
|
+
* // sizeInBytes: Number("long"), // required
|
|
61
|
+
* // count: Number("long"), // required
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // PG: {
|
|
65
|
+
* // SPOG: "<StorageMetrics>",
|
|
66
|
+
* // POGS: "<StorageMetrics>",
|
|
67
|
+
* // GPSO: "<StorageMetrics>",
|
|
68
|
+
* // OSGP: "<StorageMetrics>",
|
|
69
|
+
* // PZSOG: "<StorageMetrics>",
|
|
70
|
+
* // },
|
|
71
|
+
* // },
|
|
72
|
+
* // dictionaries: { // DictionariesInfo
|
|
73
|
+
* // total: "<StorageMetrics>",
|
|
74
|
+
* // blobs: "<StorageMetrics>",
|
|
75
|
+
* // },
|
|
76
|
+
* // undoLogs: { // UndoLogsMetrics
|
|
77
|
+
* // sizeInBytes: Number("long"), // required
|
|
78
|
+
* // listSize: Number("long"), // required
|
|
79
|
+
* // },
|
|
80
|
+
* // streams: "<StorageMetrics>",
|
|
81
|
+
* // dfeStatistics: "<StorageMetrics>",
|
|
82
|
+
* // schema: "<StorageMetrics>",
|
|
83
|
+
* // internals: "<StorageMetrics>",
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param GetStorageInfoCommandInput - {@link GetStorageInfoCommandInput}
|
|
89
|
+
* @returns {@link GetStorageInfoCommandOutput}
|
|
90
|
+
* @see {@link GetStorageInfoCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link GetStorageInfoCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
95
|
+
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
98
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
101
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
104
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
107
|
+
* <p>Raised when the processing of the request failed unexpectedly.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
110
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
113
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
116
|
+
* <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
119
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link ServerShutdownException} (server fault)
|
|
122
|
+
* <p>Raised when the server shuts down while processing a request.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
125
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
128
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link NeptunedataServiceException}
|
|
131
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
132
|
+
*
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
export declare class GetStorageInfoCommand extends GetStorageInfoCommand_base {
|
|
137
|
+
/** @internal type navigation helper, not in runtime. */
|
|
138
|
+
protected static __types: {
|
|
139
|
+
api: {
|
|
140
|
+
input: {};
|
|
141
|
+
output: GetStorageOutput;
|
|
142
|
+
};
|
|
143
|
+
sdk: {
|
|
144
|
+
input: GetStorageInfoCommandInput;
|
|
145
|
+
output: GetStorageInfoCommandOutput;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListIndexRebuildsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListIndexRebuildsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListIndexRebuildsCommandInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListIndexRebuildsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListIndexRebuildsCommandOutput extends ListIndexRebuildsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListIndexRebuildsCommand_base: {
|
|
22
|
+
new (input: ListIndexRebuildsCommandInput): import("@smithy/core/client").CommandImpl<ListIndexRebuildsCommandInput, ListIndexRebuildsCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListIndexRebuildsCommandInput]): import("@smithy/core/client").CommandImpl<ListIndexRebuildsCommandInput, ListIndexRebuildsCommandOutput, import("..").NeptunedataClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a list of all index rebuild operation identifiers.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listindexrebuilds">neptune-db:ListIndexRebuilds</a> IAM action in that cluster.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { NeptunedataClient, ListIndexRebuildsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
32
|
+
* // const { NeptunedataClient, ListIndexRebuildsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
33
|
+
* // import type { NeptunedataClientConfig } from "@aws-sdk/client-neptunedata";
|
|
34
|
+
* const config = {}; // type is NeptunedataClientConfig
|
|
35
|
+
* const client = new NeptunedataClient(config);
|
|
36
|
+
* const input = {};
|
|
37
|
+
* const command = new ListIndexRebuildsCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // ListIndexRebuildsOutput
|
|
40
|
+
* // rebuildIds: [ // RebuildIdList // required
|
|
41
|
+
* // "STRING_VALUE",
|
|
42
|
+
* // ],
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param ListIndexRebuildsCommandInput - {@link ListIndexRebuildsCommandInput}
|
|
48
|
+
* @returns {@link ListIndexRebuildsCommandOutput}
|
|
49
|
+
* @see {@link ListIndexRebuildsCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link ListIndexRebuildsCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
57
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
60
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
63
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
66
|
+
* <p>Raised when the processing of the request failed unexpectedly.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
69
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
72
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
75
|
+
* <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
78
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
81
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
84
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link NeptunedataServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class ListIndexRebuildsCommand extends ListIndexRebuildsCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: {};
|
|
97
|
+
output: ListIndexRebuildsOutput;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: ListIndexRebuildsCommandInput;
|
|
101
|
+
output: ListIndexRebuildsCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|