@aws-sdk/client-neptune-graph 3.474.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/LICENSE +201 -0
- package/README.md +383 -0
- package/dist-cjs/NeptuneGraph.js +55 -0
- package/dist-cjs/NeptuneGraphClient.js +43 -0
- package/dist-cjs/commands/CancelImportTaskCommand.js +52 -0
- package/dist-cjs/commands/CreateGraphCommand.js +52 -0
- package/dist-cjs/commands/CreateGraphSnapshotCommand.js +52 -0
- package/dist-cjs/commands/CreateGraphUsingImportTaskCommand.js +52 -0
- package/dist-cjs/commands/CreatePrivateGraphEndpointCommand.js +52 -0
- package/dist-cjs/commands/DeleteGraphCommand.js +52 -0
- package/dist-cjs/commands/DeleteGraphSnapshotCommand.js +52 -0
- package/dist-cjs/commands/DeletePrivateGraphEndpointCommand.js +52 -0
- package/dist-cjs/commands/GetGraphCommand.js +52 -0
- package/dist-cjs/commands/GetGraphSnapshotCommand.js +52 -0
- package/dist-cjs/commands/GetImportTaskCommand.js +52 -0
- package/dist-cjs/commands/GetPrivateGraphEndpointCommand.js +52 -0
- package/dist-cjs/commands/ListGraphSnapshotsCommand.js +52 -0
- package/dist-cjs/commands/ListGraphsCommand.js +52 -0
- package/dist-cjs/commands/ListImportTasksCommand.js +52 -0
- package/dist-cjs/commands/ListPrivateGraphEndpointsCommand.js +52 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +52 -0
- package/dist-cjs/commands/ResetGraphCommand.js +52 -0
- package/dist-cjs/commands/RestoreGraphFromSnapshotCommand.js +52 -0
- package/dist-cjs/commands/TagResourceCommand.js +52 -0
- package/dist-cjs/commands/UntagResourceCommand.js +52 -0
- package/dist-cjs/commands/UpdateGraphCommand.js +52 -0
- package/dist-cjs/commands/index.js +25 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/NeptuneGraphServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +149 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListGraphSnapshotsPaginator.js +29 -0
- package/dist-cjs/pagination/ListGraphsPaginator.js +29 -0
- package/dist-cjs/pagination/ListImportTasksPaginator.js +29 -0
- package/dist-cjs/pagination/ListPrivateGraphEndpointsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1763 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/NeptuneGraph.js +51 -0
- package/dist-es/NeptuneGraphClient.js +39 -0
- package/dist-es/commands/CancelImportTaskCommand.js +48 -0
- package/dist-es/commands/CreateGraphCommand.js +48 -0
- package/dist-es/commands/CreateGraphSnapshotCommand.js +48 -0
- package/dist-es/commands/CreateGraphUsingImportTaskCommand.js +48 -0
- package/dist-es/commands/CreatePrivateGraphEndpointCommand.js +48 -0
- package/dist-es/commands/DeleteGraphCommand.js +48 -0
- package/dist-es/commands/DeleteGraphSnapshotCommand.js +48 -0
- package/dist-es/commands/DeletePrivateGraphEndpointCommand.js +48 -0
- package/dist-es/commands/GetGraphCommand.js +48 -0
- package/dist-es/commands/GetGraphSnapshotCommand.js +48 -0
- package/dist-es/commands/GetImportTaskCommand.js +48 -0
- package/dist-es/commands/GetPrivateGraphEndpointCommand.js +48 -0
- package/dist-es/commands/ListGraphSnapshotsCommand.js +48 -0
- package/dist-es/commands/ListGraphsCommand.js +48 -0
- package/dist-es/commands/ListImportTasksCommand.js +48 -0
- package/dist-es/commands/ListPrivateGraphEndpointsCommand.js +48 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +48 -0
- package/dist-es/commands/ResetGraphCommand.js +48 -0
- package/dist-es/commands/RestoreGraphFromSnapshotCommand.js +48 -0
- package/dist-es/commands/TagResourceCommand.js +48 -0
- package/dist-es/commands/UntagResourceCommand.js +48 -0
- package/dist-es/commands/UpdateGraphCommand.js +48 -0
- package/dist-es/commands/index.js +22 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/NeptuneGraphServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +140 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListGraphSnapshotsPaginator.js +25 -0
- package/dist-es/pagination/ListGraphsPaginator.js +25 -0
- package/dist-es/pagination/ListImportTasksPaginator.js +25 -0
- package/dist-es/pagination/ListPrivateGraphEndpointsPaginator.js +25 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +1716 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/NeptuneGraph.d.ts +166 -0
- package/dist-types/NeptuneGraphClient.d.ts +193 -0
- package/dist-types/commands/CancelImportTaskCommand.d.ts +93 -0
- package/dist-types/commands/CreateGraphCommand.d.ts +115 -0
- package/dist-types/commands/CreateGraphSnapshotCommand.d.ts +101 -0
- package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +129 -0
- package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +104 -0
- package/dist-types/commands/DeleteGraphCommand.d.ts +105 -0
- package/dist-types/commands/DeleteGraphSnapshotCommand.d.ts +94 -0
- package/dist-types/commands/DeletePrivateGraphEndpointCommand.d.ts +94 -0
- package/dist-types/commands/GetGraphCommand.d.ts +101 -0
- package/dist-types/commands/GetGraphSnapshotCommand.d.ts +91 -0
- package/dist-types/commands/GetImportTaskCommand.d.ts +110 -0
- package/dist-types/commands/GetPrivateGraphEndpointCommand.d.ts +91 -0
- package/dist-types/commands/ListGraphSnapshotsCommand.d.ts +98 -0
- package/dist-types/commands/ListGraphsCommand.d.ts +97 -0
- package/dist-types/commands/ListImportTasksCommand.d.ts +96 -0
- package/dist-types/commands/ListPrivateGraphEndpointsCommand.d.ts +97 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +87 -0
- package/dist-types/commands/ResetGraphCommand.d.ts +105 -0
- package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +115 -0
- package/dist-types/commands/TagResourceCommand.d.ts +86 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +86 -0
- package/dist-types/commands/UpdateGraphCommand.d.ts +107 -0
- package/dist-types/commands/index.d.ts +22 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +23 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +17 -0
- package/dist-types/models/NeptuneGraphServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2021 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListGraphSnapshotsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGraphsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListImportTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPrivateGraphEndpointsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +200 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/NeptuneGraph.d.ts +381 -0
- package/dist-types/ts3.4/NeptuneGraphClient.d.ts +251 -0
- package/dist-types/ts3.4/commands/CancelImportTaskCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateGraphCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/CreateGraphSnapshotCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateGraphUsingImportTaskCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreatePrivateGraphEndpointCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteGraphCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteGraphSnapshotCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeletePrivateGraphEndpointCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetGraphCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetGraphSnapshotCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetImportTaskCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetPrivateGraphEndpointCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListGraphSnapshotsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListGraphsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListImportTasksCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListPrivateGraphEndpointsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ResetGraphCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/RestoreGraphFromSnapshotCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateGraphCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +22 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +34 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/NeptuneGraphServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +494 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListGraphSnapshotsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGraphsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListImportTasksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPrivateGraphEndpointsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +269 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +100 -0
|
@@ -0,0 +1,2021 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* @enum
|
|
6
|
+
*/
|
|
7
|
+
export declare const ConflictExceptionReason: {
|
|
8
|
+
readonly CONCURRENT_MODIFICATION: "CONCURRENT_MODIFICATION";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
* <p>Raised when a conflict is encountered.</p>
|
|
17
|
+
*/
|
|
18
|
+
export declare class ConflictException extends __BaseException {
|
|
19
|
+
readonly name: "ConflictException";
|
|
20
|
+
readonly $fault: "client";
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>The reason for the conflict exception.</p>
|
|
24
|
+
*/
|
|
25
|
+
reason?: ConflictExceptionReason;
|
|
26
|
+
/**
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
34
|
+
*/
|
|
35
|
+
export interface VectorSearchConfiguration {
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
* <p>The number of dimensions.</p>
|
|
39
|
+
*/
|
|
40
|
+
dimension: number | undefined;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface CreateGraphInput {
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
49
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
50
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
51
|
+
* consecutive hyphens. </p>
|
|
52
|
+
*/
|
|
53
|
+
graphName: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* <p>Adds metadata tags to the new graph.
|
|
57
|
+
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
58
|
+
*/
|
|
59
|
+
tags?: Record<string, string>;
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
|
|
63
|
+
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
64
|
+
*/
|
|
65
|
+
publicConnectivity?: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
* <p>Specifies a KMS key to use to encrypt data in the new graph.</p>
|
|
69
|
+
*/
|
|
70
|
+
kmsKeyIdentifier?: string;
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
74
|
+
* The value is specified as <code>dimension=</code>value. Max = 65,535</p>
|
|
75
|
+
*/
|
|
76
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>
|
|
80
|
+
*/
|
|
81
|
+
replicaCount?: number;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
85
|
+
* (<code>true</code> or <code>false</code>).</p>
|
|
86
|
+
*/
|
|
87
|
+
deletionProtection?: boolean;
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
91
|
+
*/
|
|
92
|
+
provisionedMemory: number | undefined;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
* @enum
|
|
97
|
+
*/
|
|
98
|
+
export declare const GraphStatus: {
|
|
99
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
100
|
+
readonly CREATING: "CREATING";
|
|
101
|
+
readonly DELETING: "DELETING";
|
|
102
|
+
readonly FAILED: "FAILED";
|
|
103
|
+
readonly RESETTING: "RESETTING";
|
|
104
|
+
readonly SNAPSHOTTING: "SNAPSHOTTING";
|
|
105
|
+
readonly UPDATING: "UPDATING";
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export type GraphStatus = (typeof GraphStatus)[keyof typeof GraphStatus];
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export interface CreateGraphOutput {
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
* <p>The ID of the graph.</p>
|
|
118
|
+
*/
|
|
119
|
+
id: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
* <p>The graph name. For example: <code>my-graph-1</code>.</p>
|
|
123
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
124
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
125
|
+
* consecutive hyphens. </p>
|
|
126
|
+
*/
|
|
127
|
+
name: string | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
* <p>The ARN of the graph.</p>
|
|
131
|
+
*/
|
|
132
|
+
arn: string | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* @public
|
|
135
|
+
* <p>The current status of the graph.</p>
|
|
136
|
+
*/
|
|
137
|
+
status?: GraphStatus;
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>The reason the status was given.</p>
|
|
141
|
+
*/
|
|
142
|
+
statusReason?: string;
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>The time when the graph was created.</p>
|
|
146
|
+
*/
|
|
147
|
+
createTime?: Date;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
151
|
+
*/
|
|
152
|
+
provisionedMemory?: number;
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>The graph endpoint.</p>
|
|
156
|
+
*/
|
|
157
|
+
endpoint?: string;
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.</p>
|
|
161
|
+
*/
|
|
162
|
+
publicConnectivity?: boolean;
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
* <p>The vector-search configuration for the graph, which specifies the vector dimension
|
|
166
|
+
* to use in the vector index, if any.</p>
|
|
167
|
+
*/
|
|
168
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
169
|
+
/**
|
|
170
|
+
* @public
|
|
171
|
+
* <p>The number of replicas in other AZs.</p>
|
|
172
|
+
*/
|
|
173
|
+
replicaCount?: number;
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
* <p>Specifies the KMS key used to encrypt data in the new graph.</p>
|
|
177
|
+
*/
|
|
178
|
+
kmsKeyIdentifier?: string;
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
* <p>The ID of the source graph.</p>
|
|
182
|
+
*/
|
|
183
|
+
sourceSnapshotId?: string;
|
|
184
|
+
/**
|
|
185
|
+
* @public
|
|
186
|
+
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
187
|
+
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
188
|
+
*/
|
|
189
|
+
deletionProtection?: boolean;
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
* <p>The build number of the graph software.</p>
|
|
193
|
+
*/
|
|
194
|
+
buildNumber?: string;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
* <p>A failure occurred on the server.</p>
|
|
199
|
+
*/
|
|
200
|
+
export declare class InternalServerException extends __BaseException {
|
|
201
|
+
readonly name: "InternalServerException";
|
|
202
|
+
readonly $fault: "server";
|
|
203
|
+
$retryable: {};
|
|
204
|
+
/**
|
|
205
|
+
* @internal
|
|
206
|
+
*/
|
|
207
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* @public
|
|
211
|
+
* <p>A service quota was exceeded.</p>
|
|
212
|
+
*/
|
|
213
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
214
|
+
readonly name: "ServiceQuotaExceededException";
|
|
215
|
+
readonly $fault: "client";
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* <p>The identifier of the resource that exceeded quota.</p>
|
|
219
|
+
*/
|
|
220
|
+
resourceId?: string;
|
|
221
|
+
/**
|
|
222
|
+
* @public
|
|
223
|
+
* <p>The type of the resource that exceeded quota. Ex: Graph, Snapshot</p>
|
|
224
|
+
*/
|
|
225
|
+
resourceType?: string;
|
|
226
|
+
/**
|
|
227
|
+
* @public
|
|
228
|
+
* <p>The service code that exceeded quota.</p>
|
|
229
|
+
*/
|
|
230
|
+
serviceCode?: string;
|
|
231
|
+
/**
|
|
232
|
+
* @public
|
|
233
|
+
* <p>Service quota code of the resource for which quota was exceeded.</p>
|
|
234
|
+
*/
|
|
235
|
+
quotaCode?: string;
|
|
236
|
+
/**
|
|
237
|
+
* @internal
|
|
238
|
+
*/
|
|
239
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* @public
|
|
243
|
+
* <p>The exception was interrupted by throttling.</p>
|
|
244
|
+
*/
|
|
245
|
+
export declare class ThrottlingException extends __BaseException {
|
|
246
|
+
readonly name: "ThrottlingException";
|
|
247
|
+
readonly $fault: "client";
|
|
248
|
+
$retryable: {
|
|
249
|
+
throttling: boolean;
|
|
250
|
+
};
|
|
251
|
+
/**
|
|
252
|
+
* @internal
|
|
253
|
+
*/
|
|
254
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* @public
|
|
258
|
+
* @enum
|
|
259
|
+
*/
|
|
260
|
+
export declare const ValidationExceptionReason: {
|
|
261
|
+
readonly BAD_REQUEST: "BAD_REQUEST";
|
|
262
|
+
readonly CONSTRAINT_VIOLATION: "CONSTRAINT_VIOLATION";
|
|
263
|
+
readonly ILLEGAL_ARGUMENT: "ILLEGAL_ARGUMENT";
|
|
264
|
+
readonly MALFORMED_QUERY: "MALFORMED_QUERY";
|
|
265
|
+
readonly QUERY_CANCELLED: "QUERY_CANCELLED";
|
|
266
|
+
readonly QUERY_TOO_LARGE: "QUERY_TOO_LARGE";
|
|
267
|
+
readonly UNSUPPORTED_OPERATION: "UNSUPPORTED_OPERATION";
|
|
268
|
+
};
|
|
269
|
+
/**
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
273
|
+
/**
|
|
274
|
+
* @public
|
|
275
|
+
* <p>A resource could not be validated</p>
|
|
276
|
+
*/
|
|
277
|
+
export declare class ValidationException extends __BaseException {
|
|
278
|
+
readonly name: "ValidationException";
|
|
279
|
+
readonly $fault: "client";
|
|
280
|
+
/**
|
|
281
|
+
* @public
|
|
282
|
+
* <p>The reason that the resource could not be validated.</p>
|
|
283
|
+
*/
|
|
284
|
+
reason?: ValidationExceptionReason;
|
|
285
|
+
/**
|
|
286
|
+
* @internal
|
|
287
|
+
*/
|
|
288
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
export interface DeleteGraphInput {
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
297
|
+
*/
|
|
298
|
+
graphIdentifier: string | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
* <p>Determines whether a final graph snapshot is created before the graph is deleted.
|
|
302
|
+
* If <code>true</code> is specified, no graph snapshot is created. If <code>false</code>
|
|
303
|
+
* is specified, a graph snapshot is created before the graph is deleted.</p>
|
|
304
|
+
*/
|
|
305
|
+
skipSnapshot: boolean | undefined;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export interface DeleteGraphOutput {
|
|
311
|
+
/**
|
|
312
|
+
* @public
|
|
313
|
+
* <p>The unique identifier of the graph.</p>
|
|
314
|
+
*/
|
|
315
|
+
id: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* @public
|
|
318
|
+
* <p>The name of the graph.</p>
|
|
319
|
+
*/
|
|
320
|
+
name: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* @public
|
|
323
|
+
* <p>The ARN associated with the graph.</p>
|
|
324
|
+
*/
|
|
325
|
+
arn: string | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* @public
|
|
328
|
+
* <p>The status of the graph.</p>
|
|
329
|
+
*/
|
|
330
|
+
status?: GraphStatus;
|
|
331
|
+
/**
|
|
332
|
+
* @public
|
|
333
|
+
* <p>The reason for the status of the graph.</p>
|
|
334
|
+
*/
|
|
335
|
+
statusReason?: string;
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* <p>The time at which the graph was created.</p>
|
|
339
|
+
*/
|
|
340
|
+
createTime?: Date;
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
344
|
+
*/
|
|
345
|
+
provisionedMemory?: number;
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
* <p>The graph endpoint.</p>
|
|
349
|
+
*/
|
|
350
|
+
endpoint?: string;
|
|
351
|
+
/**
|
|
352
|
+
* @public
|
|
353
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
354
|
+
*/
|
|
355
|
+
publicConnectivity?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
359
|
+
*/
|
|
360
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
361
|
+
/**
|
|
362
|
+
* @public
|
|
363
|
+
* <p>The number of replicas for the graph.</p>
|
|
364
|
+
*/
|
|
365
|
+
replicaCount?: number;
|
|
366
|
+
/**
|
|
367
|
+
* @public
|
|
368
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
369
|
+
*/
|
|
370
|
+
kmsKeyIdentifier?: string;
|
|
371
|
+
/**
|
|
372
|
+
* @public
|
|
373
|
+
* <p>The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.</p>
|
|
374
|
+
*/
|
|
375
|
+
sourceSnapshotId?: string;
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
* <p>If <code>true</code>, deletion protection was enabled for the graph.</p>
|
|
379
|
+
*/
|
|
380
|
+
deletionProtection?: boolean;
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
* <p>The build number associated with the graph.</p>
|
|
384
|
+
*/
|
|
385
|
+
buildNumber?: string;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* @public
|
|
389
|
+
* <p>A specified resource could not be located.</p>
|
|
390
|
+
*/
|
|
391
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
392
|
+
readonly name: "ResourceNotFoundException";
|
|
393
|
+
readonly $fault: "client";
|
|
394
|
+
/**
|
|
395
|
+
* @internal
|
|
396
|
+
*/
|
|
397
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
export interface GetGraphInput {
|
|
403
|
+
/**
|
|
404
|
+
* @public
|
|
405
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
406
|
+
*/
|
|
407
|
+
graphIdentifier: string | undefined;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
export interface GetGraphOutput {
|
|
413
|
+
/**
|
|
414
|
+
* @public
|
|
415
|
+
* <p>The unique identifier of the graph.</p>
|
|
416
|
+
*/
|
|
417
|
+
id: string | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* @public
|
|
420
|
+
* <p>The name of the graph.</p>
|
|
421
|
+
*/
|
|
422
|
+
name: string | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* @public
|
|
425
|
+
* <p>The ARN associated with the graph.</p>
|
|
426
|
+
*/
|
|
427
|
+
arn: string | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* @public
|
|
430
|
+
* <p>The status of the graph.</p>
|
|
431
|
+
*/
|
|
432
|
+
status?: GraphStatus;
|
|
433
|
+
/**
|
|
434
|
+
* @public
|
|
435
|
+
* <p>The reason that the graph has this status.</p>
|
|
436
|
+
*/
|
|
437
|
+
statusReason?: string;
|
|
438
|
+
/**
|
|
439
|
+
* @public
|
|
440
|
+
* <p>The time at which the graph was created.</p>
|
|
441
|
+
*/
|
|
442
|
+
createTime?: Date;
|
|
443
|
+
/**
|
|
444
|
+
* @public
|
|
445
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
446
|
+
*/
|
|
447
|
+
provisionedMemory?: number;
|
|
448
|
+
/**
|
|
449
|
+
* @public
|
|
450
|
+
* <p>The graph endpoint.</p>
|
|
451
|
+
*/
|
|
452
|
+
endpoint?: string;
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
456
|
+
*/
|
|
457
|
+
publicConnectivity?: boolean;
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
461
|
+
*/
|
|
462
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
* <p>The number of replicas for the graph.</p>
|
|
466
|
+
*/
|
|
467
|
+
replicaCount?: number;
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
471
|
+
*/
|
|
472
|
+
kmsKeyIdentifier?: string;
|
|
473
|
+
/**
|
|
474
|
+
* @public
|
|
475
|
+
* <p>The ID of the snapshot from which the graph was created, if it was created from a snapshot.</p>
|
|
476
|
+
*/
|
|
477
|
+
sourceSnapshotId?: string;
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
481
|
+
*/
|
|
482
|
+
deletionProtection?: boolean;
|
|
483
|
+
/**
|
|
484
|
+
* @public
|
|
485
|
+
* <p>The build number of the graph.</p>
|
|
486
|
+
*/
|
|
487
|
+
buildNumber?: string;
|
|
488
|
+
}
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
export interface ListGraphsInput {
|
|
493
|
+
/**
|
|
494
|
+
* @public
|
|
495
|
+
* <p>Pagination token used to paginate output.</p>
|
|
496
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
497
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
498
|
+
* that there are more results to retrieve.</p>
|
|
499
|
+
*/
|
|
500
|
+
nextToken?: string;
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
* <p>The total number of records to return in the command's output.</p>
|
|
504
|
+
* <p>If the total number of records available is more than the value specified,
|
|
505
|
+
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
506
|
+
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
507
|
+
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
508
|
+
* outside of the Amazon CLI.</p>
|
|
509
|
+
*/
|
|
510
|
+
maxResults?: number;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
* <p>Summary details about a graph.</p>
|
|
515
|
+
*/
|
|
516
|
+
export interface GraphSummary {
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* <p>The unique identifier of the graph.</p>
|
|
520
|
+
*/
|
|
521
|
+
id: string | undefined;
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
* <p>The name of the graph.</p>
|
|
525
|
+
*/
|
|
526
|
+
name: string | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* @public
|
|
529
|
+
* <p>The ARN associated with the graph.</p>
|
|
530
|
+
*/
|
|
531
|
+
arn: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* @public
|
|
534
|
+
* <p>The status of the graph.</p>
|
|
535
|
+
*/
|
|
536
|
+
status?: GraphStatus;
|
|
537
|
+
/**
|
|
538
|
+
* @public
|
|
539
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
540
|
+
*/
|
|
541
|
+
provisionedMemory?: number;
|
|
542
|
+
/**
|
|
543
|
+
* @public
|
|
544
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
545
|
+
*/
|
|
546
|
+
publicConnectivity?: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* @public
|
|
549
|
+
* <p>The graph endpoint.</p>
|
|
550
|
+
*/
|
|
551
|
+
endpoint?: string;
|
|
552
|
+
/**
|
|
553
|
+
* @public
|
|
554
|
+
* <p>The number of replicas for the graph.</p>
|
|
555
|
+
*/
|
|
556
|
+
replicaCount?: number;
|
|
557
|
+
/**
|
|
558
|
+
* @public
|
|
559
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
560
|
+
*/
|
|
561
|
+
kmsKeyIdentifier?: string;
|
|
562
|
+
/**
|
|
563
|
+
* @public
|
|
564
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
565
|
+
*/
|
|
566
|
+
deletionProtection?: boolean;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
export interface ListGraphsOutput {
|
|
572
|
+
/**
|
|
573
|
+
* @public
|
|
574
|
+
* <p>A list of the graphs.</p>
|
|
575
|
+
*/
|
|
576
|
+
graphs: GraphSummary[] | undefined;
|
|
577
|
+
/**
|
|
578
|
+
* @public
|
|
579
|
+
* <p>Pagination token used to paginate output.</p>
|
|
580
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
581
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
582
|
+
* that there are more results to retrieve.</p>
|
|
583
|
+
*/
|
|
584
|
+
nextToken?: string;
|
|
585
|
+
}
|
|
586
|
+
/**
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
export interface ResetGraphInput {
|
|
590
|
+
/**
|
|
591
|
+
* @public
|
|
592
|
+
* <p>ID of the graph to reset.</p>
|
|
593
|
+
*/
|
|
594
|
+
graphIdentifier: string | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* @public
|
|
597
|
+
* <p>Determines whether a final graph snapshot is created before the graph data is deleted.
|
|
598
|
+
* If set to <code>true</code>, no graph snapshot is created. If set to <code>false</code>,
|
|
599
|
+
* a graph snapshot is created before the data is deleted.</p>
|
|
600
|
+
*/
|
|
601
|
+
skipSnapshot: boolean | undefined;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
export interface ResetGraphOutput {
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
* <p>The unique identifier of the graph.</p>
|
|
610
|
+
*/
|
|
611
|
+
id: string | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* @public
|
|
614
|
+
* <p>The name of the graph.</p>
|
|
615
|
+
*/
|
|
616
|
+
name: string | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* @public
|
|
619
|
+
* <p>The ARN associated with the graph.</p>
|
|
620
|
+
*/
|
|
621
|
+
arn: string | undefined;
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
* <p>The status of the graph.</p>
|
|
625
|
+
*/
|
|
626
|
+
status?: GraphStatus;
|
|
627
|
+
/**
|
|
628
|
+
* @public
|
|
629
|
+
* <p>The reason that the graph has this status.</p>
|
|
630
|
+
*/
|
|
631
|
+
statusReason?: string;
|
|
632
|
+
/**
|
|
633
|
+
* @public
|
|
634
|
+
* <p>The time at which the graph was created.</p>
|
|
635
|
+
*/
|
|
636
|
+
createTime?: Date;
|
|
637
|
+
/**
|
|
638
|
+
* @public
|
|
639
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
640
|
+
*/
|
|
641
|
+
provisionedMemory?: number;
|
|
642
|
+
/**
|
|
643
|
+
* @public
|
|
644
|
+
* <p>The graph endpoint.</p>
|
|
645
|
+
*/
|
|
646
|
+
endpoint?: string;
|
|
647
|
+
/**
|
|
648
|
+
* @public
|
|
649
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
650
|
+
*/
|
|
651
|
+
publicConnectivity?: boolean;
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
655
|
+
*/
|
|
656
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
657
|
+
/**
|
|
658
|
+
* @public
|
|
659
|
+
* <p>The number of replicas for the graph.</p>
|
|
660
|
+
*/
|
|
661
|
+
replicaCount?: number;
|
|
662
|
+
/**
|
|
663
|
+
* @public
|
|
664
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
665
|
+
*/
|
|
666
|
+
kmsKeyIdentifier?: string;
|
|
667
|
+
/**
|
|
668
|
+
* @public
|
|
669
|
+
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
670
|
+
*/
|
|
671
|
+
sourceSnapshotId?: string;
|
|
672
|
+
/**
|
|
673
|
+
* @public
|
|
674
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
675
|
+
*/
|
|
676
|
+
deletionProtection?: boolean;
|
|
677
|
+
/**
|
|
678
|
+
* @public
|
|
679
|
+
* <p>The build number of the graph.</p>
|
|
680
|
+
*/
|
|
681
|
+
buildNumber?: string;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
export interface RestoreGraphFromSnapshotInput {
|
|
687
|
+
/**
|
|
688
|
+
* @public
|
|
689
|
+
* <p>The ID of the snapshot in question.</p>
|
|
690
|
+
*/
|
|
691
|
+
snapshotIdentifier: string | undefined;
|
|
692
|
+
/**
|
|
693
|
+
* @public
|
|
694
|
+
* <p>A name for the new Neptune Analytics graph to be created from the snapshot.</p>
|
|
695
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
696
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
697
|
+
* consecutive hyphens. </p>
|
|
698
|
+
*/
|
|
699
|
+
graphName: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* @public
|
|
702
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
703
|
+
*/
|
|
704
|
+
provisionedMemory?: number;
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
708
|
+
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
709
|
+
*/
|
|
710
|
+
deletionProtection?: boolean;
|
|
711
|
+
/**
|
|
712
|
+
* @public
|
|
713
|
+
* <p>Adds metadata tags to the snapshot.
|
|
714
|
+
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
715
|
+
*/
|
|
716
|
+
tags?: Record<string, string>;
|
|
717
|
+
/**
|
|
718
|
+
* @public
|
|
719
|
+
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>
|
|
720
|
+
*/
|
|
721
|
+
replicaCount?: number;
|
|
722
|
+
/**
|
|
723
|
+
* @public
|
|
724
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
|
|
725
|
+
* (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
726
|
+
*/
|
|
727
|
+
publicConnectivity?: boolean;
|
|
728
|
+
}
|
|
729
|
+
/**
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
export interface RestoreGraphFromSnapshotOutput {
|
|
733
|
+
/**
|
|
734
|
+
* @public
|
|
735
|
+
* <p>The unique identifier of the graph.</p>
|
|
736
|
+
*/
|
|
737
|
+
id: string | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* @public
|
|
740
|
+
* <p>The name of the graph.</p>
|
|
741
|
+
*/
|
|
742
|
+
name: string | undefined;
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
* <p>The ARN associated with the graph.</p>
|
|
746
|
+
*/
|
|
747
|
+
arn: string | undefined;
|
|
748
|
+
/**
|
|
749
|
+
* @public
|
|
750
|
+
* <p>The status of the graph.</p>
|
|
751
|
+
*/
|
|
752
|
+
status?: GraphStatus;
|
|
753
|
+
/**
|
|
754
|
+
* @public
|
|
755
|
+
* <p>The reason that the graph has this status.</p>
|
|
756
|
+
*/
|
|
757
|
+
statusReason?: string;
|
|
758
|
+
/**
|
|
759
|
+
* @public
|
|
760
|
+
* <p>The time at which the graph was created.</p>
|
|
761
|
+
*/
|
|
762
|
+
createTime?: Date;
|
|
763
|
+
/**
|
|
764
|
+
* @public
|
|
765
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
766
|
+
*/
|
|
767
|
+
provisionedMemory?: number;
|
|
768
|
+
/**
|
|
769
|
+
* @public
|
|
770
|
+
* <p>The graph endpoint.</p>
|
|
771
|
+
*/
|
|
772
|
+
endpoint?: string;
|
|
773
|
+
/**
|
|
774
|
+
* @public
|
|
775
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
776
|
+
*/
|
|
777
|
+
publicConnectivity?: boolean;
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
781
|
+
*/
|
|
782
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
783
|
+
/**
|
|
784
|
+
* @public
|
|
785
|
+
* <p>The number of replicas for the graph.</p>
|
|
786
|
+
*/
|
|
787
|
+
replicaCount?: number;
|
|
788
|
+
/**
|
|
789
|
+
* @public
|
|
790
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
791
|
+
*/
|
|
792
|
+
kmsKeyIdentifier?: string;
|
|
793
|
+
/**
|
|
794
|
+
* @public
|
|
795
|
+
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
796
|
+
*/
|
|
797
|
+
sourceSnapshotId?: string;
|
|
798
|
+
/**
|
|
799
|
+
* @public
|
|
800
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
801
|
+
*/
|
|
802
|
+
deletionProtection?: boolean;
|
|
803
|
+
/**
|
|
804
|
+
* @public
|
|
805
|
+
* <p>The build number of the graph.</p>
|
|
806
|
+
*/
|
|
807
|
+
buildNumber?: string;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
export interface UpdateGraphInput {
|
|
813
|
+
/**
|
|
814
|
+
* @public
|
|
815
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
816
|
+
*/
|
|
817
|
+
graphIdentifier: string | undefined;
|
|
818
|
+
/**
|
|
819
|
+
* @public
|
|
820
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
|
|
821
|
+
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
822
|
+
*/
|
|
823
|
+
publicConnectivity?: boolean;
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
827
|
+
*/
|
|
828
|
+
provisionedMemory?: number;
|
|
829
|
+
/**
|
|
830
|
+
* @public
|
|
831
|
+
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
832
|
+
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
833
|
+
*/
|
|
834
|
+
deletionProtection?: boolean;
|
|
835
|
+
}
|
|
836
|
+
/**
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
export interface UpdateGraphOutput {
|
|
840
|
+
/**
|
|
841
|
+
* @public
|
|
842
|
+
* <p>The unique identifier of the graph.</p>
|
|
843
|
+
*/
|
|
844
|
+
id: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* @public
|
|
847
|
+
* <p>The name of the graph.</p>
|
|
848
|
+
*/
|
|
849
|
+
name: string | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* @public
|
|
852
|
+
* <p>The ARN associated with the graph.</p>
|
|
853
|
+
*/
|
|
854
|
+
arn: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* @public
|
|
857
|
+
* <p>The status of the graph.</p>
|
|
858
|
+
*/
|
|
859
|
+
status?: GraphStatus;
|
|
860
|
+
/**
|
|
861
|
+
* @public
|
|
862
|
+
* <p>The reason that the graph has this status.</p>
|
|
863
|
+
*/
|
|
864
|
+
statusReason?: string;
|
|
865
|
+
/**
|
|
866
|
+
* @public
|
|
867
|
+
* <p>The time at which the graph was created.</p>
|
|
868
|
+
*/
|
|
869
|
+
createTime?: Date;
|
|
870
|
+
/**
|
|
871
|
+
* @public
|
|
872
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
873
|
+
*/
|
|
874
|
+
provisionedMemory?: number;
|
|
875
|
+
/**
|
|
876
|
+
* @public
|
|
877
|
+
* <p>The graph endpoint.</p>
|
|
878
|
+
*/
|
|
879
|
+
endpoint?: string;
|
|
880
|
+
/**
|
|
881
|
+
* @public
|
|
882
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
883
|
+
*/
|
|
884
|
+
publicConnectivity?: boolean;
|
|
885
|
+
/**
|
|
886
|
+
* @public
|
|
887
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
888
|
+
*/
|
|
889
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
* <p>The number of replicas for the graph.</p>
|
|
893
|
+
*/
|
|
894
|
+
replicaCount?: number;
|
|
895
|
+
/**
|
|
896
|
+
* @public
|
|
897
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
898
|
+
*/
|
|
899
|
+
kmsKeyIdentifier?: string;
|
|
900
|
+
/**
|
|
901
|
+
* @public
|
|
902
|
+
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
903
|
+
*/
|
|
904
|
+
sourceSnapshotId?: string;
|
|
905
|
+
/**
|
|
906
|
+
* @public
|
|
907
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
908
|
+
*/
|
|
909
|
+
deletionProtection?: boolean;
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
* <p>The build number of the graph.</p>
|
|
913
|
+
*/
|
|
914
|
+
buildNumber?: string;
|
|
915
|
+
}
|
|
916
|
+
/**
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
export interface ListTagsForResourceInput {
|
|
920
|
+
/**
|
|
921
|
+
* @public
|
|
922
|
+
* <p>The ARN of the resource.</p>
|
|
923
|
+
*/
|
|
924
|
+
resourceArn: string | undefined;
|
|
925
|
+
}
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface ListTagsForResourceOutput {
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
* <p>The list of metadata tags associated with the resource.</p>
|
|
933
|
+
*/
|
|
934
|
+
tags?: Record<string, string>;
|
|
935
|
+
}
|
|
936
|
+
/**
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
export interface CreatePrivateGraphEndpointInput {
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
943
|
+
*/
|
|
944
|
+
graphIdentifier: string | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* @public
|
|
947
|
+
* <p> The VPC in which the private graph endpoint needs to be created.</p>
|
|
948
|
+
*/
|
|
949
|
+
vpcId?: string;
|
|
950
|
+
/**
|
|
951
|
+
* @public
|
|
952
|
+
* <p>Subnets in which private graph endpoint ENIs are created.</p>
|
|
953
|
+
*/
|
|
954
|
+
subnetIds?: string[];
|
|
955
|
+
/**
|
|
956
|
+
* @public
|
|
957
|
+
* <p>Security groups to be attached to the private graph endpoint..</p>
|
|
958
|
+
*/
|
|
959
|
+
vpcSecurityGroupIds?: string[];
|
|
960
|
+
}
|
|
961
|
+
/**
|
|
962
|
+
* @public
|
|
963
|
+
* @enum
|
|
964
|
+
*/
|
|
965
|
+
export declare const PrivateGraphEndpointStatus: {
|
|
966
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
967
|
+
readonly CREATING: "CREATING";
|
|
968
|
+
readonly DELETING: "DELETING";
|
|
969
|
+
readonly FAILED: "FAILED";
|
|
970
|
+
};
|
|
971
|
+
/**
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
export type PrivateGraphEndpointStatus = (typeof PrivateGraphEndpointStatus)[keyof typeof PrivateGraphEndpointStatus];
|
|
975
|
+
/**
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
export interface CreatePrivateGraphEndpointOutput {
|
|
979
|
+
/**
|
|
980
|
+
* @public
|
|
981
|
+
* <p>VPC in which the private graph endpoint is created.</p>
|
|
982
|
+
*/
|
|
983
|
+
vpcId: string | undefined;
|
|
984
|
+
/**
|
|
985
|
+
* @public
|
|
986
|
+
* <p>Subnets in which the private graph endpoint ENIs are created. </p>
|
|
987
|
+
*/
|
|
988
|
+
subnetIds: string[] | undefined;
|
|
989
|
+
/**
|
|
990
|
+
* @public
|
|
991
|
+
* <p>Status of the private graph endpoint.</p>
|
|
992
|
+
*/
|
|
993
|
+
status: PrivateGraphEndpointStatus | undefined;
|
|
994
|
+
/**
|
|
995
|
+
* @public
|
|
996
|
+
* <p>Endpoint ID of the prviate grpah endpoint.</p>
|
|
997
|
+
*/
|
|
998
|
+
vpcEndpointId?: string;
|
|
999
|
+
}
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export interface DeletePrivateGraphEndpointInput {
|
|
1004
|
+
/**
|
|
1005
|
+
* @public
|
|
1006
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1007
|
+
*/
|
|
1008
|
+
graphIdentifier: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* @public
|
|
1011
|
+
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1012
|
+
*/
|
|
1013
|
+
vpcId: string | undefined;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
export interface DeletePrivateGraphEndpointOutput {
|
|
1019
|
+
/**
|
|
1020
|
+
* @public
|
|
1021
|
+
* <p>The ID of the VPC where the private endpoint was deleted.</p>
|
|
1022
|
+
*/
|
|
1023
|
+
vpcId: string | undefined;
|
|
1024
|
+
/**
|
|
1025
|
+
* @public
|
|
1026
|
+
* <p>The subnet IDs involved.</p>
|
|
1027
|
+
*/
|
|
1028
|
+
subnetIds: string[] | undefined;
|
|
1029
|
+
/**
|
|
1030
|
+
* @public
|
|
1031
|
+
* <p>The status of the delete operation.</p>
|
|
1032
|
+
*/
|
|
1033
|
+
status: PrivateGraphEndpointStatus | undefined;
|
|
1034
|
+
/**
|
|
1035
|
+
* @public
|
|
1036
|
+
* <p>The ID of the VPC endpoint that was deleted.</p>
|
|
1037
|
+
*/
|
|
1038
|
+
vpcEndpointId?: string;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
export interface GetPrivateGraphEndpointInput {
|
|
1044
|
+
/**
|
|
1045
|
+
* @public
|
|
1046
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1047
|
+
*/
|
|
1048
|
+
graphIdentifier: string | undefined;
|
|
1049
|
+
/**
|
|
1050
|
+
* @public
|
|
1051
|
+
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1052
|
+
*/
|
|
1053
|
+
vpcId: string | undefined;
|
|
1054
|
+
}
|
|
1055
|
+
/**
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
export interface GetPrivateGraphEndpointOutput {
|
|
1059
|
+
/**
|
|
1060
|
+
* @public
|
|
1061
|
+
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1062
|
+
*/
|
|
1063
|
+
vpcId: string | undefined;
|
|
1064
|
+
/**
|
|
1065
|
+
* @public
|
|
1066
|
+
* <p>The subnet IDs involved.</p>
|
|
1067
|
+
*/
|
|
1068
|
+
subnetIds: string[] | undefined;
|
|
1069
|
+
/**
|
|
1070
|
+
* @public
|
|
1071
|
+
* <p>The current status of the private endpoint.</p>
|
|
1072
|
+
*/
|
|
1073
|
+
status: PrivateGraphEndpointStatus | undefined;
|
|
1074
|
+
/**
|
|
1075
|
+
* @public
|
|
1076
|
+
* <p>The ID of the private endpoint.</p>
|
|
1077
|
+
*/
|
|
1078
|
+
vpcEndpointId?: string;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
export interface ListPrivateGraphEndpointsInput {
|
|
1084
|
+
/**
|
|
1085
|
+
* @public
|
|
1086
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1087
|
+
*/
|
|
1088
|
+
graphIdentifier: string | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* @public
|
|
1091
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1092
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1093
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1094
|
+
* that there are more results to retrieve.</p>
|
|
1095
|
+
*/
|
|
1096
|
+
nextToken?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* @public
|
|
1099
|
+
* <p>The total number of records to return in the command's output.</p>
|
|
1100
|
+
* <p>If the total number of records available is more than the value specified,
|
|
1101
|
+
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1102
|
+
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1103
|
+
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1104
|
+
* outside of the Amazon CLI.</p>
|
|
1105
|
+
*/
|
|
1106
|
+
maxResults?: number;
|
|
1107
|
+
}
|
|
1108
|
+
/**
|
|
1109
|
+
* @public
|
|
1110
|
+
* <p>Details about a private graph endpoint.</p>
|
|
1111
|
+
*/
|
|
1112
|
+
export interface PrivateGraphEndpointSummary {
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
* <p>The ID of the VPC in which the private graph endpoint is located.</p>
|
|
1116
|
+
*/
|
|
1117
|
+
vpcId: string | undefined;
|
|
1118
|
+
/**
|
|
1119
|
+
* @public
|
|
1120
|
+
* <p>The subnet IDs associated with the private graph endpoint.</p>
|
|
1121
|
+
*/
|
|
1122
|
+
subnetIds: string[] | undefined;
|
|
1123
|
+
/**
|
|
1124
|
+
* @public
|
|
1125
|
+
* <p>The status of the private graph endpoint.</p>
|
|
1126
|
+
*/
|
|
1127
|
+
status: PrivateGraphEndpointStatus | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* @public
|
|
1130
|
+
* <p>The ID of the VPC endpoint.</p>
|
|
1131
|
+
*/
|
|
1132
|
+
vpcEndpointId?: string;
|
|
1133
|
+
}
|
|
1134
|
+
/**
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1137
|
+
export interface ListPrivateGraphEndpointsOutput {
|
|
1138
|
+
/**
|
|
1139
|
+
* @public
|
|
1140
|
+
* <p>A list of private endpoints for the specified Neptune Analytics graph.</p>
|
|
1141
|
+
*/
|
|
1142
|
+
privateGraphEndpoints: PrivateGraphEndpointSummary[] | undefined;
|
|
1143
|
+
/**
|
|
1144
|
+
* @public
|
|
1145
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1146
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1147
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1148
|
+
* that there are more results to retrieve.</p>
|
|
1149
|
+
*/
|
|
1150
|
+
nextToken?: string;
|
|
1151
|
+
}
|
|
1152
|
+
/**
|
|
1153
|
+
* @public
|
|
1154
|
+
*/
|
|
1155
|
+
export interface CreateGraphSnapshotInput {
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1159
|
+
*/
|
|
1160
|
+
graphIdentifier: string | undefined;
|
|
1161
|
+
/**
|
|
1162
|
+
* @public
|
|
1163
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1164
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1165
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1166
|
+
* consecutive hyphens.</p>
|
|
1167
|
+
*/
|
|
1168
|
+
snapshotName: string | undefined;
|
|
1169
|
+
/**
|
|
1170
|
+
* @public
|
|
1171
|
+
* <p>Adds metadata tags to the new graph.
|
|
1172
|
+
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1173
|
+
*/
|
|
1174
|
+
tags?: Record<string, string>;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
* @enum
|
|
1179
|
+
*/
|
|
1180
|
+
export declare const SnapshotStatus: {
|
|
1181
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
1182
|
+
readonly CREATING: "CREATING";
|
|
1183
|
+
readonly DELETING: "DELETING";
|
|
1184
|
+
readonly FAILED: "FAILED";
|
|
1185
|
+
};
|
|
1186
|
+
/**
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus];
|
|
1190
|
+
/**
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
export interface CreateGraphSnapshotOutput {
|
|
1194
|
+
/**
|
|
1195
|
+
* @public
|
|
1196
|
+
* <p>The ID of the snapshot created.</p>
|
|
1197
|
+
*/
|
|
1198
|
+
id: string | undefined;
|
|
1199
|
+
/**
|
|
1200
|
+
* @public
|
|
1201
|
+
* <p>The name of the snapshot created.</p>
|
|
1202
|
+
*/
|
|
1203
|
+
name: string | undefined;
|
|
1204
|
+
/**
|
|
1205
|
+
* @public
|
|
1206
|
+
* <p>The ARN of the snapshot created.</p>
|
|
1207
|
+
*/
|
|
1208
|
+
arn: string | undefined;
|
|
1209
|
+
/**
|
|
1210
|
+
* @public
|
|
1211
|
+
* <p>The Id of the Neptune Analytics graph from which the snapshot is created.</p>
|
|
1212
|
+
*/
|
|
1213
|
+
sourceGraphId?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* @public
|
|
1216
|
+
* <p>The snapshot creation time</p>
|
|
1217
|
+
*/
|
|
1218
|
+
snapshotCreateTime?: Date;
|
|
1219
|
+
/**
|
|
1220
|
+
* @public
|
|
1221
|
+
* <p>The current state of the snapshot.</p>
|
|
1222
|
+
*/
|
|
1223
|
+
status?: SnapshotStatus;
|
|
1224
|
+
/**
|
|
1225
|
+
* @public
|
|
1226
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1227
|
+
*/
|
|
1228
|
+
kmsKeyIdentifier?: string;
|
|
1229
|
+
}
|
|
1230
|
+
/**
|
|
1231
|
+
* @public
|
|
1232
|
+
*/
|
|
1233
|
+
export interface DeleteGraphSnapshotInput {
|
|
1234
|
+
/**
|
|
1235
|
+
* @public
|
|
1236
|
+
* <p>ID of the graph snapshot to be deleted.</p>
|
|
1237
|
+
*/
|
|
1238
|
+
snapshotIdentifier: string | undefined;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
export interface DeleteGraphSnapshotOutput {
|
|
1244
|
+
/**
|
|
1245
|
+
* @public
|
|
1246
|
+
* <p>The unique identifier of the graph snapshot.</p>
|
|
1247
|
+
*/
|
|
1248
|
+
id: string | undefined;
|
|
1249
|
+
/**
|
|
1250
|
+
* @public
|
|
1251
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1252
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1253
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1254
|
+
* consecutive hyphens.</p>
|
|
1255
|
+
*/
|
|
1256
|
+
name: string | undefined;
|
|
1257
|
+
/**
|
|
1258
|
+
* @public
|
|
1259
|
+
* <p>The ARN of the graph snapshot.</p>
|
|
1260
|
+
*/
|
|
1261
|
+
arn: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* @public
|
|
1264
|
+
* <p>The graph identifier for the graph from which the snapshot was created.</p>
|
|
1265
|
+
*/
|
|
1266
|
+
sourceGraphId?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* @public
|
|
1269
|
+
* <p>The time when the snapshot was created.</p>
|
|
1270
|
+
*/
|
|
1271
|
+
snapshotCreateTime?: Date;
|
|
1272
|
+
/**
|
|
1273
|
+
* @public
|
|
1274
|
+
* <p>The status of the graph snapshot.</p>
|
|
1275
|
+
*/
|
|
1276
|
+
status?: SnapshotStatus;
|
|
1277
|
+
/**
|
|
1278
|
+
* @public
|
|
1279
|
+
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1280
|
+
*/
|
|
1281
|
+
kmsKeyIdentifier?: string;
|
|
1282
|
+
}
|
|
1283
|
+
/**
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
export interface GetGraphSnapshotInput {
|
|
1287
|
+
/**
|
|
1288
|
+
* @public
|
|
1289
|
+
* <p>The ID of the snapshot to retrieve.</p>
|
|
1290
|
+
*/
|
|
1291
|
+
snapshotIdentifier: string | undefined;
|
|
1292
|
+
}
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
export interface GetGraphSnapshotOutput {
|
|
1297
|
+
/**
|
|
1298
|
+
* @public
|
|
1299
|
+
* <p>The unique identifier of the graph snapshot.</p>
|
|
1300
|
+
*/
|
|
1301
|
+
id: string | undefined;
|
|
1302
|
+
/**
|
|
1303
|
+
* @public
|
|
1304
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1305
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1306
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1307
|
+
* consecutive hyphens.</p>
|
|
1308
|
+
*/
|
|
1309
|
+
name: string | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* @public
|
|
1312
|
+
* <p>The ARN of the graph snapshot.</p>
|
|
1313
|
+
*/
|
|
1314
|
+
arn: string | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* @public
|
|
1317
|
+
* <p>The graph identifier for the graph for which a snapshot is to be created.</p>
|
|
1318
|
+
*/
|
|
1319
|
+
sourceGraphId?: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* @public
|
|
1322
|
+
* <p>The time when the snapshot was created.</p>
|
|
1323
|
+
*/
|
|
1324
|
+
snapshotCreateTime?: Date;
|
|
1325
|
+
/**
|
|
1326
|
+
* @public
|
|
1327
|
+
* <p>The status of the graph snapshot.</p>
|
|
1328
|
+
*/
|
|
1329
|
+
status?: SnapshotStatus;
|
|
1330
|
+
/**
|
|
1331
|
+
* @public
|
|
1332
|
+
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1333
|
+
*/
|
|
1334
|
+
kmsKeyIdentifier?: string;
|
|
1335
|
+
}
|
|
1336
|
+
/**
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
export interface ListGraphSnapshotsInput {
|
|
1340
|
+
/**
|
|
1341
|
+
* @public
|
|
1342
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1343
|
+
*/
|
|
1344
|
+
graphIdentifier?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* @public
|
|
1347
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1348
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1349
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1350
|
+
* that there are more results to retrieve.</p>
|
|
1351
|
+
*/
|
|
1352
|
+
nextToken?: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* @public
|
|
1355
|
+
* <p>The total number of records to return in the command's output.</p>
|
|
1356
|
+
* <p>If the total number of records available is more than the value specified,
|
|
1357
|
+
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1358
|
+
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1359
|
+
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1360
|
+
* outside of the Amazon CLI.</p>
|
|
1361
|
+
*/
|
|
1362
|
+
maxResults?: number;
|
|
1363
|
+
}
|
|
1364
|
+
/**
|
|
1365
|
+
* @public
|
|
1366
|
+
* <p>Details about a graph snapshot.</p>
|
|
1367
|
+
*/
|
|
1368
|
+
export interface GraphSnapshotSummary {
|
|
1369
|
+
/**
|
|
1370
|
+
* @public
|
|
1371
|
+
* <p>The unique identifier of the graph snapshot.</p>
|
|
1372
|
+
*/
|
|
1373
|
+
id: string | undefined;
|
|
1374
|
+
/**
|
|
1375
|
+
* @public
|
|
1376
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1377
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1378
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1379
|
+
* consecutive hyphens.</p>
|
|
1380
|
+
*/
|
|
1381
|
+
name: string | undefined;
|
|
1382
|
+
/**
|
|
1383
|
+
* @public
|
|
1384
|
+
* <p>The ARN of the graph snapshot.</p>
|
|
1385
|
+
*/
|
|
1386
|
+
arn: string | undefined;
|
|
1387
|
+
/**
|
|
1388
|
+
* @public
|
|
1389
|
+
* <p>The graph identifier for the graph for which a snapshot is to be created.</p>
|
|
1390
|
+
*/
|
|
1391
|
+
sourceGraphId?: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* @public
|
|
1394
|
+
* <p>The time when the snapshot was created.</p>
|
|
1395
|
+
*/
|
|
1396
|
+
snapshotCreateTime?: Date;
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
* <p>The status of the graph snapshot.</p>
|
|
1400
|
+
*/
|
|
1401
|
+
status?: SnapshotStatus;
|
|
1402
|
+
/**
|
|
1403
|
+
* @public
|
|
1404
|
+
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1405
|
+
*/
|
|
1406
|
+
kmsKeyIdentifier?: string;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
export interface ListGraphSnapshotsOutput {
|
|
1412
|
+
/**
|
|
1413
|
+
* @public
|
|
1414
|
+
* <p>The requested list of snapshots.</p>
|
|
1415
|
+
*/
|
|
1416
|
+
graphSnapshots: GraphSnapshotSummary[] | undefined;
|
|
1417
|
+
/**
|
|
1418
|
+
* @public
|
|
1419
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1420
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1421
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1422
|
+
* that there are more results to retrieve.</p>
|
|
1423
|
+
*/
|
|
1424
|
+
nextToken?: string;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
export interface TagResourceInput {
|
|
1430
|
+
/**
|
|
1431
|
+
* @public
|
|
1432
|
+
* <p>ARN of the resource for which tags need to be added.</p>
|
|
1433
|
+
*/
|
|
1434
|
+
resourceArn: string | undefined;
|
|
1435
|
+
/**
|
|
1436
|
+
* @public
|
|
1437
|
+
* <p>The tags to be assigned to the Neptune Analytics resource.</p>
|
|
1438
|
+
* <p>The tags are metadata that are specified as a list of key-value pairs:</p>
|
|
1439
|
+
* <p>
|
|
1440
|
+
* <b>Key</b> (string) –
|
|
1441
|
+
* A key is the required name of the tag. The string value can be
|
|
1442
|
+
* from 1 to 128 Unicode characters in length. It can't be
|
|
1443
|
+
* prefixed with <code>aws:</code> and can only contain the
|
|
1444
|
+
* set of Unicode characters specified by this Java regular expression:
|
|
1445
|
+
* <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1446
|
+
* <p>
|
|
1447
|
+
* <b>Value</b> (string) –
|
|
1448
|
+
* A value is the optional value of the tag. The string value can
|
|
1449
|
+
* be from 1 to 256 Unicode characters in length. It can't be
|
|
1450
|
+
* prefixed with <code>aws:</code> and can only contain the
|
|
1451
|
+
* set of Unicode characters specified by this Java regular expression:
|
|
1452
|
+
* <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1453
|
+
*/
|
|
1454
|
+
tags: Record<string, string> | undefined;
|
|
1455
|
+
}
|
|
1456
|
+
/**
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
export interface TagResourceOutput {
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
export interface CancelImportTaskInput {
|
|
1465
|
+
/**
|
|
1466
|
+
* @public
|
|
1467
|
+
* <p>The unique identifier of the import task.</p>
|
|
1468
|
+
*/
|
|
1469
|
+
taskIdentifier: string | undefined;
|
|
1470
|
+
}
|
|
1471
|
+
/**
|
|
1472
|
+
* @public
|
|
1473
|
+
* @enum
|
|
1474
|
+
*/
|
|
1475
|
+
export declare const Format: {
|
|
1476
|
+
readonly CSV: "CSV";
|
|
1477
|
+
readonly OPEN_CYPHER: "OPEN_CYPHER";
|
|
1478
|
+
};
|
|
1479
|
+
/**
|
|
1480
|
+
* @public
|
|
1481
|
+
*/
|
|
1482
|
+
export type Format = (typeof Format)[keyof typeof Format];
|
|
1483
|
+
/**
|
|
1484
|
+
* @public
|
|
1485
|
+
* @enum
|
|
1486
|
+
*/
|
|
1487
|
+
export declare const ImportTaskStatus: {
|
|
1488
|
+
readonly ANALYZING_DATA: "ANALYZING_DATA";
|
|
1489
|
+
readonly CANCELLED: "CANCELLED";
|
|
1490
|
+
readonly CANCELLING: "CANCELLING";
|
|
1491
|
+
readonly EXPORTING: "EXPORTING";
|
|
1492
|
+
readonly FAILED: "FAILED";
|
|
1493
|
+
readonly IMPORTING: "IMPORTING";
|
|
1494
|
+
readonly INITIALIZING: "INITIALIZING";
|
|
1495
|
+
readonly REPROVISIONING: "REPROVISIONING";
|
|
1496
|
+
readonly ROLLING_BACK: "ROLLING_BACK";
|
|
1497
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1498
|
+
};
|
|
1499
|
+
/**
|
|
1500
|
+
* @public
|
|
1501
|
+
*/
|
|
1502
|
+
export type ImportTaskStatus = (typeof ImportTaskStatus)[keyof typeof ImportTaskStatus];
|
|
1503
|
+
/**
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
export interface CancelImportTaskOutput {
|
|
1507
|
+
/**
|
|
1508
|
+
* @public
|
|
1509
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1510
|
+
*/
|
|
1511
|
+
graphId?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* @public
|
|
1514
|
+
* <p>The unique identifier of the import task.</p>
|
|
1515
|
+
*/
|
|
1516
|
+
taskId: string | undefined;
|
|
1517
|
+
/**
|
|
1518
|
+
* @public
|
|
1519
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1520
|
+
* or can point to a Neptune database endpoint or snapshot</p>
|
|
1521
|
+
*/
|
|
1522
|
+
source: string | undefined;
|
|
1523
|
+
/**
|
|
1524
|
+
* @public
|
|
1525
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1526
|
+
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1527
|
+
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1528
|
+
* load format</a>.</p>
|
|
1529
|
+
*/
|
|
1530
|
+
format?: Format;
|
|
1531
|
+
/**
|
|
1532
|
+
* @public
|
|
1533
|
+
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1534
|
+
*/
|
|
1535
|
+
roleArn: string | undefined;
|
|
1536
|
+
/**
|
|
1537
|
+
* @public
|
|
1538
|
+
* <p>Current status of the task. Status is CANCELLING when the import task is cancelled.</p>
|
|
1539
|
+
*/
|
|
1540
|
+
status: ImportTaskStatus | undefined;
|
|
1541
|
+
}
|
|
1542
|
+
/**
|
|
1543
|
+
* @public
|
|
1544
|
+
* <p>Options for how to import Neptune data.</p>
|
|
1545
|
+
*/
|
|
1546
|
+
export interface NeptuneImportOptions {
|
|
1547
|
+
/**
|
|
1548
|
+
* @public
|
|
1549
|
+
* <p>The path to an S3 bucket from which to import data.</p>
|
|
1550
|
+
*/
|
|
1551
|
+
s3ExportPath: string | undefined;
|
|
1552
|
+
/**
|
|
1553
|
+
* @public
|
|
1554
|
+
* <p>The KMS key to use to encrypt data in the S3 bucket where the graph data is exported</p>
|
|
1555
|
+
*/
|
|
1556
|
+
s3ExportKmsKeyId: string | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* @public
|
|
1559
|
+
* <p>Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly
|
|
1560
|
+
* provided. Neptune assigns default labels when none is explicitly provided. When importing the data into
|
|
1561
|
+
* Neptune Analytics, the default vertex labels can be omitted by setting
|
|
1562
|
+
* <i>preserveDefaultVertexLabels</i> to false. Note that if the vertex only has default labels,
|
|
1563
|
+
* and has no other properties or edges, then the vertex will effectively not get
|
|
1564
|
+
* imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.</p>
|
|
1565
|
+
*/
|
|
1566
|
+
preserveDefaultVertexLabels?: boolean;
|
|
1567
|
+
/**
|
|
1568
|
+
* @public
|
|
1569
|
+
* <p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by
|
|
1570
|
+
* default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as
|
|
1571
|
+
* properties on the relationships with the property name neptuneEdgeId.</p>
|
|
1572
|
+
*/
|
|
1573
|
+
preserveEdgeIds?: boolean;
|
|
1574
|
+
}
|
|
1575
|
+
/**
|
|
1576
|
+
* @public
|
|
1577
|
+
* <p>Options for how to perform an import.</p>
|
|
1578
|
+
*/
|
|
1579
|
+
export type ImportOptions = ImportOptions.NeptuneMember | ImportOptions.$UnknownMember;
|
|
1580
|
+
/**
|
|
1581
|
+
* @public
|
|
1582
|
+
*/
|
|
1583
|
+
export declare namespace ImportOptions {
|
|
1584
|
+
/**
|
|
1585
|
+
* @public
|
|
1586
|
+
* <p>Options for importing data from a Neptune database.</p>
|
|
1587
|
+
*/
|
|
1588
|
+
interface NeptuneMember {
|
|
1589
|
+
neptune: NeptuneImportOptions;
|
|
1590
|
+
$unknown?: never;
|
|
1591
|
+
}
|
|
1592
|
+
/**
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
interface $UnknownMember {
|
|
1596
|
+
neptune?: never;
|
|
1597
|
+
$unknown: [string, any];
|
|
1598
|
+
}
|
|
1599
|
+
interface Visitor<T> {
|
|
1600
|
+
neptune: (value: NeptuneImportOptions) => T;
|
|
1601
|
+
_: (name: string, value: any) => T;
|
|
1602
|
+
}
|
|
1603
|
+
const visit: <T>(value: ImportOptions, visitor: Visitor<T>) => T;
|
|
1604
|
+
}
|
|
1605
|
+
/**
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
export interface CreateGraphUsingImportTaskInput {
|
|
1609
|
+
/**
|
|
1610
|
+
* @public
|
|
1611
|
+
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
1612
|
+
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1613
|
+
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1614
|
+
* consecutive hyphens. </p>
|
|
1615
|
+
*/
|
|
1616
|
+
graphName: string | undefined;
|
|
1617
|
+
/**
|
|
1618
|
+
* @public
|
|
1619
|
+
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation
|
|
1620
|
+
* reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1621
|
+
*/
|
|
1622
|
+
tags?: Record<string, string>;
|
|
1623
|
+
/**
|
|
1624
|
+
* @public
|
|
1625
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
|
|
1626
|
+
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
1627
|
+
*/
|
|
1628
|
+
publicConnectivity?: boolean;
|
|
1629
|
+
/**
|
|
1630
|
+
* @public
|
|
1631
|
+
* <p>Specifies a KMS key to use to encrypt data imported into the new graph.</p>
|
|
1632
|
+
*/
|
|
1633
|
+
kmsKeyIdentifier?: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* @public
|
|
1636
|
+
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
1637
|
+
* The value is specified as <code>dimension=</code>value. Max = 65,535 </p>
|
|
1638
|
+
*/
|
|
1639
|
+
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
1640
|
+
/**
|
|
1641
|
+
* @public
|
|
1642
|
+
* <p>The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.</p>
|
|
1643
|
+
*/
|
|
1644
|
+
replicaCount?: number;
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
1648
|
+
* (<code>true</code> or <code>false</code>).</p>
|
|
1649
|
+
*/
|
|
1650
|
+
deletionProtection?: boolean;
|
|
1651
|
+
/**
|
|
1652
|
+
* @public
|
|
1653
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
1654
|
+
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
1655
|
+
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
1656
|
+
* encountered.</p>
|
|
1657
|
+
*/
|
|
1658
|
+
importOptions?: ImportOptions;
|
|
1659
|
+
/**
|
|
1660
|
+
* @public
|
|
1661
|
+
* <p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024,
|
|
1662
|
+
* or the approved upper limit for your account.</p>
|
|
1663
|
+
* <p> If both the minimum and maximum values are specified, the max of the
|
|
1664
|
+
* <code>min-provisioned-memory</code> and <code>max-provisioned memory</code> is
|
|
1665
|
+
* used to create the graph. If neither value is specified 128 m-NCUs are used.</p>
|
|
1666
|
+
*/
|
|
1667
|
+
maxProvisionedMemory?: number;
|
|
1668
|
+
/**
|
|
1669
|
+
* @public
|
|
1670
|
+
* <p>The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128</p>
|
|
1671
|
+
*/
|
|
1672
|
+
minProvisionedMemory?: number;
|
|
1673
|
+
/**
|
|
1674
|
+
* @public
|
|
1675
|
+
* <p>If set to <code>true</code>, the task halts when an import error is encountered. If set to <code>false</code>,
|
|
1676
|
+
* the task skips the data that caused the error and continues if possible.</p>
|
|
1677
|
+
*/
|
|
1678
|
+
failOnError?: boolean;
|
|
1679
|
+
/**
|
|
1680
|
+
* @public
|
|
1681
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1682
|
+
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
1683
|
+
*/
|
|
1684
|
+
source: string | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* @public
|
|
1687
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1688
|
+
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1689
|
+
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1690
|
+
* load format</a>.</p>
|
|
1691
|
+
*/
|
|
1692
|
+
format?: Format;
|
|
1693
|
+
/**
|
|
1694
|
+
* @public
|
|
1695
|
+
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1696
|
+
*/
|
|
1697
|
+
roleArn: string | undefined;
|
|
1698
|
+
}
|
|
1699
|
+
/**
|
|
1700
|
+
* @public
|
|
1701
|
+
*/
|
|
1702
|
+
export interface CreateGraphUsingImportTaskOutput {
|
|
1703
|
+
/**
|
|
1704
|
+
* @public
|
|
1705
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1706
|
+
*/
|
|
1707
|
+
graphId?: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* @public
|
|
1710
|
+
* <p>The unique identifier of the import task.</p>
|
|
1711
|
+
*/
|
|
1712
|
+
taskId: string | undefined;
|
|
1713
|
+
/**
|
|
1714
|
+
* @public
|
|
1715
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1716
|
+
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
1717
|
+
*/
|
|
1718
|
+
source: string | undefined;
|
|
1719
|
+
/**
|
|
1720
|
+
* @public
|
|
1721
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1722
|
+
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1723
|
+
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1724
|
+
* load format</a>.</p>
|
|
1725
|
+
*/
|
|
1726
|
+
format?: Format;
|
|
1727
|
+
/**
|
|
1728
|
+
* @public
|
|
1729
|
+
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1730
|
+
*/
|
|
1731
|
+
roleArn: string | undefined;
|
|
1732
|
+
/**
|
|
1733
|
+
* @public
|
|
1734
|
+
* <p>The status of the import task.</p>
|
|
1735
|
+
*/
|
|
1736
|
+
status: ImportTaskStatus | undefined;
|
|
1737
|
+
/**
|
|
1738
|
+
* @public
|
|
1739
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
1740
|
+
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
1741
|
+
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
1742
|
+
* encountered.</p>
|
|
1743
|
+
*/
|
|
1744
|
+
importOptions?: ImportOptions;
|
|
1745
|
+
}
|
|
1746
|
+
/**
|
|
1747
|
+
* @public
|
|
1748
|
+
*/
|
|
1749
|
+
export interface GetImportTaskInput {
|
|
1750
|
+
/**
|
|
1751
|
+
* @public
|
|
1752
|
+
* <p>The unique identifier of the import task.</p>
|
|
1753
|
+
*/
|
|
1754
|
+
taskIdentifier: string | undefined;
|
|
1755
|
+
}
|
|
1756
|
+
/**
|
|
1757
|
+
* @public
|
|
1758
|
+
* <p>Contains details about an import task.</p>
|
|
1759
|
+
*/
|
|
1760
|
+
export interface ImportTaskDetails {
|
|
1761
|
+
/**
|
|
1762
|
+
* @public
|
|
1763
|
+
* <p>Status of the import task.</p>
|
|
1764
|
+
*/
|
|
1765
|
+
status: string | undefined;
|
|
1766
|
+
/**
|
|
1767
|
+
* @public
|
|
1768
|
+
* <p>Time at which the import task started.</p>
|
|
1769
|
+
*/
|
|
1770
|
+
startTime: Date | undefined;
|
|
1771
|
+
/**
|
|
1772
|
+
* @public
|
|
1773
|
+
* <p>Seconds elapsed since the import task started.</p>
|
|
1774
|
+
*/
|
|
1775
|
+
timeElapsedSeconds: number | undefined;
|
|
1776
|
+
/**
|
|
1777
|
+
* @public
|
|
1778
|
+
* <p>The percentage progress so far.</p>
|
|
1779
|
+
*/
|
|
1780
|
+
progressPercentage: number | undefined;
|
|
1781
|
+
/**
|
|
1782
|
+
* @public
|
|
1783
|
+
* <p>The number of errors encountered so far.</p>
|
|
1784
|
+
*/
|
|
1785
|
+
errorCount: number | undefined;
|
|
1786
|
+
/**
|
|
1787
|
+
* @public
|
|
1788
|
+
* <p>Details about the errors that have been encountered.</p>
|
|
1789
|
+
*/
|
|
1790
|
+
errorDetails?: string;
|
|
1791
|
+
/**
|
|
1792
|
+
* @public
|
|
1793
|
+
* <p>The number of statements in the import task.</p>
|
|
1794
|
+
*/
|
|
1795
|
+
statementCount: number | undefined;
|
|
1796
|
+
/**
|
|
1797
|
+
* @public
|
|
1798
|
+
* <p>The number of dictionary entries in the import task.</p>
|
|
1799
|
+
*/
|
|
1800
|
+
dictionaryEntryCount: number | undefined;
|
|
1801
|
+
}
|
|
1802
|
+
/**
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
export interface GetImportTaskOutput {
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1809
|
+
*/
|
|
1810
|
+
graphId?: string;
|
|
1811
|
+
/**
|
|
1812
|
+
* @public
|
|
1813
|
+
* <p>The unique identifier of the import task.</p>
|
|
1814
|
+
*/
|
|
1815
|
+
taskId: string | undefined;
|
|
1816
|
+
/**
|
|
1817
|
+
* @public
|
|
1818
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1819
|
+
* or can point to a Neptune database endpoint or snapshot</p>
|
|
1820
|
+
*/
|
|
1821
|
+
source: string | undefined;
|
|
1822
|
+
/**
|
|
1823
|
+
* @public
|
|
1824
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1825
|
+
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1826
|
+
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1827
|
+
* load format</a>.</p>
|
|
1828
|
+
*/
|
|
1829
|
+
format?: Format;
|
|
1830
|
+
/**
|
|
1831
|
+
* @public
|
|
1832
|
+
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1833
|
+
*/
|
|
1834
|
+
roleArn: string | undefined;
|
|
1835
|
+
/**
|
|
1836
|
+
* @public
|
|
1837
|
+
* <p>The status of the import task:</p>
|
|
1838
|
+
* <ul>
|
|
1839
|
+
* <li>
|
|
1840
|
+
* <p>
|
|
1841
|
+
* <b>INITIALIZING</b> –
|
|
1842
|
+
* The necessary resources needed to create the graph are being prepared.</p>
|
|
1843
|
+
* </li>
|
|
1844
|
+
* <li>
|
|
1845
|
+
* <p>
|
|
1846
|
+
* <b>ANALYZING_DATA</b> –
|
|
1847
|
+
* The data is being analyzed to determine the optimal infrastructure configuration
|
|
1848
|
+
* for the new graph.</p>
|
|
1849
|
+
* </li>
|
|
1850
|
+
* <li>
|
|
1851
|
+
* <p>
|
|
1852
|
+
* <b>RE_PROVISIONING</b> –
|
|
1853
|
+
* The data did not fit into the provisioned graph, so it is being re-provisioned
|
|
1854
|
+
* with more capacity.</p>
|
|
1855
|
+
* </li>
|
|
1856
|
+
* <li>
|
|
1857
|
+
* <p>
|
|
1858
|
+
* <b>IMPORTING</b> –
|
|
1859
|
+
* The data is being loaded.</p>
|
|
1860
|
+
* </li>
|
|
1861
|
+
* <li>
|
|
1862
|
+
* <p>
|
|
1863
|
+
* <b>ERROR_ENCOUNTERED</b> –
|
|
1864
|
+
* An error has been encountered while trying to create the graph and import the data.</p>
|
|
1865
|
+
* </li>
|
|
1866
|
+
* <li>
|
|
1867
|
+
* <p>
|
|
1868
|
+
* <b>ERROR_ENCOUNTERED_ROLLING_BACK</b> –
|
|
1869
|
+
* Because of the error that was encountered, the graph is being rolled back and all
|
|
1870
|
+
* its resources released.</p>
|
|
1871
|
+
* </li>
|
|
1872
|
+
* <li>
|
|
1873
|
+
* <p>
|
|
1874
|
+
* <b>SUCCEEDED</b> –
|
|
1875
|
+
* Graph creation and data loading succeeded.</p>
|
|
1876
|
+
* </li>
|
|
1877
|
+
* <li>
|
|
1878
|
+
* <p>
|
|
1879
|
+
* <b>FAILED</b> –
|
|
1880
|
+
* Graph creation or data loading failed. When the status is <code>FAILED</code>,
|
|
1881
|
+
* you can use <code>get-graphs</code> to get more information about the state of
|
|
1882
|
+
* the graph.</p>
|
|
1883
|
+
* </li>
|
|
1884
|
+
* <li>
|
|
1885
|
+
* <p>
|
|
1886
|
+
* <b>CANCELLING</b> –
|
|
1887
|
+
* Because you cancelled the import task, cancellation is in progress.</p>
|
|
1888
|
+
* </li>
|
|
1889
|
+
* <li>
|
|
1890
|
+
* <p>
|
|
1891
|
+
* <b>CANCELLED</b> –
|
|
1892
|
+
* You have successfully cancelled the import task.</p>
|
|
1893
|
+
* </li>
|
|
1894
|
+
* </ul>
|
|
1895
|
+
*/
|
|
1896
|
+
status: ImportTaskStatus | undefined;
|
|
1897
|
+
/**
|
|
1898
|
+
* @public
|
|
1899
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
1900
|
+
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
1901
|
+
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
1902
|
+
* encountered.</p>
|
|
1903
|
+
*/
|
|
1904
|
+
importOptions?: ImportOptions;
|
|
1905
|
+
/**
|
|
1906
|
+
* @public
|
|
1907
|
+
* <p>Contains details about the specified import task.</p>
|
|
1908
|
+
*/
|
|
1909
|
+
importTaskDetails?: ImportTaskDetails;
|
|
1910
|
+
/**
|
|
1911
|
+
* @public
|
|
1912
|
+
* <p>The number of the current attempt to execute the import task.</p>
|
|
1913
|
+
*/
|
|
1914
|
+
attemptNumber?: number;
|
|
1915
|
+
/**
|
|
1916
|
+
* @public
|
|
1917
|
+
* <p>The reason that the import task has this status value.</p>
|
|
1918
|
+
*/
|
|
1919
|
+
statusReason?: string;
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1924
|
+
export interface ListImportTasksInput {
|
|
1925
|
+
/**
|
|
1926
|
+
* @public
|
|
1927
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1928
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1929
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1930
|
+
* that there are more results to retrieve.</p>
|
|
1931
|
+
*/
|
|
1932
|
+
nextToken?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* @public
|
|
1935
|
+
* <p>The total number of records to return in the command's output.</p>
|
|
1936
|
+
* <p>If the total number of records available is more than the value specified,
|
|
1937
|
+
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1938
|
+
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1939
|
+
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1940
|
+
* outside of the Amazon CLI.</p>
|
|
1941
|
+
*/
|
|
1942
|
+
maxResults?: number;
|
|
1943
|
+
}
|
|
1944
|
+
/**
|
|
1945
|
+
* @public
|
|
1946
|
+
* <p>Details about an import task.</p>
|
|
1947
|
+
*/
|
|
1948
|
+
export interface ImportTaskSummary {
|
|
1949
|
+
/**
|
|
1950
|
+
* @public
|
|
1951
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1952
|
+
*/
|
|
1953
|
+
graphId?: string;
|
|
1954
|
+
/**
|
|
1955
|
+
* @public
|
|
1956
|
+
* <p>The unique identifier of the import task.</p>
|
|
1957
|
+
*/
|
|
1958
|
+
taskId: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* @public
|
|
1961
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1962
|
+
* or can point to a Neptune database endpoint or snapshot</p>
|
|
1963
|
+
*/
|
|
1964
|
+
source: string | undefined;
|
|
1965
|
+
/**
|
|
1966
|
+
* @public
|
|
1967
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1968
|
+
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1969
|
+
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1970
|
+
* load format</a>.</p>
|
|
1971
|
+
*/
|
|
1972
|
+
format?: Format;
|
|
1973
|
+
/**
|
|
1974
|
+
* @public
|
|
1975
|
+
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1976
|
+
*/
|
|
1977
|
+
roleArn: string | undefined;
|
|
1978
|
+
/**
|
|
1979
|
+
* @public
|
|
1980
|
+
* <p>Status of the import task.</p>
|
|
1981
|
+
*/
|
|
1982
|
+
status: ImportTaskStatus | undefined;
|
|
1983
|
+
}
|
|
1984
|
+
/**
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
export interface ListImportTasksOutput {
|
|
1988
|
+
/**
|
|
1989
|
+
* @public
|
|
1990
|
+
* <p>The requested list of import tasks.</p>
|
|
1991
|
+
*/
|
|
1992
|
+
tasks: ImportTaskSummary[] | undefined;
|
|
1993
|
+
/**
|
|
1994
|
+
* @public
|
|
1995
|
+
* <p>Pagination token used to paginate output.</p>
|
|
1996
|
+
* <p>When this value is provided as input, the service returns results from where
|
|
1997
|
+
* the previous response left off. When this value is present in output, it indicates
|
|
1998
|
+
* that there are more results to retrieve.</p>
|
|
1999
|
+
*/
|
|
2000
|
+
nextToken?: string;
|
|
2001
|
+
}
|
|
2002
|
+
/**
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
2005
|
+
export interface UntagResourceInput {
|
|
2006
|
+
/**
|
|
2007
|
+
* @public
|
|
2008
|
+
* <p>ARN of the resource whose tag needs to be removed.</p>
|
|
2009
|
+
*/
|
|
2010
|
+
resourceArn: string | undefined;
|
|
2011
|
+
/**
|
|
2012
|
+
* @public
|
|
2013
|
+
* <p>Tag keys for the tags to be removed.</p>
|
|
2014
|
+
*/
|
|
2015
|
+
tagKeys: string[] | undefined;
|
|
2016
|
+
}
|
|
2017
|
+
/**
|
|
2018
|
+
* @public
|
|
2019
|
+
*/
|
|
2020
|
+
export interface UntagResourceOutput {
|
|
2021
|
+
}
|