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