aws-sdk-neptunedata 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3988 @@
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::Neptunedata
11
+ module Types
12
+
13
+ # Raised in case of an authentication or authorization failure.
14
+ #
15
+ # @!attribute [rw] detailed_message
16
+ # A detailed message describing the problem.
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] request_id
20
+ # The ID of the request in question.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] code
24
+ # The HTTP status code returned with the exception.
25
+ # @return [String]
26
+ #
27
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/AccessDeniedException AWS API Documentation
28
+ #
29
+ class AccessDeniedException < Struct.new(
30
+ :detailed_message,
31
+ :request_id,
32
+ :code)
33
+ SENSITIVE = []
34
+ include Aws::Structure
35
+ end
36
+
37
+ # Raised when a request is submitted that cannot be processed.
38
+ #
39
+ # @!attribute [rw] detailed_message
40
+ # A detailed message describing the problem.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] request_id
44
+ # The ID of the bad request.
45
+ # @return [String]
46
+ #
47
+ # @!attribute [rw] code
48
+ # The HTTP status code returned with the exception.
49
+ # @return [String]
50
+ #
51
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/BadRequestException AWS API Documentation
52
+ #
53
+ class BadRequestException < Struct.new(
54
+ :detailed_message,
55
+ :request_id,
56
+ :code)
57
+ SENSITIVE = []
58
+ include Aws::Structure
59
+ end
60
+
61
+ # Raised when a specified bulk-load job ID cannot be found.
62
+ #
63
+ # @!attribute [rw] detailed_message
64
+ # A detailed message describing the problem.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] request_id
68
+ # The bulk-load job ID that could not be found.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] code
72
+ # The HTTP status code returned with the exception.
73
+ # @return [String]
74
+ #
75
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/BulkLoadIdNotFoundException AWS API Documentation
76
+ #
77
+ class BulkLoadIdNotFoundException < Struct.new(
78
+ :detailed_message,
79
+ :request_id,
80
+ :code)
81
+ SENSITIVE = []
82
+ include Aws::Structure
83
+ end
84
+
85
+ # @!attribute [rw] query_id
86
+ # The unique identifier that identifies the query to be canceled.
87
+ # @return [String]
88
+ #
89
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelGremlinQueryInput AWS API Documentation
90
+ #
91
+ class CancelGremlinQueryInput < Struct.new(
92
+ :query_id)
93
+ SENSITIVE = []
94
+ include Aws::Structure
95
+ end
96
+
97
+ # @!attribute [rw] status
98
+ # The status of the cancelation
99
+ # @return [String]
100
+ #
101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelGremlinQueryOutput AWS API Documentation
102
+ #
103
+ class CancelGremlinQueryOutput < Struct.new(
104
+ :status)
105
+ SENSITIVE = []
106
+ include Aws::Structure
107
+ end
108
+
109
+ # @!attribute [rw] load_id
110
+ # The ID of the load job to be deleted.
111
+ # @return [String]
112
+ #
113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelLoaderJobInput AWS API Documentation
114
+ #
115
+ class CancelLoaderJobInput < Struct.new(
116
+ :load_id)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # @!attribute [rw] status
122
+ # The cancellation status.
123
+ # @return [String]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelLoaderJobOutput AWS API Documentation
126
+ #
127
+ class CancelLoaderJobOutput < Struct.new(
128
+ :status)
129
+ SENSITIVE = []
130
+ include Aws::Structure
131
+ end
132
+
133
+ # @!attribute [rw] id
134
+ # The unique identifier of the data-processing job.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] neptune_iam_role_arn
138
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
139
+ # Amazon S3 resources. This must be listed in your DB cluster
140
+ # parameter group or an error will occur.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] clean
144
+ # If set to `TRUE`, this flag specifies that all Neptune ML S3
145
+ # artifacts should be deleted when the job is stopped. The default is
146
+ # `FALSE`.
147
+ # @return [Boolean]
148
+ #
149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLDataProcessingJobInput AWS API Documentation
150
+ #
151
+ class CancelMLDataProcessingJobInput < Struct.new(
152
+ :id,
153
+ :neptune_iam_role_arn,
154
+ :clean)
155
+ SENSITIVE = []
156
+ include Aws::Structure
157
+ end
158
+
159
+ # @!attribute [rw] status
160
+ # The status of the cancellation request.
161
+ # @return [String]
162
+ #
163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLDataProcessingJobOutput AWS API Documentation
164
+ #
165
+ class CancelMLDataProcessingJobOutput < Struct.new(
166
+ :status)
167
+ SENSITIVE = []
168
+ include Aws::Structure
169
+ end
170
+
171
+ # @!attribute [rw] id
172
+ # The unique identifier of the model-training job to be canceled.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] neptune_iam_role_arn
176
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
177
+ # Amazon S3 resources. This must be listed in your DB cluster
178
+ # parameter group or an error will occur.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] clean
182
+ # If set to `TRUE`, this flag specifies that all Amazon S3 artifacts
183
+ # should be deleted when the job is stopped. The default is `FALSE`.
184
+ # @return [Boolean]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLModelTrainingJobInput AWS API Documentation
187
+ #
188
+ class CancelMLModelTrainingJobInput < Struct.new(
189
+ :id,
190
+ :neptune_iam_role_arn,
191
+ :clean)
192
+ SENSITIVE = []
193
+ include Aws::Structure
194
+ end
195
+
196
+ # @!attribute [rw] status
197
+ # The status of the cancellation.
198
+ # @return [String]
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLModelTrainingJobOutput AWS API Documentation
201
+ #
202
+ class CancelMLModelTrainingJobOutput < Struct.new(
203
+ :status)
204
+ SENSITIVE = []
205
+ include Aws::Structure
206
+ end
207
+
208
+ # @!attribute [rw] id
209
+ # The unique ID of the model transform job to be canceled.
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] neptune_iam_role_arn
213
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
214
+ # Amazon S3 resources. This must be listed in your DB cluster
215
+ # parameter group or an error will occur.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] clean
219
+ # If this flag is set to `TRUE`, all Neptune ML S3 artifacts should be
220
+ # deleted when the job is stopped. The default is `FALSE`.
221
+ # @return [Boolean]
222
+ #
223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLModelTransformJobInput AWS API Documentation
224
+ #
225
+ class CancelMLModelTransformJobInput < Struct.new(
226
+ :id,
227
+ :neptune_iam_role_arn,
228
+ :clean)
229
+ SENSITIVE = []
230
+ include Aws::Structure
231
+ end
232
+
233
+ # @!attribute [rw] status
234
+ # the status of the cancelation.
235
+ # @return [String]
236
+ #
237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelMLModelTransformJobOutput AWS API Documentation
238
+ #
239
+ class CancelMLModelTransformJobOutput < Struct.new(
240
+ :status)
241
+ SENSITIVE = []
242
+ include Aws::Structure
243
+ end
244
+
245
+ # @!attribute [rw] query_id
246
+ # The unique ID of the openCypher query to cancel.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] silent
250
+ # If set to `TRUE`, causes the cancelation of the openCypher query to
251
+ # happen silently.
252
+ # @return [Boolean]
253
+ #
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelOpenCypherQueryInput AWS API Documentation
255
+ #
256
+ class CancelOpenCypherQueryInput < Struct.new(
257
+ :query_id,
258
+ :silent)
259
+ SENSITIVE = []
260
+ include Aws::Structure
261
+ end
262
+
263
+ # @!attribute [rw] status
264
+ # The cancellation status of the openCypher query.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] payload
268
+ # The cancelation payload for the openCypher query.
269
+ # @return [Boolean]
270
+ #
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelOpenCypherQueryOutput AWS API Documentation
272
+ #
273
+ class CancelOpenCypherQueryOutput < Struct.new(
274
+ :status,
275
+ :payload)
276
+ SENSITIVE = []
277
+ include Aws::Structure
278
+ end
279
+
280
+ # Raised when a user cancelled a request.
281
+ #
282
+ # @!attribute [rw] detailed_message
283
+ # A detailed message describing the problem.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] request_id
287
+ # The ID of the request in question.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] code
291
+ # The HTTP status code returned with the exception.
292
+ # @return [String]
293
+ #
294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CancelledByUserException AWS API Documentation
295
+ #
296
+ class CancelledByUserException < Struct.new(
297
+ :detailed_message,
298
+ :request_id,
299
+ :code)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # Raised when a request timed out in the client.
305
+ #
306
+ # @!attribute [rw] detailed_message
307
+ # A detailed message describing the problem.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] request_id
311
+ # The ID of the request in question.
312
+ # @return [String]
313
+ #
314
+ # @!attribute [rw] code
315
+ # The HTTP status code returned with the exception.
316
+ # @return [String]
317
+ #
318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ClientTimeoutException AWS API Documentation
319
+ #
320
+ class ClientTimeoutException < Struct.new(
321
+ :detailed_message,
322
+ :request_id,
323
+ :code)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
328
+ # Raised when a request attempts to modify data that is concurrently
329
+ # being modified by another process.
330
+ #
331
+ # @!attribute [rw] detailed_message
332
+ # A detailed message describing the problem.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] request_id
336
+ # The ID of the request in question.
337
+ # @return [String]
338
+ #
339
+ # @!attribute [rw] code
340
+ # The HTTP status code returned with the exception.
341
+ # @return [String]
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ConcurrentModificationException AWS API Documentation
344
+ #
345
+ class ConcurrentModificationException < Struct.new(
346
+ :detailed_message,
347
+ :request_id,
348
+ :code)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # Raised when a value in a request field did not satisfy required
354
+ # constraints.
355
+ #
356
+ # @!attribute [rw] detailed_message
357
+ # A detailed message describing the problem.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] request_id
361
+ # The ID of the request in question.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] code
365
+ # The HTTP status code returned with the exception.
366
+ # @return [String]
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ConstraintViolationException AWS API Documentation
369
+ #
370
+ class ConstraintViolationException < Struct.new(
371
+ :detailed_message,
372
+ :request_id,
373
+ :code)
374
+ SENSITIVE = []
375
+ include Aws::Structure
376
+ end
377
+
378
+ # @!attribute [rw] id
379
+ # A unique identifier for the new inference endpoint. The default is
380
+ # an autogenerated timestamped name.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] ml_model_training_job_id
384
+ # The job Id of the completed model-training job that has created the
385
+ # model that the inference endpoint will point to. You must supply
386
+ # either the `mlModelTrainingJobId` or the `mlModelTransformJobId`.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] ml_model_transform_job_id
390
+ # The job Id of the completed model-transform job. You must supply
391
+ # either the `mlModelTrainingJobId` or the `mlModelTransformJobId`.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] update
395
+ # If set to `true`, `update` indicates that this is an update request.
396
+ # The default is `false`. You must supply either the
397
+ # `mlModelTrainingJobId` or the `mlModelTransformJobId`.
398
+ # @return [Boolean]
399
+ #
400
+ # @!attribute [rw] neptune_iam_role_arn
401
+ # The ARN of an IAM role providing Neptune access to SageMaker and
402
+ # Amazon S3 resources. This must be listed in your DB cluster
403
+ # parameter group or an error will be thrown.
404
+ # @return [String]
405
+ #
406
+ # @!attribute [rw] model_name
407
+ # Model type for training. By default the Neptune ML model is
408
+ # automatically based on the `modelType` used in data processing, but
409
+ # you can specify a different model type here. The default is `rgcn`
410
+ # for heterogeneous graphs and `kge` for knowledge graphs. The only
411
+ # valid value for heterogeneous graphs is `rgcn`. Valid values for
412
+ # knowledge graphs are: `kge`, `transe`, `distmult`, and `rotate`.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] instance_type
416
+ # The type of Neptune ML instance to use for online servicing. The
417
+ # default is `ml.m5.xlarge`. Choosing the ML instance for an inference
418
+ # endpoint depends on the task type, the graph size, and your budget.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] instance_count
422
+ # The minimum number of Amazon EC2 instances to deploy to an endpoint
423
+ # for prediction. The default is 1
424
+ # @return [Integer]
425
+ #
426
+ # @!attribute [rw] volume_encryption_kms_key
427
+ # The Amazon Key Management Service (Amazon KMS) key that SageMaker
428
+ # uses to encrypt data on the storage volume attached to the ML
429
+ # compute instances that run the training job. The default is None.
430
+ # @return [String]
431
+ #
432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CreateMLEndpointInput AWS API Documentation
433
+ #
434
+ class CreateMLEndpointInput < Struct.new(
435
+ :id,
436
+ :ml_model_training_job_id,
437
+ :ml_model_transform_job_id,
438
+ :update,
439
+ :neptune_iam_role_arn,
440
+ :model_name,
441
+ :instance_type,
442
+ :instance_count,
443
+ :volume_encryption_kms_key)
444
+ SENSITIVE = []
445
+ include Aws::Structure
446
+ end
447
+
448
+ # @!attribute [rw] id
449
+ # The unique ID of the new inference endpoint.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] arn
453
+ # The ARN for the new inference endpoint.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] creation_time_in_millis
457
+ # The endpoint creation time, in milliseconds.
458
+ # @return [Integer]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CreateMLEndpointOutput AWS API Documentation
461
+ #
462
+ class CreateMLEndpointOutput < Struct.new(
463
+ :id,
464
+ :arn,
465
+ :creation_time_in_millis)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # Contains custom model training parameters. See [Custom models in
471
+ # Neptune ML][1].
472
+ #
473
+ #
474
+ #
475
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html
476
+ #
477
+ # @!attribute [rw] source_s3_directory_path
478
+ # The path to the Amazon S3 location where the Python module
479
+ # implementing your model is located. This must point to a valid
480
+ # existing Amazon S3 location that contains, at a minimum, a training
481
+ # script, a transform script, and a `model-hpo-configuration.json`
482
+ # file.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] training_entry_point_script
486
+ # The name of the entry point in your module of a script that performs
487
+ # model training and takes hyperparameters as command-line arguments,
488
+ # including fixed hyperparameters. The default is `training.py`.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] transform_entry_point_script
492
+ # The name of the entry point in your module of a script that should
493
+ # be run after the best model from the hyperparameter search has been
494
+ # identified, to compute the model artifacts necessary for model
495
+ # deployment. It should be able to run with no command-line
496
+ # arguments.The default is `transform.py`.
497
+ # @return [String]
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CustomModelTrainingParameters AWS API Documentation
500
+ #
501
+ class CustomModelTrainingParameters < Struct.new(
502
+ :source_s3_directory_path,
503
+ :training_entry_point_script,
504
+ :transform_entry_point_script)
505
+ SENSITIVE = []
506
+ include Aws::Structure
507
+ end
508
+
509
+ # Contains custom model transform parameters. See [Use a trained model
510
+ # to generate new model artifacts][1].
511
+ #
512
+ #
513
+ #
514
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html
515
+ #
516
+ # @!attribute [rw] source_s3_directory_path
517
+ # The path to the Amazon S3 location where the Python module
518
+ # implementing your model is located. This must point to a valid
519
+ # existing Amazon S3 location that contains, at a minimum, a training
520
+ # script, a transform script, and a `model-hpo-configuration.json`
521
+ # file.
522
+ # @return [String]
523
+ #
524
+ # @!attribute [rw] transform_entry_point_script
525
+ # The name of the entry point in your module of a script that should
526
+ # be run after the best model from the hyperparameter search has been
527
+ # identified, to compute the model artifacts necessary for model
528
+ # deployment. It should be able to run with no command-line arguments.
529
+ # The default is `transform.py`.
530
+ # @return [String]
531
+ #
532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/CustomModelTransformParameters AWS API Documentation
533
+ #
534
+ class CustomModelTransformParameters < Struct.new(
535
+ :source_s3_directory_path,
536
+ :transform_entry_point_script)
537
+ SENSITIVE = []
538
+ include Aws::Structure
539
+ end
540
+
541
+ # @!attribute [rw] id
542
+ # The unique identifier of the inference endpoint.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] neptune_iam_role_arn
546
+ # The ARN of an IAM role providing Neptune access to SageMaker and
547
+ # Amazon S3 resources. This must be listed in your DB cluster
548
+ # parameter group or an error will be thrown.
549
+ # @return [String]
550
+ #
551
+ # @!attribute [rw] clean
552
+ # If this flag is set to `TRUE`, all Neptune ML S3 artifacts should be
553
+ # deleted when the job is stopped. The default is `FALSE`.
554
+ # @return [Boolean]
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/DeleteMLEndpointInput AWS API Documentation
557
+ #
558
+ class DeleteMLEndpointInput < Struct.new(
559
+ :id,
560
+ :neptune_iam_role_arn,
561
+ :clean)
562
+ SENSITIVE = []
563
+ include Aws::Structure
564
+ end
565
+
566
+ # @!attribute [rw] status
567
+ # The status of the cancellation.
568
+ # @return [String]
569
+ #
570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/DeleteMLEndpointOutput AWS API Documentation
571
+ #
572
+ class DeleteMLEndpointOutput < Struct.new(
573
+ :status)
574
+ SENSITIVE = []
575
+ include Aws::Structure
576
+ end
577
+
578
+ # @!attribute [rw] status_code
579
+ # The HTTP response code: 200 if the delete was successful, or 204 if
580
+ # there were no statistics to delete.
581
+ # @return [Integer]
582
+ #
583
+ # @!attribute [rw] status
584
+ # The cancel status.
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] payload
588
+ # The deletion payload.
589
+ # @return [Types::DeleteStatisticsValueMap]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/DeletePropertygraphStatisticsOutput AWS API Documentation
592
+ #
593
+ class DeletePropertygraphStatisticsOutput < Struct.new(
594
+ :status_code,
595
+ :status,
596
+ :payload)
597
+ SENSITIVE = []
598
+ include Aws::Structure
599
+ end
600
+
601
+ # @!attribute [rw] status_code
602
+ # The HTTP response code: 200 if the delete was successful, or 204 if
603
+ # there were no statistics to delete.
604
+ # @return [Integer]
605
+ #
606
+ # @!attribute [rw] status
607
+ # The cancel status.
608
+ # @return [String]
609
+ #
610
+ # @!attribute [rw] payload
611
+ # The deletion payload.
612
+ # @return [Types::DeleteStatisticsValueMap]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/DeleteSparqlStatisticsOutput AWS API Documentation
615
+ #
616
+ class DeleteSparqlStatisticsOutput < Struct.new(
617
+ :status_code,
618
+ :status,
619
+ :payload)
620
+ SENSITIVE = []
621
+ include Aws::Structure
622
+ end
623
+
624
+ # The payload for DeleteStatistics.
625
+ #
626
+ # @!attribute [rw] active
627
+ # The current status of the statistics.
628
+ # @return [Boolean]
629
+ #
630
+ # @!attribute [rw] statistics_id
631
+ # The ID of the statistics generation run that is currently occurring.
632
+ # @return [String]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/DeleteStatisticsValueMap AWS API Documentation
635
+ #
636
+ class DeleteStatisticsValueMap < Struct.new(
637
+ :active,
638
+ :statistics_id)
639
+ SENSITIVE = []
640
+ include Aws::Structure
641
+ end
642
+
643
+ # An edge structure.
644
+ #
645
+ # @!attribute [rw] count
646
+ # The number of edges that have this specific structure.
647
+ # @return [Integer]
648
+ #
649
+ # @!attribute [rw] edge_properties
650
+ # A list of edge properties present in this specific structure.
651
+ # @return [Array<String>]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/EdgeStructure AWS API Documentation
654
+ #
655
+ class EdgeStructure < Struct.new(
656
+ :count,
657
+ :edge_properties)
658
+ SENSITIVE = []
659
+ include Aws::Structure
660
+ end
661
+
662
+ # @!attribute [rw] action
663
+ # The fast reset action. One of the following values:
664
+ #
665
+ # * <b> <code>initiateDatabaseReset</code> </b>   –   This action
666
+ # generates a unique token needed to actually perform the fast
667
+ # reset.
668
+ #
669
+ # * <b> <code>performDatabaseReset</code> </b>   –   This action uses
670
+ # the token generated by the `initiateDatabaseReset` action to
671
+ # actually perform the fast reset.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] token
675
+ # The fast-reset token to initiate the reset.
676
+ # @return [String]
677
+ #
678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteFastResetInput AWS API Documentation
679
+ #
680
+ class ExecuteFastResetInput < Struct.new(
681
+ :action,
682
+ :token)
683
+ SENSITIVE = []
684
+ include Aws::Structure
685
+ end
686
+
687
+ # @!attribute [rw] status
688
+ # The `status` is only returned for the `performDatabaseReset` action,
689
+ # and indicates whether or not the fast reset rquest is accepted.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] payload
693
+ # The `payload` is only returned by the `initiateDatabaseReset`
694
+ # action, and contains the unique token to use with the
695
+ # `performDatabaseReset` action to make the reset occur.
696
+ # @return [Types::FastResetToken]
697
+ #
698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteFastResetOutput AWS API Documentation
699
+ #
700
+ class ExecuteFastResetOutput < Struct.new(
701
+ :status,
702
+ :payload)
703
+ SENSITIVE = []
704
+ include Aws::Structure
705
+ end
706
+
707
+ # @!attribute [rw] gremlin_query
708
+ # The Gremlin explain query string.
709
+ # @return [String]
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinExplainQueryInput AWS API Documentation
712
+ #
713
+ class ExecuteGremlinExplainQueryInput < Struct.new(
714
+ :gremlin_query)
715
+ SENSITIVE = []
716
+ include Aws::Structure
717
+ end
718
+
719
+ # @!attribute [rw] output
720
+ # A text blob containing the Gremlin explain result, as described in
721
+ # [Tuning Gremlin queries][1].
722
+ #
723
+ #
724
+ #
725
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html
726
+ # @return [String]
727
+ #
728
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinExplainQueryOutput AWS API Documentation
729
+ #
730
+ class ExecuteGremlinExplainQueryOutput < Struct.new(
731
+ :output)
732
+ SENSITIVE = []
733
+ include Aws::Structure
734
+ end
735
+
736
+ # @!attribute [rw] gremlin_query
737
+ # The Gremlin query string to profile.
738
+ # @return [String]
739
+ #
740
+ # @!attribute [rw] results
741
+ # If this flag is set to `TRUE`, the query results are gathered and
742
+ # displayed as part of the profile report. If `FALSE`, only the result
743
+ # count is displayed.
744
+ # @return [Boolean]
745
+ #
746
+ # @!attribute [rw] chop
747
+ # If non-zero, causes the results string to be truncated at that
748
+ # number of characters. If set to zero, the string contains all the
749
+ # results.
750
+ # @return [Integer]
751
+ #
752
+ # @!attribute [rw] serializer
753
+ # If non-null, the gathered results are returned in a serialized
754
+ # response message in the format specified by this parameter. See
755
+ # [Gremlin profile API in Neptune][1] for more information.
756
+ #
757
+ #
758
+ #
759
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html
760
+ # @return [String]
761
+ #
762
+ # @!attribute [rw] index_ops
763
+ # If this flag is set to `TRUE`, the results include a detailed report
764
+ # of all index operations that took place during query execution and
765
+ # serialization.
766
+ # @return [Boolean]
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinProfileQueryInput AWS API Documentation
769
+ #
770
+ class ExecuteGremlinProfileQueryInput < Struct.new(
771
+ :gremlin_query,
772
+ :results,
773
+ :chop,
774
+ :serializer,
775
+ :index_ops)
776
+ SENSITIVE = []
777
+ include Aws::Structure
778
+ end
779
+
780
+ # @!attribute [rw] output
781
+ # A text blob containing the Gremlin Profile result. See [Gremlin
782
+ # profile API in Neptune][1] for details.
783
+ #
784
+ #
785
+ #
786
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html
787
+ # @return [String]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinProfileQueryOutput AWS API Documentation
790
+ #
791
+ class ExecuteGremlinProfileQueryOutput < Struct.new(
792
+ :output)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
797
+ # @!attribute [rw] gremlin_query
798
+ # Using this API, you can run Gremlin queries in string format much as
799
+ # you can using the HTTP endpoint. The interface is compatible with
800
+ # whatever Gremlin version your DB cluster is using (see the
801
+ # [Tinkerpop client section][1] to determine which Gremlin releases
802
+ # your engine version supports).
803
+ #
804
+ #
805
+ #
806
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] serializer
810
+ # If non-null, the query results are returned in a serialized response
811
+ # message in the format specified by this parameter. See the
812
+ # [GraphSON][1] section in the TinkerPop documentation for a list of
813
+ # the formats that are currently supported.
814
+ #
815
+ #
816
+ #
817
+ # [1]: https://tinkerpop.apache.org/docs/current/reference/#_graphson
818
+ # @return [String]
819
+ #
820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinQueryInput AWS API Documentation
821
+ #
822
+ class ExecuteGremlinQueryInput < Struct.new(
823
+ :gremlin_query,
824
+ :serializer)
825
+ SENSITIVE = []
826
+ include Aws::Structure
827
+ end
828
+
829
+ # @!attribute [rw] request_id
830
+ # The unique identifier of the Gremlin query.
831
+ # @return [String]
832
+ #
833
+ # @!attribute [rw] status
834
+ # The status of the Gremlin query.
835
+ # @return [Types::GremlinQueryStatusAttributes]
836
+ #
837
+ # @!attribute [rw] result
838
+ # The Gremlin query output from the server.
839
+ # @return [Hash,Array,String,Numeric,Boolean]
840
+ #
841
+ # @!attribute [rw] meta
842
+ # Metadata about the Gremlin query.
843
+ # @return [Hash,Array,String,Numeric,Boolean]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteGremlinQueryOutput AWS API Documentation
846
+ #
847
+ class ExecuteGremlinQueryOutput < Struct.new(
848
+ :request_id,
849
+ :status,
850
+ :result,
851
+ :meta)
852
+ SENSITIVE = []
853
+ include Aws::Structure
854
+ end
855
+
856
+ # @!attribute [rw] open_cypher_query
857
+ # The openCypher query string.
858
+ # @return [String]
859
+ #
860
+ # @!attribute [rw] parameters
861
+ # The openCypher query parameters.
862
+ # @return [String]
863
+ #
864
+ # @!attribute [rw] explain_mode
865
+ # The openCypher `explain` mode. Can be one of: `static`, `dynamic`,
866
+ # or `details`.
867
+ # @return [String]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteOpenCypherExplainQueryInput AWS API Documentation
870
+ #
871
+ class ExecuteOpenCypherExplainQueryInput < Struct.new(
872
+ :open_cypher_query,
873
+ :parameters,
874
+ :explain_mode)
875
+ SENSITIVE = []
876
+ include Aws::Structure
877
+ end
878
+
879
+ # @!attribute [rw] results
880
+ # A text blob containing the openCypher `explain` results.
881
+ # @return [String]
882
+ #
883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteOpenCypherExplainQueryOutput AWS API Documentation
884
+ #
885
+ class ExecuteOpenCypherExplainQueryOutput < Struct.new(
886
+ :results)
887
+ SENSITIVE = []
888
+ include Aws::Structure
889
+ end
890
+
891
+ # @!attribute [rw] open_cypher_query
892
+ # The openCypher query string to be executed.
893
+ # @return [String]
894
+ #
895
+ # @!attribute [rw] parameters
896
+ # The openCypher query parameters for query execution. See [Examples
897
+ # of openCypher parameterized queries][1] for more information.
898
+ #
899
+ #
900
+ #
901
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html
902
+ # @return [String]
903
+ #
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteOpenCypherQueryInput AWS API Documentation
905
+ #
906
+ class ExecuteOpenCypherQueryInput < Struct.new(
907
+ :open_cypher_query,
908
+ :parameters)
909
+ SENSITIVE = []
910
+ include Aws::Structure
911
+ end
912
+
913
+ # @!attribute [rw] results
914
+ # The openCypherquery results.
915
+ # @return [Hash,Array,String,Numeric,Boolean]
916
+ #
917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExecuteOpenCypherQueryOutput AWS API Documentation
918
+ #
919
+ class ExecuteOpenCypherQueryOutput < Struct.new(
920
+ :results)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ end
924
+
925
+ # Raised when a request attempts to access an stream that has expired.
926
+ #
927
+ # @!attribute [rw] detailed_message
928
+ # A detailed message describing the problem.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] request_id
932
+ # The ID of the request in question.
933
+ # @return [String]
934
+ #
935
+ # @!attribute [rw] code
936
+ # The HTTP status code returned with the exception.
937
+ # @return [String]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ExpiredStreamException AWS API Documentation
940
+ #
941
+ class ExpiredStreamException < Struct.new(
942
+ :detailed_message,
943
+ :request_id,
944
+ :code)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # Raised when a request fails.
950
+ #
951
+ # @!attribute [rw] detailed_message
952
+ # A detailed message describing the problem.
953
+ # @return [String]
954
+ #
955
+ # @!attribute [rw] request_id
956
+ # The ID of the request in question.
957
+ # @return [String]
958
+ #
959
+ # @!attribute [rw] code
960
+ # The HTTP status code returned with the exception.
961
+ # @return [String]
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/FailureByQueryException AWS API Documentation
964
+ #
965
+ class FailureByQueryException < Struct.new(
966
+ :detailed_message,
967
+ :request_id,
968
+ :code)
969
+ SENSITIVE = []
970
+ include Aws::Structure
971
+ end
972
+
973
+ # A structure containing the fast reset token used to initiate a fast
974
+ # reset.
975
+ #
976
+ # @!attribute [rw] token
977
+ # A UUID generated by the database in the `initiateDatabaseReset`
978
+ # action, and then consumed by the `performDatabaseReset` to reset the
979
+ # database.
980
+ # @return [String]
981
+ #
982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/FastResetToken AWS API Documentation
983
+ #
984
+ class FastResetToken < Struct.new(
985
+ :token)
986
+ SENSITIVE = []
987
+ include Aws::Structure
988
+ end
989
+
990
+ # @!attribute [rw] status
991
+ # Set to `healthy` if the instance is not experiencing problems. If
992
+ # the instance is recovering from a crash or from being rebooted and
993
+ # there are active transactions running from the latest server
994
+ # shutdown, status is set to `recovery`.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] start_time
998
+ # Set to the UTC time at which the current server process started.
999
+ # @return [String]
1000
+ #
1001
+ # @!attribute [rw] db_engine_version
1002
+ # Set to the Neptune engine version running on your DB cluster. If
1003
+ # this engine version has been manually patched since it was released,
1004
+ # the version number is prefixed by `Patch-`.
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] role
1008
+ # Set to `reader` if the instance is a read-replica, or to `writer` if
1009
+ # the instance is the primary instance.
1010
+ # @return [String]
1011
+ #
1012
+ # @!attribute [rw] dfe_query_engine
1013
+ # Set to `enabled` if the DFE engine is fully enabled, or to
1014
+ # `viaQueryHint` (the default) if the DFE engine is only used with
1015
+ # queries that have the `useDFE` query hint set to `true`.
1016
+ # @return [String]
1017
+ #
1018
+ # @!attribute [rw] gremlin
1019
+ # Contains information about the Gremlin query language available on
1020
+ # your cluster. Specifically, it contains a version field that
1021
+ # specifies the current TinkerPop version being used by the engine.
1022
+ # @return [Types::QueryLanguageVersion]
1023
+ #
1024
+ # @!attribute [rw] sparql
1025
+ # Contains information about the SPARQL query language available on
1026
+ # your cluster. Specifically, it contains a version field that
1027
+ # specifies the current SPARQL version being used by the engine.
1028
+ # @return [Types::QueryLanguageVersion]
1029
+ #
1030
+ # @!attribute [rw] opencypher
1031
+ # Contains information about the openCypher query language available
1032
+ # on your cluster. Specifically, it contains a version field that
1033
+ # specifies the current operCypher version being used by the engine.
1034
+ # @return [Types::QueryLanguageVersion]
1035
+ #
1036
+ # @!attribute [rw] lab_mode
1037
+ # Contains Lab Mode settings being used by the engine.
1038
+ # @return [Hash<String,String>]
1039
+ #
1040
+ # @!attribute [rw] rolling_back_trx_count
1041
+ # If there are transactions being rolled back, this field is set to
1042
+ # the number of such transactions. If there are none, the field
1043
+ # doesn't appear at all.
1044
+ # @return [Integer]
1045
+ #
1046
+ # @!attribute [rw] rolling_back_trx_earliest_start_time
1047
+ # Set to the start time of the earliest transaction being rolled back.
1048
+ # If no transactions are being rolled back, the field doesn't appear
1049
+ # at all.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] features
1053
+ # Contains status information about the features enabled on your DB
1054
+ # cluster.
1055
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
1056
+ #
1057
+ # @!attribute [rw] settings
1058
+ # Contains information about the current settings on your DB cluster.
1059
+ # For example, contains the current cluster query timeout setting
1060
+ # (`clusterQueryTimeoutInMs`).
1061
+ # @return [Hash<String,String>]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetEngineStatusOutput AWS API Documentation
1064
+ #
1065
+ class GetEngineStatusOutput < Struct.new(
1066
+ :status,
1067
+ :start_time,
1068
+ :db_engine_version,
1069
+ :role,
1070
+ :dfe_query_engine,
1071
+ :gremlin,
1072
+ :sparql,
1073
+ :opencypher,
1074
+ :lab_mode,
1075
+ :rolling_back_trx_count,
1076
+ :rolling_back_trx_earliest_start_time,
1077
+ :features,
1078
+ :settings)
1079
+ SENSITIVE = []
1080
+ include Aws::Structure
1081
+ end
1082
+
1083
+ # @!attribute [rw] query_id
1084
+ # The unique identifier that identifies the Gremlin query.
1085
+ # @return [String]
1086
+ #
1087
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetGremlinQueryStatusInput AWS API Documentation
1088
+ #
1089
+ class GetGremlinQueryStatusInput < Struct.new(
1090
+ :query_id)
1091
+ SENSITIVE = []
1092
+ include Aws::Structure
1093
+ end
1094
+
1095
+ # @!attribute [rw] query_id
1096
+ # The ID of the query for which status is being returned.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] query_string
1100
+ # The Gremlin query string.
1101
+ # @return [String]
1102
+ #
1103
+ # @!attribute [rw] query_eval_stats
1104
+ # The evaluation status of the Gremlin query.
1105
+ # @return [Types::QueryEvalStats]
1106
+ #
1107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetGremlinQueryStatusOutput AWS API Documentation
1108
+ #
1109
+ class GetGremlinQueryStatusOutput < Struct.new(
1110
+ :query_id,
1111
+ :query_string,
1112
+ :query_eval_stats)
1113
+ SENSITIVE = []
1114
+ include Aws::Structure
1115
+ end
1116
+
1117
+ # @!attribute [rw] load_id
1118
+ # The load ID of the load job to get the status of.
1119
+ # @return [String]
1120
+ #
1121
+ # @!attribute [rw] details
1122
+ # Flag indicating whether or not to include details beyond the overall
1123
+ # status (`TRUE` or `FALSE`; the default is `FALSE`).
1124
+ # @return [Boolean]
1125
+ #
1126
+ # @!attribute [rw] errors
1127
+ # Flag indicating whether or not to include a list of errors
1128
+ # encountered (`TRUE` or `FALSE`; the default is `FALSE`).
1129
+ #
1130
+ # The list of errors is paged. The `page` and `errorsPerPage`
1131
+ # parameters allow you to page through all the errors.
1132
+ # @return [Boolean]
1133
+ #
1134
+ # @!attribute [rw] page
1135
+ # The error page number (a positive integer; the default is `1`). Only
1136
+ # valid when the `errors` parameter is set to `TRUE`.
1137
+ # @return [Integer]
1138
+ #
1139
+ # @!attribute [rw] errors_per_page
1140
+ # The number of errors returned in each page (a positive integer; the
1141
+ # default is `10`). Only valid when the `errors` parameter set to
1142
+ # `TRUE`.
1143
+ # @return [Integer]
1144
+ #
1145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetLoaderJobStatusInput AWS API Documentation
1146
+ #
1147
+ class GetLoaderJobStatusInput < Struct.new(
1148
+ :load_id,
1149
+ :details,
1150
+ :errors,
1151
+ :page,
1152
+ :errors_per_page)
1153
+ SENSITIVE = []
1154
+ include Aws::Structure
1155
+ end
1156
+
1157
+ # @!attribute [rw] status
1158
+ # The HTTP response code for the request.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] payload
1162
+ # Status information about the load job, in a layout that could look
1163
+ # like this:
1164
+ # @return [Hash,Array,String,Numeric,Boolean]
1165
+ #
1166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetLoaderJobStatusOutput AWS API Documentation
1167
+ #
1168
+ class GetLoaderJobStatusOutput < Struct.new(
1169
+ :status,
1170
+ :payload)
1171
+ SENSITIVE = []
1172
+ include Aws::Structure
1173
+ end
1174
+
1175
+ # @!attribute [rw] id
1176
+ # The unique identifier of the data-processing job to be retrieved.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] neptune_iam_role_arn
1180
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1181
+ # Amazon S3 resources. This must be listed in your DB cluster
1182
+ # parameter group or an error will occur.
1183
+ # @return [String]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLDataProcessingJobInput AWS API Documentation
1186
+ #
1187
+ class GetMLDataProcessingJobInput < Struct.new(
1188
+ :id,
1189
+ :neptune_iam_role_arn)
1190
+ SENSITIVE = []
1191
+ include Aws::Structure
1192
+ end
1193
+
1194
+ # @!attribute [rw] status
1195
+ # Status of the data processing job.
1196
+ # @return [String]
1197
+ #
1198
+ # @!attribute [rw] id
1199
+ # The unique identifier of this data-processing job.
1200
+ # @return [String]
1201
+ #
1202
+ # @!attribute [rw] processing_job
1203
+ # Definition of the data processing job.
1204
+ # @return [Types::MlResourceDefinition]
1205
+ #
1206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLDataProcessingJobOutput AWS API Documentation
1207
+ #
1208
+ class GetMLDataProcessingJobOutput < Struct.new(
1209
+ :status,
1210
+ :id,
1211
+ :processing_job)
1212
+ SENSITIVE = []
1213
+ include Aws::Structure
1214
+ end
1215
+
1216
+ # @!attribute [rw] id
1217
+ # The unique identifier of the inference endpoint.
1218
+ # @return [String]
1219
+ #
1220
+ # @!attribute [rw] neptune_iam_role_arn
1221
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1222
+ # Amazon S3 resources. This must be listed in your DB cluster
1223
+ # parameter group or an error will occur.
1224
+ # @return [String]
1225
+ #
1226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLEndpointInput AWS API Documentation
1227
+ #
1228
+ class GetMLEndpointInput < Struct.new(
1229
+ :id,
1230
+ :neptune_iam_role_arn)
1231
+ SENSITIVE = []
1232
+ include Aws::Structure
1233
+ end
1234
+
1235
+ # @!attribute [rw] status
1236
+ # The status of the inference endpoint.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] id
1240
+ # The unique identifier of the inference endpoint.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] endpoint
1244
+ # The endpoint definition.
1245
+ # @return [Types::MlResourceDefinition]
1246
+ #
1247
+ # @!attribute [rw] endpoint_config
1248
+ # The endpoint configuration
1249
+ # @return [Types::MlConfigDefinition]
1250
+ #
1251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLEndpointOutput AWS API Documentation
1252
+ #
1253
+ class GetMLEndpointOutput < Struct.new(
1254
+ :status,
1255
+ :id,
1256
+ :endpoint,
1257
+ :endpoint_config)
1258
+ SENSITIVE = []
1259
+ include Aws::Structure
1260
+ end
1261
+
1262
+ # @!attribute [rw] id
1263
+ # The unique identifier of the model-training job to retrieve.
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] neptune_iam_role_arn
1267
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1268
+ # Amazon S3 resources. This must be listed in your DB cluster
1269
+ # parameter group or an error will occur.
1270
+ # @return [String]
1271
+ #
1272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLModelTrainingJobInput AWS API Documentation
1273
+ #
1274
+ class GetMLModelTrainingJobInput < Struct.new(
1275
+ :id,
1276
+ :neptune_iam_role_arn)
1277
+ SENSITIVE = []
1278
+ include Aws::Structure
1279
+ end
1280
+
1281
+ # @!attribute [rw] status
1282
+ # The status of the model training job.
1283
+ # @return [String]
1284
+ #
1285
+ # @!attribute [rw] id
1286
+ # The unique identifier of this model-training job.
1287
+ # @return [String]
1288
+ #
1289
+ # @!attribute [rw] processing_job
1290
+ # The data processing job.
1291
+ # @return [Types::MlResourceDefinition]
1292
+ #
1293
+ # @!attribute [rw] hpo_job
1294
+ # The HPO job.
1295
+ # @return [Types::MlResourceDefinition]
1296
+ #
1297
+ # @!attribute [rw] model_transform_job
1298
+ # The model transform job.
1299
+ # @return [Types::MlResourceDefinition]
1300
+ #
1301
+ # @!attribute [rw] ml_models
1302
+ # A list of the configurations of the ML models being used.
1303
+ # @return [Array<Types::MlConfigDefinition>]
1304
+ #
1305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLModelTrainingJobOutput AWS API Documentation
1306
+ #
1307
+ class GetMLModelTrainingJobOutput < Struct.new(
1308
+ :status,
1309
+ :id,
1310
+ :processing_job,
1311
+ :hpo_job,
1312
+ :model_transform_job,
1313
+ :ml_models)
1314
+ SENSITIVE = []
1315
+ include Aws::Structure
1316
+ end
1317
+
1318
+ # @!attribute [rw] id
1319
+ # The unique identifier of the model-transform job to be reetrieved.
1320
+ # @return [String]
1321
+ #
1322
+ # @!attribute [rw] neptune_iam_role_arn
1323
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1324
+ # Amazon S3 resources. This must be listed in your DB cluster
1325
+ # parameter group or an error will occur.
1326
+ # @return [String]
1327
+ #
1328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLModelTransformJobInput AWS API Documentation
1329
+ #
1330
+ class GetMLModelTransformJobInput < Struct.new(
1331
+ :id,
1332
+ :neptune_iam_role_arn)
1333
+ SENSITIVE = []
1334
+ include Aws::Structure
1335
+ end
1336
+
1337
+ # @!attribute [rw] status
1338
+ # The status of the model-transform job.
1339
+ # @return [String]
1340
+ #
1341
+ # @!attribute [rw] id
1342
+ # The unique identifier of the model-transform job to be retrieved.
1343
+ # @return [String]
1344
+ #
1345
+ # @!attribute [rw] base_processing_job
1346
+ # The base data processing job.
1347
+ # @return [Types::MlResourceDefinition]
1348
+ #
1349
+ # @!attribute [rw] remote_model_transform_job
1350
+ # The remote model transform job.
1351
+ # @return [Types::MlResourceDefinition]
1352
+ #
1353
+ # @!attribute [rw] models
1354
+ # A list of the configuration information for the models being used.
1355
+ # @return [Array<Types::MlConfigDefinition>]
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetMLModelTransformJobOutput AWS API Documentation
1358
+ #
1359
+ class GetMLModelTransformJobOutput < Struct.new(
1360
+ :status,
1361
+ :id,
1362
+ :base_processing_job,
1363
+ :remote_model_transform_job,
1364
+ :models)
1365
+ SENSITIVE = []
1366
+ include Aws::Structure
1367
+ end
1368
+
1369
+ # @!attribute [rw] query_id
1370
+ # The unique ID of the openCypher query for which to retrieve the
1371
+ # query status.
1372
+ # @return [String]
1373
+ #
1374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetOpenCypherQueryStatusInput AWS API Documentation
1375
+ #
1376
+ class GetOpenCypherQueryStatusInput < Struct.new(
1377
+ :query_id)
1378
+ SENSITIVE = []
1379
+ include Aws::Structure
1380
+ end
1381
+
1382
+ # @!attribute [rw] query_id
1383
+ # The unique ID of the query for which status is being returned.
1384
+ # @return [String]
1385
+ #
1386
+ # @!attribute [rw] query_string
1387
+ # The openCypher query string.
1388
+ # @return [String]
1389
+ #
1390
+ # @!attribute [rw] query_eval_stats
1391
+ # The openCypher query evaluation status.
1392
+ # @return [Types::QueryEvalStats]
1393
+ #
1394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetOpenCypherQueryStatusOutput AWS API Documentation
1395
+ #
1396
+ class GetOpenCypherQueryStatusOutput < Struct.new(
1397
+ :query_id,
1398
+ :query_string,
1399
+ :query_eval_stats)
1400
+ SENSITIVE = []
1401
+ include Aws::Structure
1402
+ end
1403
+
1404
+ # @!attribute [rw] status
1405
+ # The HTTP return code of the request. If the request succeeded, the
1406
+ # code is 200. See [Common error codes for DFE statistics
1407
+ # request](docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors)
1408
+ # for a list of common errors.
1409
+ # @return [String]
1410
+ #
1411
+ # @!attribute [rw] payload
1412
+ # Statistics for property-graph data.
1413
+ # @return [Types::Statistics]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphStatisticsOutput AWS API Documentation
1416
+ #
1417
+ class GetPropertygraphStatisticsOutput < Struct.new(
1418
+ :status,
1419
+ :payload)
1420
+ SENSITIVE = []
1421
+ include Aws::Structure
1422
+ end
1423
+
1424
+ # @!attribute [rw] limit
1425
+ # Specifies the maximum number of records to return. There is also a
1426
+ # size limit of 10 MB on the response that can't be modified and that
1427
+ # takes precedence over the number of records specified in the `limit`
1428
+ # parameter. The response does include a threshold-breaching record if
1429
+ # the 10 MB limit was reached.
1430
+ #
1431
+ # The range for `limit` is 1 to 100,000, with a default of 10.
1432
+ # @return [Integer]
1433
+ #
1434
+ # @!attribute [rw] iterator_type
1435
+ # Can be one of:
1436
+ #
1437
+ # * `AT_SEQUENCE_NUMBER`   –   Indicates that reading should start
1438
+ # from the event sequence number specified jointly by the
1439
+ # `commitNum` and `opNum` parameters.
1440
+ #
1441
+ # * `AFTER_SEQUENCE_NUMBER`   –   Indicates that reading should start
1442
+ # right after the event sequence number specified jointly by the
1443
+ # `commitNum` and `opNum` parameters.
1444
+ #
1445
+ # * `TRIM_HORIZON`   –   Indicates that reading should start at the
1446
+ # last untrimmed record in the system, which is the oldest unexpired
1447
+ # (not yet deleted) record in the change-log stream.
1448
+ #
1449
+ # * `LATEST`   –   Indicates that reading should start at the most
1450
+ # recent record in the system, which is the latest unexpired (not
1451
+ # yet deleted) record in the change-log stream.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] commit_num
1455
+ # The commit number of the starting record to read from the change-log
1456
+ # stream. This parameter is required when `iteratorType`
1457
+ # is`AT_SEQUENCE_NUMBER` or `AFTER_SEQUENCE_NUMBER`, and ignored when
1458
+ # `iteratorType` is `TRIM_HORIZON` or `LATEST`.
1459
+ # @return [Integer]
1460
+ #
1461
+ # @!attribute [rw] op_num
1462
+ # The operation sequence number within the specified commit to start
1463
+ # reading from in the change-log stream data. The default is `1`.
1464
+ # @return [Integer]
1465
+ #
1466
+ # @!attribute [rw] encoding
1467
+ # If set to TRUE, Neptune compresses the response using gzip encoding.
1468
+ # @return [String]
1469
+ #
1470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphStreamInput AWS API Documentation
1471
+ #
1472
+ class GetPropertygraphStreamInput < Struct.new(
1473
+ :limit,
1474
+ :iterator_type,
1475
+ :commit_num,
1476
+ :op_num,
1477
+ :encoding)
1478
+ SENSITIVE = []
1479
+ include Aws::Structure
1480
+ end
1481
+
1482
+ # @!attribute [rw] last_event_id
1483
+ # Sequence identifier of the last change in the stream response.
1484
+ #
1485
+ # An event ID is composed of two fields: a `commitNum`, which
1486
+ # identifies a transaction that changed the graph, and an `opNum`,
1487
+ # which identifies a specific operation within that transaction:
1488
+ # @return [Hash<String,String>]
1489
+ #
1490
+ # @!attribute [rw] last_trx_timestamp_in_millis
1491
+ # The time at which the commit for the transaction was requested, in
1492
+ # milliseconds from the Unix epoch.
1493
+ # @return [Integer]
1494
+ #
1495
+ # @!attribute [rw] format
1496
+ # Serialization format for the change records being returned.
1497
+ # Currently, the only supported value is `PG_JSON`.
1498
+ # @return [String]
1499
+ #
1500
+ # @!attribute [rw] records
1501
+ # An array of serialized change-log stream records included in the
1502
+ # response.
1503
+ # @return [Array<Types::PropertygraphRecord>]
1504
+ #
1505
+ # @!attribute [rw] total_records
1506
+ # The total number of records in the response.
1507
+ # @return [Integer]
1508
+ #
1509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphStreamOutput AWS API Documentation
1510
+ #
1511
+ class GetPropertygraphStreamOutput < Struct.new(
1512
+ :last_event_id,
1513
+ :last_trx_timestamp_in_millis,
1514
+ :format,
1515
+ :records,
1516
+ :total_records)
1517
+ SENSITIVE = []
1518
+ include Aws::Structure
1519
+ end
1520
+
1521
+ # @!attribute [rw] mode
1522
+ # Mode can take one of two values: `BASIC` (the default), and
1523
+ # `DETAILED`.
1524
+ # @return [String]
1525
+ #
1526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphSummaryInput AWS API Documentation
1527
+ #
1528
+ class GetPropertygraphSummaryInput < Struct.new(
1529
+ :mode)
1530
+ SENSITIVE = []
1531
+ include Aws::Structure
1532
+ end
1533
+
1534
+ # @!attribute [rw] status_code
1535
+ # The HTTP return code of the request. If the request succeeded, the
1536
+ # code is 200.
1537
+ # @return [Integer]
1538
+ #
1539
+ # @!attribute [rw] payload
1540
+ # Payload containing the property graph summary response.
1541
+ # @return [Types::PropertygraphSummaryValueMap]
1542
+ #
1543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphSummaryOutput AWS API Documentation
1544
+ #
1545
+ class GetPropertygraphSummaryOutput < Struct.new(
1546
+ :status_code,
1547
+ :payload)
1548
+ SENSITIVE = []
1549
+ include Aws::Structure
1550
+ end
1551
+
1552
+ # @!attribute [rw] mode
1553
+ # Mode can take one of two values: `BASIC` (the default), and
1554
+ # `DETAILED`.
1555
+ # @return [String]
1556
+ #
1557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetRDFGraphSummaryInput AWS API Documentation
1558
+ #
1559
+ class GetRDFGraphSummaryInput < Struct.new(
1560
+ :mode)
1561
+ SENSITIVE = []
1562
+ include Aws::Structure
1563
+ end
1564
+
1565
+ # @!attribute [rw] status_code
1566
+ # The HTTP return code of the request. If the request succeeded, the
1567
+ # code is 200.
1568
+ # @return [Integer]
1569
+ #
1570
+ # @!attribute [rw] payload
1571
+ # Payload for an RDF graph summary response
1572
+ # @return [Types::RDFGraphSummaryValueMap]
1573
+ #
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetRDFGraphSummaryOutput AWS API Documentation
1575
+ #
1576
+ class GetRDFGraphSummaryOutput < Struct.new(
1577
+ :status_code,
1578
+ :payload)
1579
+ SENSITIVE = []
1580
+ include Aws::Structure
1581
+ end
1582
+
1583
+ # @!attribute [rw] status
1584
+ # The HTTP return code of the request. If the request succeeded, the
1585
+ # code is 200. See [Common error codes for DFE statistics
1586
+ # request](docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors)
1587
+ # for a list of common errors.
1588
+ # @return [String]
1589
+ #
1590
+ # @!attribute [rw] payload
1591
+ # Statistics for RDF data.
1592
+ # @return [Types::Statistics]
1593
+ #
1594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetSparqlStatisticsOutput AWS API Documentation
1595
+ #
1596
+ class GetSparqlStatisticsOutput < Struct.new(
1597
+ :status,
1598
+ :payload)
1599
+ SENSITIVE = []
1600
+ include Aws::Structure
1601
+ end
1602
+
1603
+ # @!attribute [rw] limit
1604
+ # Specifies the maximum number of records to return. There is also a
1605
+ # size limit of 10 MB on the response that can't be modified and that
1606
+ # takes precedence over the number of records specified in the `limit`
1607
+ # parameter. The response does include a threshold-breaching record if
1608
+ # the 10 MB limit was reached.
1609
+ #
1610
+ # The range for `limit` is 1 to 100,000, with a default of 10.
1611
+ # @return [Integer]
1612
+ #
1613
+ # @!attribute [rw] iterator_type
1614
+ # Can be one of:
1615
+ #
1616
+ # * `AT_SEQUENCE_NUMBER`   –   Indicates that reading should start
1617
+ # from the event sequence number specified jointly by the
1618
+ # `commitNum` and `opNum` parameters.
1619
+ #
1620
+ # * `AFTER_SEQUENCE_NUMBER`   –   Indicates that reading should start
1621
+ # right after the event sequence number specified jointly by the
1622
+ # `commitNum` and `opNum` parameters.
1623
+ #
1624
+ # * `TRIM_HORIZON`   –   Indicates that reading should start at the
1625
+ # last untrimmed record in the system, which is the oldest unexpired
1626
+ # (not yet deleted) record in the change-log stream.
1627
+ #
1628
+ # * `LATEST`   –   Indicates that reading should start at the most
1629
+ # recent record in the system, which is the latest unexpired (not
1630
+ # yet deleted) record in the change-log stream.
1631
+ # @return [String]
1632
+ #
1633
+ # @!attribute [rw] commit_num
1634
+ # The commit number of the starting record to read from the change-log
1635
+ # stream. This parameter is required when `iteratorType`
1636
+ # is`AT_SEQUENCE_NUMBER` or `AFTER_SEQUENCE_NUMBER`, and ignored when
1637
+ # `iteratorType` is `TRIM_HORIZON` or `LATEST`.
1638
+ # @return [Integer]
1639
+ #
1640
+ # @!attribute [rw] op_num
1641
+ # The operation sequence number within the specified commit to start
1642
+ # reading from in the change-log stream data. The default is `1`.
1643
+ # @return [Integer]
1644
+ #
1645
+ # @!attribute [rw] encoding
1646
+ # If set to TRUE, Neptune compresses the response using gzip encoding.
1647
+ # @return [String]
1648
+ #
1649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetSparqlStreamInput AWS API Documentation
1650
+ #
1651
+ class GetSparqlStreamInput < Struct.new(
1652
+ :limit,
1653
+ :iterator_type,
1654
+ :commit_num,
1655
+ :op_num,
1656
+ :encoding)
1657
+ SENSITIVE = []
1658
+ include Aws::Structure
1659
+ end
1660
+
1661
+ # @!attribute [rw] last_event_id
1662
+ # Sequence identifier of the last change in the stream response.
1663
+ #
1664
+ # An event ID is composed of two fields: a `commitNum`, which
1665
+ # identifies a transaction that changed the graph, and an `opNum`,
1666
+ # which identifies a specific operation within that transaction:
1667
+ # @return [Hash<String,String>]
1668
+ #
1669
+ # @!attribute [rw] last_trx_timestamp_in_millis
1670
+ # The time at which the commit for the transaction was requested, in
1671
+ # milliseconds from the Unix epoch.
1672
+ # @return [Integer]
1673
+ #
1674
+ # @!attribute [rw] format
1675
+ # Serialization format for the change records being returned.
1676
+ # Currently, the only supported value is `NQUADS`.
1677
+ # @return [String]
1678
+ #
1679
+ # @!attribute [rw] records
1680
+ # An array of serialized change-log stream records included in the
1681
+ # response.
1682
+ # @return [Array<Types::SparqlRecord>]
1683
+ #
1684
+ # @!attribute [rw] total_records
1685
+ # The total number of records in the response.
1686
+ # @return [Integer]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetSparqlStreamOutput AWS API Documentation
1689
+ #
1690
+ class GetSparqlStreamOutput < Struct.new(
1691
+ :last_event_id,
1692
+ :last_trx_timestamp_in_millis,
1693
+ :format,
1694
+ :records,
1695
+ :total_records)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # Captures the status of a Gremlin query (see the [Gremlin query status
1701
+ # API][1] page).
1702
+ #
1703
+ #
1704
+ #
1705
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html
1706
+ #
1707
+ # @!attribute [rw] query_id
1708
+ # The ID of the Gremlin query.
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] query_string
1712
+ # The query string of the Gremlin query.
1713
+ # @return [String]
1714
+ #
1715
+ # @!attribute [rw] query_eval_stats
1716
+ # The query statistics of the Gremlin query.
1717
+ # @return [Types::QueryEvalStats]
1718
+ #
1719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GremlinQueryStatus AWS API Documentation
1720
+ #
1721
+ class GremlinQueryStatus < Struct.new(
1722
+ :query_id,
1723
+ :query_string,
1724
+ :query_eval_stats)
1725
+ SENSITIVE = []
1726
+ include Aws::Structure
1727
+ end
1728
+
1729
+ # Contains status components of a Gremlin query.
1730
+ #
1731
+ # @!attribute [rw] message
1732
+ # The status message.
1733
+ # @return [String]
1734
+ #
1735
+ # @!attribute [rw] code
1736
+ # The HTTP response code returned fro the Gremlin query request..
1737
+ # @return [Integer]
1738
+ #
1739
+ # @!attribute [rw] attributes
1740
+ # Attributes of the Gremlin query status.
1741
+ # @return [Hash,Array,String,Numeric,Boolean]
1742
+ #
1743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GremlinQueryStatusAttributes AWS API Documentation
1744
+ #
1745
+ class GremlinQueryStatusAttributes < Struct.new(
1746
+ :message,
1747
+ :code,
1748
+ :attributes)
1749
+ SENSITIVE = []
1750
+ include Aws::Structure
1751
+ end
1752
+
1753
+ # Raised when an argument in a request is not supported.
1754
+ #
1755
+ # @!attribute [rw] detailed_message
1756
+ # A detailed message describing the problem.
1757
+ # @return [String]
1758
+ #
1759
+ # @!attribute [rw] request_id
1760
+ # The ID of the request in question.
1761
+ # @return [String]
1762
+ #
1763
+ # @!attribute [rw] code
1764
+ # The HTTP status code returned with the exception.
1765
+ # @return [String]
1766
+ #
1767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/IllegalArgumentException AWS API Documentation
1768
+ #
1769
+ class IllegalArgumentException < Struct.new(
1770
+ :detailed_message,
1771
+ :request_id,
1772
+ :code)
1773
+ SENSITIVE = []
1774
+ include Aws::Structure
1775
+ end
1776
+
1777
+ # Raised when the processing of the request failed unexpectedly.
1778
+ #
1779
+ # @!attribute [rw] detailed_message
1780
+ # A detailed message describing the problem.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] request_id
1784
+ # The ID of the request in question.
1785
+ # @return [String]
1786
+ #
1787
+ # @!attribute [rw] code
1788
+ # The HTTP status code returned with the exception.
1789
+ # @return [String]
1790
+ #
1791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/InternalFailureException AWS API Documentation
1792
+ #
1793
+ class InternalFailureException < Struct.new(
1794
+ :detailed_message,
1795
+ :request_id,
1796
+ :code)
1797
+ SENSITIVE = []
1798
+ include Aws::Structure
1799
+ end
1800
+
1801
+ # Raised when an argument in a request has an invalid value.
1802
+ #
1803
+ # @!attribute [rw] detailed_message
1804
+ # A detailed message describing the problem.
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] request_id
1808
+ # The ID of the request in question.
1809
+ # @return [String]
1810
+ #
1811
+ # @!attribute [rw] code
1812
+ # The HTTP status code returned with the exception.
1813
+ # @return [String]
1814
+ #
1815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/InvalidArgumentException AWS API Documentation
1816
+ #
1817
+ class InvalidArgumentException < Struct.new(
1818
+ :detailed_message,
1819
+ :request_id,
1820
+ :code)
1821
+ SENSITIVE = []
1822
+ include Aws::Structure
1823
+ end
1824
+
1825
+ # Raised when invalid numerical data is encountered when servicing a
1826
+ # request.
1827
+ #
1828
+ # @!attribute [rw] detailed_message
1829
+ # A detailed message describing the problem.
1830
+ # @return [String]
1831
+ #
1832
+ # @!attribute [rw] request_id
1833
+ # The ID of the request in question.
1834
+ # @return [String]
1835
+ #
1836
+ # @!attribute [rw] code
1837
+ # The HTTP status code returned with the exception.
1838
+ # @return [String]
1839
+ #
1840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/InvalidNumericDataException AWS API Documentation
1841
+ #
1842
+ class InvalidNumericDataException < Struct.new(
1843
+ :detailed_message,
1844
+ :request_id,
1845
+ :code)
1846
+ SENSITIVE = []
1847
+ include Aws::Structure
1848
+ end
1849
+
1850
+ # Raised when a parameter value is not valid.
1851
+ #
1852
+ # @!attribute [rw] detailed_message
1853
+ # A detailed message describing the problem.
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] request_id
1857
+ # The ID of the request that includes an invalid parameter.
1858
+ # @return [String]
1859
+ #
1860
+ # @!attribute [rw] code
1861
+ # The HTTP status code returned with the exception.
1862
+ # @return [String]
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/InvalidParameterException AWS API Documentation
1865
+ #
1866
+ class InvalidParameterException < Struct.new(
1867
+ :detailed_message,
1868
+ :request_id,
1869
+ :code)
1870
+ SENSITIVE = []
1871
+ include Aws::Structure
1872
+ end
1873
+
1874
+ # @!attribute [rw] include_waiting
1875
+ # If set to `TRUE`, the list returned includes waiting queries. The
1876
+ # default is `FALSE`;
1877
+ # @return [Boolean]
1878
+ #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListGremlinQueriesInput AWS API Documentation
1880
+ #
1881
+ class ListGremlinQueriesInput < Struct.new(
1882
+ :include_waiting)
1883
+ SENSITIVE = []
1884
+ include Aws::Structure
1885
+ end
1886
+
1887
+ # @!attribute [rw] accepted_query_count
1888
+ # The number of queries that have been accepted but not yet completed,
1889
+ # including queries in the queue.
1890
+ # @return [Integer]
1891
+ #
1892
+ # @!attribute [rw] running_query_count
1893
+ # The number of Gremlin queries currently running.
1894
+ # @return [Integer]
1895
+ #
1896
+ # @!attribute [rw] queries
1897
+ # A list of the current queries.
1898
+ # @return [Array<Types::GremlinQueryStatus>]
1899
+ #
1900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListGremlinQueriesOutput AWS API Documentation
1901
+ #
1902
+ class ListGremlinQueriesOutput < Struct.new(
1903
+ :accepted_query_count,
1904
+ :running_query_count,
1905
+ :queries)
1906
+ SENSITIVE = []
1907
+ include Aws::Structure
1908
+ end
1909
+
1910
+ # @!attribute [rw] limit
1911
+ # The number of load IDs to list. Must be a positive integer greater
1912
+ # than zero and not more than `100` (which is the default).
1913
+ # @return [Integer]
1914
+ #
1915
+ # @!attribute [rw] include_queued_loads
1916
+ # An optional parameter that can be used to exclude the load IDs of
1917
+ # queued load requests when requesting a list of load IDs by setting
1918
+ # the parameter to `FALSE`. The default value is `TRUE`.
1919
+ # @return [Boolean]
1920
+ #
1921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListLoaderJobsInput AWS API Documentation
1922
+ #
1923
+ class ListLoaderJobsInput < Struct.new(
1924
+ :limit,
1925
+ :include_queued_loads)
1926
+ SENSITIVE = []
1927
+ include Aws::Structure
1928
+ end
1929
+
1930
+ # @!attribute [rw] status
1931
+ # Returns the status of the job list request.
1932
+ # @return [String]
1933
+ #
1934
+ # @!attribute [rw] payload
1935
+ # The requested list of job IDs.
1936
+ # @return [Types::LoaderIdResult]
1937
+ #
1938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListLoaderJobsOutput AWS API Documentation
1939
+ #
1940
+ class ListLoaderJobsOutput < Struct.new(
1941
+ :status,
1942
+ :payload)
1943
+ SENSITIVE = []
1944
+ include Aws::Structure
1945
+ end
1946
+
1947
+ # @!attribute [rw] max_items
1948
+ # The maximum number of items to return (from 1 to 1024; the default
1949
+ # is 10).
1950
+ # @return [Integer]
1951
+ #
1952
+ # @!attribute [rw] neptune_iam_role_arn
1953
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1954
+ # Amazon S3 resources. This must be listed in your DB cluster
1955
+ # parameter group or an error will occur.
1956
+ # @return [String]
1957
+ #
1958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLDataProcessingJobsInput AWS API Documentation
1959
+ #
1960
+ class ListMLDataProcessingJobsInput < Struct.new(
1961
+ :max_items,
1962
+ :neptune_iam_role_arn)
1963
+ SENSITIVE = []
1964
+ include Aws::Structure
1965
+ end
1966
+
1967
+ # @!attribute [rw] ids
1968
+ # A page listing data processing job IDs.
1969
+ # @return [Array<String>]
1970
+ #
1971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLDataProcessingJobsOutput AWS API Documentation
1972
+ #
1973
+ class ListMLDataProcessingJobsOutput < Struct.new(
1974
+ :ids)
1975
+ SENSITIVE = []
1976
+ include Aws::Structure
1977
+ end
1978
+
1979
+ # @!attribute [rw] max_items
1980
+ # The maximum number of items to return (from 1 to 1024; the default
1981
+ # is 10.
1982
+ # @return [Integer]
1983
+ #
1984
+ # @!attribute [rw] neptune_iam_role_arn
1985
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
1986
+ # Amazon S3 resources. This must be listed in your DB cluster
1987
+ # parameter group or an error will occur.
1988
+ # @return [String]
1989
+ #
1990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLEndpointsInput AWS API Documentation
1991
+ #
1992
+ class ListMLEndpointsInput < Struct.new(
1993
+ :max_items,
1994
+ :neptune_iam_role_arn)
1995
+ SENSITIVE = []
1996
+ include Aws::Structure
1997
+ end
1998
+
1999
+ # @!attribute [rw] ids
2000
+ # A page from the list of inference endpoint IDs.
2001
+ # @return [Array<String>]
2002
+ #
2003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLEndpointsOutput AWS API Documentation
2004
+ #
2005
+ class ListMLEndpointsOutput < Struct.new(
2006
+ :ids)
2007
+ SENSITIVE = []
2008
+ include Aws::Structure
2009
+ end
2010
+
2011
+ # @!attribute [rw] max_items
2012
+ # The maximum number of items to return (from 1 to 1024; the default
2013
+ # is 10).
2014
+ # @return [Integer]
2015
+ #
2016
+ # @!attribute [rw] neptune_iam_role_arn
2017
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
2018
+ # Amazon S3 resources. This must be listed in your DB cluster
2019
+ # parameter group or an error will occur.
2020
+ # @return [String]
2021
+ #
2022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLModelTrainingJobsInput AWS API Documentation
2023
+ #
2024
+ class ListMLModelTrainingJobsInput < Struct.new(
2025
+ :max_items,
2026
+ :neptune_iam_role_arn)
2027
+ SENSITIVE = []
2028
+ include Aws::Structure
2029
+ end
2030
+
2031
+ # @!attribute [rw] ids
2032
+ # A page of the list of model training job IDs.
2033
+ # @return [Array<String>]
2034
+ #
2035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLModelTrainingJobsOutput AWS API Documentation
2036
+ #
2037
+ class ListMLModelTrainingJobsOutput < Struct.new(
2038
+ :ids)
2039
+ SENSITIVE = []
2040
+ include Aws::Structure
2041
+ end
2042
+
2043
+ # @!attribute [rw] max_items
2044
+ # The maximum number of items to return (from 1 to 1024; the default
2045
+ # is 10).
2046
+ # @return [Integer]
2047
+ #
2048
+ # @!attribute [rw] neptune_iam_role_arn
2049
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
2050
+ # Amazon S3 resources. This must be listed in your DB cluster
2051
+ # parameter group or an error will occur.
2052
+ # @return [String]
2053
+ #
2054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLModelTransformJobsInput AWS API Documentation
2055
+ #
2056
+ class ListMLModelTransformJobsInput < Struct.new(
2057
+ :max_items,
2058
+ :neptune_iam_role_arn)
2059
+ SENSITIVE = []
2060
+ include Aws::Structure
2061
+ end
2062
+
2063
+ # @!attribute [rw] ids
2064
+ # A page from the list of model transform IDs.
2065
+ # @return [Array<String>]
2066
+ #
2067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListMLModelTransformJobsOutput AWS API Documentation
2068
+ #
2069
+ class ListMLModelTransformJobsOutput < Struct.new(
2070
+ :ids)
2071
+ SENSITIVE = []
2072
+ include Aws::Structure
2073
+ end
2074
+
2075
+ # @!attribute [rw] include_waiting
2076
+ # When set to `TRUE` and other parameters are not present, causes
2077
+ # status information to be returned for waiting queries as well as for
2078
+ # running queries.
2079
+ # @return [Boolean]
2080
+ #
2081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListOpenCypherQueriesInput AWS API Documentation
2082
+ #
2083
+ class ListOpenCypherQueriesInput < Struct.new(
2084
+ :include_waiting)
2085
+ SENSITIVE = []
2086
+ include Aws::Structure
2087
+ end
2088
+
2089
+ # @!attribute [rw] accepted_query_count
2090
+ # The number of queries that have been accepted but not yet completed,
2091
+ # including queries in the queue.
2092
+ # @return [Integer]
2093
+ #
2094
+ # @!attribute [rw] running_query_count
2095
+ # The number of currently running openCypher queries.
2096
+ # @return [Integer]
2097
+ #
2098
+ # @!attribute [rw] queries
2099
+ # A list of current openCypher queries.
2100
+ # @return [Array<Types::GremlinQueryStatus>]
2101
+ #
2102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ListOpenCypherQueriesOutput AWS API Documentation
2103
+ #
2104
+ class ListOpenCypherQueriesOutput < Struct.new(
2105
+ :accepted_query_count,
2106
+ :running_query_count,
2107
+ :queries)
2108
+ SENSITIVE = []
2109
+ include Aws::Structure
2110
+ end
2111
+
2112
+ # Raised when access is denied to a specified load URL.
2113
+ #
2114
+ # @!attribute [rw] detailed_message
2115
+ # A detailed message describing the problem.
2116
+ # @return [String]
2117
+ #
2118
+ # @!attribute [rw] request_id
2119
+ # The ID of the request in question.
2120
+ # @return [String]
2121
+ #
2122
+ # @!attribute [rw] code
2123
+ # The HTTP status code returned with the exception.
2124
+ # @return [String]
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/LoadUrlAccessDeniedException AWS API Documentation
2127
+ #
2128
+ class LoadUrlAccessDeniedException < Struct.new(
2129
+ :detailed_message,
2130
+ :request_id,
2131
+ :code)
2132
+ SENSITIVE = []
2133
+ include Aws::Structure
2134
+ end
2135
+
2136
+ # Contains a list of load IDs.
2137
+ #
2138
+ # @!attribute [rw] load_ids
2139
+ # A list of load IDs.
2140
+ # @return [Array<String>]
2141
+ #
2142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/LoaderIdResult AWS API Documentation
2143
+ #
2144
+ class LoaderIdResult < Struct.new(
2145
+ :load_ids)
2146
+ SENSITIVE = []
2147
+ include Aws::Structure
2148
+ end
2149
+
2150
+ # Raised when a specified machine-learning resource could not be found.
2151
+ #
2152
+ # @!attribute [rw] detailed_message
2153
+ # A detailed message describing the problem.
2154
+ # @return [String]
2155
+ #
2156
+ # @!attribute [rw] request_id
2157
+ # The ID of the request in question.
2158
+ # @return [String]
2159
+ #
2160
+ # @!attribute [rw] code
2161
+ # The HTTP status code returned with the exception.
2162
+ # @return [String]
2163
+ #
2164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MLResourceNotFoundException AWS API Documentation
2165
+ #
2166
+ class MLResourceNotFoundException < Struct.new(
2167
+ :detailed_message,
2168
+ :request_id,
2169
+ :code)
2170
+ SENSITIVE = []
2171
+ include Aws::Structure
2172
+ end
2173
+
2174
+ # Raised when a query is submitted that is syntactically incorrect or
2175
+ # does not pass additional validation.
2176
+ #
2177
+ # @!attribute [rw] detailed_message
2178
+ # A detailed message describing the problem.
2179
+ # @return [String]
2180
+ #
2181
+ # @!attribute [rw] request_id
2182
+ # The ID of the malformed query request.
2183
+ # @return [String]
2184
+ #
2185
+ # @!attribute [rw] code
2186
+ # The HTTP status code returned with the exception.
2187
+ # @return [String]
2188
+ #
2189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MalformedQueryException AWS API Documentation
2190
+ #
2191
+ class MalformedQueryException < Struct.new(
2192
+ :detailed_message,
2193
+ :request_id,
2194
+ :code)
2195
+ SENSITIVE = []
2196
+ include Aws::Structure
2197
+ end
2198
+
2199
+ # @!attribute [rw] mode
2200
+ # The statistics generation mode. One of: `DISABLE_AUTOCOMPUTE`,
2201
+ # `ENABLE_AUTOCOMPUTE`, or `REFRESH`, the last of which manually
2202
+ # triggers DFE statistics generation.
2203
+ # @return [String]
2204
+ #
2205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ManagePropertygraphStatisticsInput AWS API Documentation
2206
+ #
2207
+ class ManagePropertygraphStatisticsInput < Struct.new(
2208
+ :mode)
2209
+ SENSITIVE = []
2210
+ include Aws::Structure
2211
+ end
2212
+
2213
+ # @!attribute [rw] status
2214
+ # The HTTP return code of the request. If the request succeeded, the
2215
+ # code is 200.
2216
+ # @return [String]
2217
+ #
2218
+ # @!attribute [rw] payload
2219
+ # This is only returned for refresh mode.
2220
+ # @return [Types::RefreshStatisticsIdMap]
2221
+ #
2222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ManagePropertygraphStatisticsOutput AWS API Documentation
2223
+ #
2224
+ class ManagePropertygraphStatisticsOutput < Struct.new(
2225
+ :status,
2226
+ :payload)
2227
+ SENSITIVE = []
2228
+ include Aws::Structure
2229
+ end
2230
+
2231
+ # @!attribute [rw] mode
2232
+ # The statistics generation mode. One of: `DISABLE_AUTOCOMPUTE`,
2233
+ # `ENABLE_AUTOCOMPUTE`, or `REFRESH`, the last of which manually
2234
+ # triggers DFE statistics generation.
2235
+ # @return [String]
2236
+ #
2237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ManageSparqlStatisticsInput AWS API Documentation
2238
+ #
2239
+ class ManageSparqlStatisticsInput < Struct.new(
2240
+ :mode)
2241
+ SENSITIVE = []
2242
+ include Aws::Structure
2243
+ end
2244
+
2245
+ # @!attribute [rw] status
2246
+ # The HTTP return code of the request. If the request succeeded, the
2247
+ # code is 200.
2248
+ # @return [String]
2249
+ #
2250
+ # @!attribute [rw] payload
2251
+ # This is only returned for refresh mode.
2252
+ # @return [Types::RefreshStatisticsIdMap]
2253
+ #
2254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ManageSparqlStatisticsOutput AWS API Documentation
2255
+ #
2256
+ class ManageSparqlStatisticsOutput < Struct.new(
2257
+ :status,
2258
+ :payload)
2259
+ SENSITIVE = []
2260
+ include Aws::Structure
2261
+ end
2262
+
2263
+ # Raised when a request fails because of insufficient memory resources.
2264
+ # The request can be retried.
2265
+ #
2266
+ # @!attribute [rw] detailed_message
2267
+ # A detailed message describing the problem.
2268
+ # @return [String]
2269
+ #
2270
+ # @!attribute [rw] request_id
2271
+ # The ID of the request that failed.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] code
2275
+ # The HTTP status code returned with the exception.
2276
+ # @return [String]
2277
+ #
2278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MemoryLimitExceededException AWS API Documentation
2279
+ #
2280
+ class MemoryLimitExceededException < Struct.new(
2281
+ :detailed_message,
2282
+ :request_id,
2283
+ :code)
2284
+ SENSITIVE = []
2285
+ include Aws::Structure
2286
+ end
2287
+
2288
+ # Raised when the HTTP method used by a request is not supported by the
2289
+ # endpoint being used.
2290
+ #
2291
+ # @!attribute [rw] detailed_message
2292
+ # A detailed message describing the problem.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] request_id
2296
+ # The ID of the request in question.
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] code
2300
+ # The HTTP status code returned with the exception.
2301
+ # @return [String]
2302
+ #
2303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MethodNotAllowedException AWS API Documentation
2304
+ #
2305
+ class MethodNotAllowedException < Struct.new(
2306
+ :detailed_message,
2307
+ :request_id,
2308
+ :code)
2309
+ SENSITIVE = []
2310
+ include Aws::Structure
2311
+ end
2312
+
2313
+ # Raised when a required parameter is missing.
2314
+ #
2315
+ # @!attribute [rw] detailed_message
2316
+ # A detailed message describing the problem.
2317
+ # @return [String]
2318
+ #
2319
+ # @!attribute [rw] request_id
2320
+ # The ID of the request in which the parameter is missing.
2321
+ # @return [String]
2322
+ #
2323
+ # @!attribute [rw] code
2324
+ # The HTTP status code returned with the exception.
2325
+ # @return [String]
2326
+ #
2327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MissingParameterException AWS API Documentation
2328
+ #
2329
+ class MissingParameterException < Struct.new(
2330
+ :detailed_message,
2331
+ :request_id,
2332
+ :code)
2333
+ SENSITIVE = []
2334
+ include Aws::Structure
2335
+ end
2336
+
2337
+ # Contains a Neptune ML configuration.
2338
+ #
2339
+ # @!attribute [rw] name
2340
+ # The configuration name.
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] arn
2344
+ # The ARN for the configuration.
2345
+ # @return [String]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MlConfigDefinition AWS API Documentation
2348
+ #
2349
+ class MlConfigDefinition < Struct.new(
2350
+ :name,
2351
+ :arn)
2352
+ SENSITIVE = []
2353
+ include Aws::Structure
2354
+ end
2355
+
2356
+ # Defines a Neptune ML resource.
2357
+ #
2358
+ # @!attribute [rw] name
2359
+ # The resource name.
2360
+ # @return [String]
2361
+ #
2362
+ # @!attribute [rw] arn
2363
+ # The resource ARN.
2364
+ # @return [String]
2365
+ #
2366
+ # @!attribute [rw] status
2367
+ # The resource status.
2368
+ # @return [String]
2369
+ #
2370
+ # @!attribute [rw] output_location
2371
+ # The output location.
2372
+ # @return [String]
2373
+ #
2374
+ # @!attribute [rw] failure_reason
2375
+ # The failure reason, in case of a failure.
2376
+ # @return [String]
2377
+ #
2378
+ # @!attribute [rw] cloudwatch_log_url
2379
+ # The CloudWatch log URL for the resource.
2380
+ # @return [String]
2381
+ #
2382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/MlResourceDefinition AWS API Documentation
2383
+ #
2384
+ class MlResourceDefinition < Struct.new(
2385
+ :name,
2386
+ :arn,
2387
+ :status,
2388
+ :output_location,
2389
+ :failure_reason,
2390
+ :cloudwatch_log_url)
2391
+ SENSITIVE = []
2392
+ include Aws::Structure
2393
+ end
2394
+
2395
+ # A node structure.
2396
+ #
2397
+ # @!attribute [rw] count
2398
+ # Number of nodes that have this specific structure.
2399
+ # @return [Integer]
2400
+ #
2401
+ # @!attribute [rw] node_properties
2402
+ # A list of the node properties present in this specific structure.
2403
+ # @return [Array<String>]
2404
+ #
2405
+ # @!attribute [rw] distinct_outgoing_edge_labels
2406
+ # A list of distinct outgoing edge labels present in this specific
2407
+ # structure.
2408
+ # @return [Array<String>]
2409
+ #
2410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/NodeStructure AWS API Documentation
2411
+ #
2412
+ class NodeStructure < Struct.new(
2413
+ :count,
2414
+ :node_properties,
2415
+ :distinct_outgoing_edge_labels)
2416
+ SENSITIVE = []
2417
+ include Aws::Structure
2418
+ end
2419
+
2420
+ # Raised when a parsing issue is encountered.
2421
+ #
2422
+ # @!attribute [rw] detailed_message
2423
+ # A detailed message describing the problem.
2424
+ # @return [String]
2425
+ #
2426
+ # @!attribute [rw] request_id
2427
+ # The ID of the request in question.
2428
+ # @return [String]
2429
+ #
2430
+ # @!attribute [rw] code
2431
+ # The HTTP status code returned with the exception.
2432
+ # @return [String]
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ParsingException AWS API Documentation
2435
+ #
2436
+ class ParsingException < Struct.new(
2437
+ :detailed_message,
2438
+ :request_id,
2439
+ :code)
2440
+ SENSITIVE = []
2441
+ include Aws::Structure
2442
+ end
2443
+
2444
+ # Raised when a precondition for processing a request is not satisfied.
2445
+ #
2446
+ # @!attribute [rw] detailed_message
2447
+ # A detailed message describing the problem.
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] request_id
2451
+ # The ID of the request in question.
2452
+ # @return [String]
2453
+ #
2454
+ # @!attribute [rw] code
2455
+ # The HTTP status code returned with the exception.
2456
+ # @return [String]
2457
+ #
2458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/PreconditionsFailedException AWS API Documentation
2459
+ #
2460
+ class PreconditionsFailedException < Struct.new(
2461
+ :detailed_message,
2462
+ :request_id,
2463
+ :code)
2464
+ SENSITIVE = []
2465
+ include Aws::Structure
2466
+ end
2467
+
2468
+ # A Gremlin or openCypher change record.
2469
+ #
2470
+ # @!attribute [rw] id
2471
+ # The ID of the Gremlin or openCypher element.
2472
+ # @return [String]
2473
+ #
2474
+ # @!attribute [rw] type
2475
+ # The type of this Gremlin or openCypher element. Must be one of:
2476
+ #
2477
+ # * <b> <code>v1</code> </b>   -   Vertex label for Gremlin, or node
2478
+ # label for openCypher.
2479
+ #
2480
+ # * <b> <code>vp</code> </b>   -   Vertex properties for Gremlin, or
2481
+ # node properties for openCypher.
2482
+ #
2483
+ # * <b> <code>e</code> </b>   -   Edge and edge label for Gremlin, or
2484
+ # relationship and relationship type for openCypher.
2485
+ #
2486
+ # * <b> <code>ep</code> </b>   -   Edge properties for Gremlin, or
2487
+ # relationship properties for openCypher.
2488
+ # @return [String]
2489
+ #
2490
+ # @!attribute [rw] key
2491
+ # The property name. For element labels, this is `label`.
2492
+ # @return [String]
2493
+ #
2494
+ # @!attribute [rw] value
2495
+ # This is a JSON object that contains a value field for the value
2496
+ # itself, and a datatype field for the JSON data type of that value:
2497
+ # @return [Hash,Array,String,Numeric,Boolean]
2498
+ #
2499
+ # @!attribute [rw] from
2500
+ # If this is an edge (type = `e`), the ID of the corresponding `from`
2501
+ # vertex or source node.
2502
+ # @return [String]
2503
+ #
2504
+ # @!attribute [rw] to
2505
+ # If this is an edge (type = `e`), the ID of the corresponding `to`
2506
+ # vertex or target node.
2507
+ # @return [String]
2508
+ #
2509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/PropertygraphData AWS API Documentation
2510
+ #
2511
+ class PropertygraphData < Struct.new(
2512
+ :id,
2513
+ :type,
2514
+ :key,
2515
+ :value,
2516
+ :from,
2517
+ :to)
2518
+ SENSITIVE = []
2519
+ include Aws::Structure
2520
+ end
2521
+
2522
+ # Structure of a property graph record.
2523
+ #
2524
+ # @!attribute [rw] commit_timestamp_in_millis
2525
+ # The time at which the commit for the transaction was requested, in
2526
+ # milliseconds from the Unix epoch.
2527
+ # @return [Integer]
2528
+ #
2529
+ # @!attribute [rw] event_id
2530
+ # The sequence identifier of the stream change record.
2531
+ # @return [Hash<String,String>]
2532
+ #
2533
+ # @!attribute [rw] data
2534
+ # The serialized Gremlin or openCypher change record.
2535
+ # @return [Types::PropertygraphData]
2536
+ #
2537
+ # @!attribute [rw] op
2538
+ # The operation that created the change.
2539
+ # @return [String]
2540
+ #
2541
+ # @!attribute [rw] is_last_op
2542
+ # Only present if this operation is the last one in its transaction.
2543
+ # If present, it is set to true. It is useful for ensuring that an
2544
+ # entire transaction is consumed.
2545
+ # @return [Boolean]
2546
+ #
2547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/PropertygraphRecord AWS API Documentation
2548
+ #
2549
+ class PropertygraphRecord < Struct.new(
2550
+ :commit_timestamp_in_millis,
2551
+ :event_id,
2552
+ :data,
2553
+ :op,
2554
+ :is_last_op)
2555
+ SENSITIVE = []
2556
+ include Aws::Structure
2557
+ end
2558
+
2559
+ # The graph summary API returns a read-only list of node and edge labels
2560
+ # and property keys, along with counts of nodes, edges, and properties.
2561
+ # See [Graph summary response for a property graph (PG)][1].
2562
+ #
2563
+ #
2564
+ #
2565
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response
2566
+ #
2567
+ # @!attribute [rw] num_nodes
2568
+ # The number of nodes in the graph.
2569
+ # @return [Integer]
2570
+ #
2571
+ # @!attribute [rw] num_edges
2572
+ # The number of edges in the graph.
2573
+ # @return [Integer]
2574
+ #
2575
+ # @!attribute [rw] num_node_labels
2576
+ # The number of distinct node labels in the graph.
2577
+ # @return [Integer]
2578
+ #
2579
+ # @!attribute [rw] num_edge_labels
2580
+ # The number of distinct edge labels in the graph.
2581
+ # @return [Integer]
2582
+ #
2583
+ # @!attribute [rw] node_labels
2584
+ # A list of the distinct node labels in the graph.
2585
+ # @return [Array<String>]
2586
+ #
2587
+ # @!attribute [rw] edge_labels
2588
+ # A list of the distinct edge labels in the graph.
2589
+ # @return [Array<String>]
2590
+ #
2591
+ # @!attribute [rw] num_node_properties
2592
+ # A list of the distinct node properties in the graph, along with the
2593
+ # count of nodes where each property is used.
2594
+ # @return [Integer]
2595
+ #
2596
+ # @!attribute [rw] num_edge_properties
2597
+ # The number of distinct edge properties in the graph.
2598
+ # @return [Integer]
2599
+ #
2600
+ # @!attribute [rw] node_properties
2601
+ # The number of distinct node properties in the graph.
2602
+ # @return [Array<Hash<String,Integer>>]
2603
+ #
2604
+ # @!attribute [rw] edge_properties
2605
+ # A list of the distinct edge properties in the graph, along with the
2606
+ # count of edges where each property is used.
2607
+ # @return [Array<Hash<String,Integer>>]
2608
+ #
2609
+ # @!attribute [rw] total_node_property_values
2610
+ # The total number of usages of all node properties.
2611
+ # @return [Integer]
2612
+ #
2613
+ # @!attribute [rw] total_edge_property_values
2614
+ # The total number of usages of all edge properties.
2615
+ # @return [Integer]
2616
+ #
2617
+ # @!attribute [rw] node_structures
2618
+ # This field is only present when the requested mode is `DETAILED`. It
2619
+ # contains a list of node structures.
2620
+ # @return [Array<Types::NodeStructure>]
2621
+ #
2622
+ # @!attribute [rw] edge_structures
2623
+ # This field is only present when the requested mode is `DETAILED`. It
2624
+ # contains a list of edge structures.
2625
+ # @return [Array<Types::EdgeStructure>]
2626
+ #
2627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/PropertygraphSummary AWS API Documentation
2628
+ #
2629
+ class PropertygraphSummary < Struct.new(
2630
+ :num_nodes,
2631
+ :num_edges,
2632
+ :num_node_labels,
2633
+ :num_edge_labels,
2634
+ :node_labels,
2635
+ :edge_labels,
2636
+ :num_node_properties,
2637
+ :num_edge_properties,
2638
+ :node_properties,
2639
+ :edge_properties,
2640
+ :total_node_property_values,
2641
+ :total_edge_property_values,
2642
+ :node_structures,
2643
+ :edge_structures)
2644
+ SENSITIVE = []
2645
+ include Aws::Structure
2646
+ end
2647
+
2648
+ # Payload for the property graph summary response.
2649
+ #
2650
+ # @!attribute [rw] version
2651
+ # The version of this graph summary response.
2652
+ # @return [String]
2653
+ #
2654
+ # @!attribute [rw] last_statistics_computation_time
2655
+ # The timestamp, in ISO 8601 format, of the time at which Neptune last
2656
+ # computed statistics.
2657
+ # @return [Time]
2658
+ #
2659
+ # @!attribute [rw] graph_summary
2660
+ # The graph summary.
2661
+ # @return [Types::PropertygraphSummary]
2662
+ #
2663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/PropertygraphSummaryValueMap AWS API Documentation
2664
+ #
2665
+ class PropertygraphSummaryValueMap < Struct.new(
2666
+ :version,
2667
+ :last_statistics_computation_time,
2668
+ :graph_summary)
2669
+ SENSITIVE = []
2670
+ include Aws::Structure
2671
+ end
2672
+
2673
+ # Structure to capture query statistics such as how many queries are
2674
+ # running, accepted or waiting and their details.
2675
+ #
2676
+ # @!attribute [rw] waited
2677
+ # Indicates how long the query waited, in milliseconds.
2678
+ # @return [Integer]
2679
+ #
2680
+ # @!attribute [rw] elapsed
2681
+ # The number of milliseconds the query has been running so far.
2682
+ # @return [Integer]
2683
+ #
2684
+ # @!attribute [rw] cancelled
2685
+ # Set to `TRUE` if the query was cancelled, or FALSE otherwise.
2686
+ # @return [Boolean]
2687
+ #
2688
+ # @!attribute [rw] subqueries
2689
+ # The number of subqueries in this query.
2690
+ # @return [Hash,Array,String,Numeric,Boolean]
2691
+ #
2692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/QueryEvalStats AWS API Documentation
2693
+ #
2694
+ class QueryEvalStats < Struct.new(
2695
+ :waited,
2696
+ :elapsed,
2697
+ :cancelled,
2698
+ :subqueries)
2699
+ SENSITIVE = []
2700
+ include Aws::Structure
2701
+ end
2702
+
2703
+ # Structure for expressing the query language version.
2704
+ #
2705
+ # @!attribute [rw] version
2706
+ # The version of the query language.
2707
+ # @return [String]
2708
+ #
2709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/QueryLanguageVersion AWS API Documentation
2710
+ #
2711
+ class QueryLanguageVersion < Struct.new(
2712
+ :version)
2713
+ SENSITIVE = []
2714
+ include Aws::Structure
2715
+ end
2716
+
2717
+ # Raised when the number of active queries exceeds what the server can
2718
+ # process. The query in question can be retried when the system is less
2719
+ # busy.
2720
+ #
2721
+ # @!attribute [rw] detailed_message
2722
+ # A detailed message describing the problem.
2723
+ # @return [String]
2724
+ #
2725
+ # @!attribute [rw] request_id
2726
+ # The ID of the request which exceeded the limit.
2727
+ # @return [String]
2728
+ #
2729
+ # @!attribute [rw] code
2730
+ # The HTTP status code returned with the exception.
2731
+ # @return [String]
2732
+ #
2733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/QueryLimitExceededException AWS API Documentation
2734
+ #
2735
+ class QueryLimitExceededException < Struct.new(
2736
+ :detailed_message,
2737
+ :request_id,
2738
+ :code)
2739
+ SENSITIVE = []
2740
+ include Aws::Structure
2741
+ end
2742
+
2743
+ # Raised when the size of a query exceeds the system limit.
2744
+ #
2745
+ # @!attribute [rw] detailed_message
2746
+ # A detailed message describing the problem.
2747
+ # @return [String]
2748
+ #
2749
+ # @!attribute [rw] request_id
2750
+ # The ID of the request that exceeded the limit.
2751
+ # @return [String]
2752
+ #
2753
+ # @!attribute [rw] code
2754
+ # The HTTP status code returned with the exception.
2755
+ # @return [String]
2756
+ #
2757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/QueryLimitException AWS API Documentation
2758
+ #
2759
+ class QueryLimitException < Struct.new(
2760
+ :detailed_message,
2761
+ :request_id,
2762
+ :code)
2763
+ SENSITIVE = []
2764
+ include Aws::Structure
2765
+ end
2766
+
2767
+ # Raised when the body of a query is too large.
2768
+ #
2769
+ # @!attribute [rw] detailed_message
2770
+ # A detailed message describing the problem.
2771
+ # @return [String]
2772
+ #
2773
+ # @!attribute [rw] request_id
2774
+ # The ID of the request that is too large.
2775
+ # @return [String]
2776
+ #
2777
+ # @!attribute [rw] code
2778
+ # The HTTP status code returned with the exception.
2779
+ # @return [String]
2780
+ #
2781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/QueryTooLargeException AWS API Documentation
2782
+ #
2783
+ class QueryTooLargeException < Struct.new(
2784
+ :detailed_message,
2785
+ :request_id,
2786
+ :code)
2787
+ SENSITIVE = []
2788
+ include Aws::Structure
2789
+ end
2790
+
2791
+ # The RDF graph summary API returns a read-only list of classes and
2792
+ # predicate keys, along with counts of quads, subjects, and predicates.
2793
+ #
2794
+ # @!attribute [rw] num_distinct_subjects
2795
+ # The number of distinct subjects in the graph.
2796
+ # @return [Integer]
2797
+ #
2798
+ # @!attribute [rw] num_distinct_predicates
2799
+ # The number of distinct predicates in the graph.
2800
+ # @return [Integer]
2801
+ #
2802
+ # @!attribute [rw] num_quads
2803
+ # The number of quads in the graph.
2804
+ # @return [Integer]
2805
+ #
2806
+ # @!attribute [rw] num_classes
2807
+ # The number of classes in the graph.
2808
+ # @return [Integer]
2809
+ #
2810
+ # @!attribute [rw] classes
2811
+ # A list of the classes in the graph.
2812
+ # @return [Array<String>]
2813
+ #
2814
+ # @!attribute [rw] predicates
2815
+ # "A list of predicates in the graph, along with the predicate
2816
+ # counts.
2817
+ # @return [Array<Hash<String,Integer>>]
2818
+ #
2819
+ # @!attribute [rw] subject_structures
2820
+ # This field is only present when the request mode is `DETAILED`. It
2821
+ # contains a list of subject structures.
2822
+ # @return [Array<Types::SubjectStructure>]
2823
+ #
2824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/RDFGraphSummary AWS API Documentation
2825
+ #
2826
+ class RDFGraphSummary < Struct.new(
2827
+ :num_distinct_subjects,
2828
+ :num_distinct_predicates,
2829
+ :num_quads,
2830
+ :num_classes,
2831
+ :classes,
2832
+ :predicates,
2833
+ :subject_structures)
2834
+ SENSITIVE = []
2835
+ include Aws::Structure
2836
+ end
2837
+
2838
+ # Payload for an RDF graph summary response.
2839
+ #
2840
+ # @!attribute [rw] version
2841
+ # The version of this graph summary response.
2842
+ # @return [String]
2843
+ #
2844
+ # @!attribute [rw] last_statistics_computation_time
2845
+ # The timestamp, in ISO 8601 format, of the time at which Neptune last
2846
+ # computed statistics.
2847
+ # @return [Time]
2848
+ #
2849
+ # @!attribute [rw] graph_summary
2850
+ # The graph summary of an RDF graph. See [Graph summary response for
2851
+ # an RDF graph][1].
2852
+ #
2853
+ #
2854
+ #
2855
+ # [1]: https://docs.aws.amazon.com/neptune-graph-summary.html#neptune-graph-summary-rdf-response
2856
+ # @return [Types::RDFGraphSummary]
2857
+ #
2858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/RDFGraphSummaryValueMap AWS API Documentation
2859
+ #
2860
+ class RDFGraphSummaryValueMap < Struct.new(
2861
+ :version,
2862
+ :last_statistics_computation_time,
2863
+ :graph_summary)
2864
+ SENSITIVE = []
2865
+ include Aws::Structure
2866
+ end
2867
+
2868
+ # Raised when a request attempts to write to a read-only resource.
2869
+ #
2870
+ # @!attribute [rw] detailed_message
2871
+ # A detailed message describing the problem.
2872
+ # @return [String]
2873
+ #
2874
+ # @!attribute [rw] request_id
2875
+ # The ID of the request in which the parameter is missing.
2876
+ # @return [String]
2877
+ #
2878
+ # @!attribute [rw] code
2879
+ # The HTTP status code returned with the exception.
2880
+ # @return [String]
2881
+ #
2882
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ReadOnlyViolationException AWS API Documentation
2883
+ #
2884
+ class ReadOnlyViolationException < Struct.new(
2885
+ :detailed_message,
2886
+ :request_id,
2887
+ :code)
2888
+ SENSITIVE = []
2889
+ include Aws::Structure
2890
+ end
2891
+
2892
+ # Statistics for `REFRESH` mode.
2893
+ #
2894
+ # @!attribute [rw] statistics_id
2895
+ # The ID of the statistics generation run that is currently occurring.
2896
+ # @return [String]
2897
+ #
2898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/RefreshStatisticsIdMap AWS API Documentation
2899
+ #
2900
+ class RefreshStatisticsIdMap < Struct.new(
2901
+ :statistics_id)
2902
+ SENSITIVE = []
2903
+ include Aws::Structure
2904
+ end
2905
+
2906
+ # Raised when there is a problem accessing Amazon S3.
2907
+ #
2908
+ # @!attribute [rw] detailed_message
2909
+ # A detailed message describing the problem.
2910
+ # @return [String]
2911
+ #
2912
+ # @!attribute [rw] request_id
2913
+ # The ID of the request in question.
2914
+ # @return [String]
2915
+ #
2916
+ # @!attribute [rw] code
2917
+ # The HTTP status code returned with the exception.
2918
+ # @return [String]
2919
+ #
2920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/S3Exception AWS API Documentation
2921
+ #
2922
+ class S3Exception < Struct.new(
2923
+ :detailed_message,
2924
+ :request_id,
2925
+ :code)
2926
+ SENSITIVE = []
2927
+ include Aws::Structure
2928
+ end
2929
+
2930
+ # Raised when the server shuts down while processing a request.
2931
+ #
2932
+ # @!attribute [rw] detailed_message
2933
+ # A detailed message describing the problem.
2934
+ # @return [String]
2935
+ #
2936
+ # @!attribute [rw] request_id
2937
+ # The ID of the request in question.
2938
+ # @return [String]
2939
+ #
2940
+ # @!attribute [rw] code
2941
+ # The HTTP status code returned with the exception.
2942
+ # @return [String]
2943
+ #
2944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ServerShutdownException AWS API Documentation
2945
+ #
2946
+ class ServerShutdownException < Struct.new(
2947
+ :detailed_message,
2948
+ :request_id,
2949
+ :code)
2950
+ SENSITIVE = []
2951
+ include Aws::Structure
2952
+ end
2953
+
2954
+ # Neptune logs are converted to SPARQL quads in the graph using the
2955
+ # Resource Description Framework (RDF) [N-QUADS][1] language defined in
2956
+ # the W3C RDF 1.1 N-Quads specification
2957
+ #
2958
+ #
2959
+ #
2960
+ # [1]: https://www.w3.org/TR/n-quads/
2961
+ #
2962
+ # @!attribute [rw] stmt
2963
+ # Holds an [N-QUADS][1] statement expressing the changed quad.
2964
+ #
2965
+ #
2966
+ #
2967
+ # [1]: https://www.w3.org/TR/n-quads/
2968
+ # @return [String]
2969
+ #
2970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/SparqlData AWS API Documentation
2971
+ #
2972
+ class SparqlData < Struct.new(
2973
+ :stmt)
2974
+ SENSITIVE = []
2975
+ include Aws::Structure
2976
+ end
2977
+
2978
+ # A serialized SPARQL stream record capturing a change-log entry for the
2979
+ # RDF graph.
2980
+ #
2981
+ # @!attribute [rw] commit_timestamp_in_millis
2982
+ # The time at which the commit for the transaction was requested, in
2983
+ # milliseconds from the Unix epoch.
2984
+ # @return [Integer]
2985
+ #
2986
+ # @!attribute [rw] event_id
2987
+ # The sequence identifier of the stream change record.
2988
+ # @return [Hash<String,String>]
2989
+ #
2990
+ # @!attribute [rw] data
2991
+ # The serialized SPARQL change record. The serialization formats of
2992
+ # each record are described in more detail in [Serialization Formats
2993
+ # in Neptune Streams][1].
2994
+ #
2995
+ #
2996
+ #
2997
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html
2998
+ # @return [Types::SparqlData]
2999
+ #
3000
+ # @!attribute [rw] op
3001
+ # The operation that created the change.
3002
+ # @return [String]
3003
+ #
3004
+ # @!attribute [rw] is_last_op
3005
+ # Only present if this operation is the last one in its transaction.
3006
+ # If present, it is set to true. It is useful for ensuring that an
3007
+ # entire transaction is consumed.
3008
+ # @return [Boolean]
3009
+ #
3010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/SparqlRecord AWS API Documentation
3011
+ #
3012
+ class SparqlRecord < Struct.new(
3013
+ :commit_timestamp_in_millis,
3014
+ :event_id,
3015
+ :data,
3016
+ :op,
3017
+ :is_last_op)
3018
+ SENSITIVE = []
3019
+ include Aws::Structure
3020
+ end
3021
+
3022
+ # @!attribute [rw] source
3023
+ # The `source` parameter accepts an S3 URI that identifies a single
3024
+ # file, multiple files, a folder, or multiple folders. Neptune loads
3025
+ # every data file in any folder that is specified.
3026
+ #
3027
+ # The URI can be in any of the following formats.
3028
+ #
3029
+ # * `s3://(bucket_name)/(object-key-name)`
3030
+ #
3031
+ # * `https://s3.amazonaws.com/(bucket_name)/(object-key-name)`
3032
+ #
3033
+ # * `https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)`
3034
+ #
3035
+ # The `object-key-name` element of the URI is equivalent to the
3036
+ # [prefix][1] parameter in an S3 [ListObjects][2] API call. It
3037
+ # identifies all the objects in the specified S3 bucket whose names
3038
+ # begin with that prefix. That can be a single file or folder, or
3039
+ # multiple files and/or folders.
3040
+ #
3041
+ # The specified folder or folders can contain multiple vertex files
3042
+ # and multiple edge files.
3043
+ #
3044
+ #
3045
+ #
3046
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters
3047
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
3048
+ # @return [String]
3049
+ #
3050
+ # @!attribute [rw] format
3051
+ # The format of the data. For more information about data formats for
3052
+ # the Neptune `Loader` command, see [Load Data Formats][1].
3053
+ #
3054
+ # **Allowed values**
3055
+ #
3056
+ # * <b> <code>csv</code> </b> for the [Gremlin CSV data format][2].
3057
+ #
3058
+ # * <b> <code>opencypher</code> </b> for the [openCypher CSV data
3059
+ # format][3].
3060
+ #
3061
+ # * <b> <code>ntriples</code> </b> for the [N-Triples RDF data
3062
+ # format][4].
3063
+ #
3064
+ # * <b> <code>nquads</code> </b> for the [N-Quads RDF data format][5].
3065
+ #
3066
+ # * <b> <code>rdfxml</code> </b> for the [RDF\\XML RDF data
3067
+ # format][6].
3068
+ #
3069
+ # * <b> <code>turtle</code> </b> for the [Turtle RDF data format][7].
3070
+ #
3071
+ #
3072
+ #
3073
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html
3074
+ # [2]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html
3075
+ # [3]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
3076
+ # [4]: https://www.w3.org/TR/n-triples/
3077
+ # [5]: https://www.w3.org/TR/n-quads/
3078
+ # [6]: https://www.w3.org/TR/rdf-syntax-grammar/
3079
+ # [7]: https://www.w3.org/TR/turtle/
3080
+ # @return [String]
3081
+ #
3082
+ # @!attribute [rw] s3_bucket_region
3083
+ # The Amazon region of the S3 bucket. This must match the Amazon
3084
+ # Region of the DB cluster.
3085
+ # @return [String]
3086
+ #
3087
+ # @!attribute [rw] iam_role_arn
3088
+ # The Amazon Resource Name (ARN) for an IAM role to be assumed by the
3089
+ # Neptune DB instance for access to the S3 bucket. The IAM role ARN
3090
+ # provided here should be attached to the DB cluster (see [Adding the
3091
+ # IAM Role to an Amazon Neptune Cluster][1].
3092
+ #
3093
+ #
3094
+ #
3095
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html
3096
+ # @return [String]
3097
+ #
3098
+ # @!attribute [rw] mode
3099
+ # The load job mode.
3100
+ #
3101
+ # *Allowed values*: `RESUME`, `NEW`, `AUTO`.
3102
+ #
3103
+ # *Default value*: `AUTO`.
3104
+ #
3105
+ # ****
3106
+ #
3107
+ # * `RESUME`   –   In RESUME mode, the loader looks for a previous
3108
+ # load from this source, and if it finds one, resumes that load job.
3109
+ # If no previous load job is found, the loader stops.
3110
+ #
3111
+ # The loader avoids reloading files that were successfully loaded in
3112
+ # a previous job. It only tries to process failed files. If you
3113
+ # dropped previously loaded data from your Neptune cluster, that
3114
+ # data is not reloaded in this mode. If a previous load job loaded
3115
+ # all files from the same source successfully, nothing is reloaded,
3116
+ # and the loader returns success.
3117
+ #
3118
+ # * `NEW`   –   In NEW mode, the creates a new load request regardless
3119
+ # of any previous loads. You can use this mode to reload all the
3120
+ # data from a source after dropping previously loaded data from your
3121
+ # Neptune cluster, or to load new data available at the same source.
3122
+ #
3123
+ # * `AUTO`   –   In AUTO mode, the loader looks for a previous load
3124
+ # job from the same source, and if it finds one, resumes that job,
3125
+ # just as in `RESUME` mode.
3126
+ #
3127
+ # If the loader doesn't find a previous load job from the same
3128
+ # source, it loads all data from the source, just as in `NEW` mode.
3129
+ # @return [String]
3130
+ #
3131
+ # @!attribute [rw] fail_on_error
3132
+ # <b> <code>failOnError</code> </b>   –   A flag to toggle a complete
3133
+ # stop on an error.
3134
+ #
3135
+ # *Allowed values*: `"TRUE"`, `"FALSE"`.
3136
+ #
3137
+ # *Default value*: `"TRUE"`.
3138
+ #
3139
+ # When this parameter is set to `"FALSE"`, the loader tries to load
3140
+ # all the data in the location specified, skipping any entries with
3141
+ # errors.
3142
+ #
3143
+ # When this parameter is set to `"TRUE"`, the loader stops as soon as
3144
+ # it encounters an error. Data loaded up to that point persists.
3145
+ # @return [Boolean]
3146
+ #
3147
+ # @!attribute [rw] parallelism
3148
+ # The optional `parallelism` parameter can be set to reduce the number
3149
+ # of threads used by the bulk load process.
3150
+ #
3151
+ # *Allowed values*:
3152
+ #
3153
+ # * `LOW` –   The number of threads used is the number of available
3154
+ # vCPUs divided by 8.
3155
+ #
3156
+ # * `MEDIUM` –   The number of threads used is the number of available
3157
+ # vCPUs divided by 2.
3158
+ #
3159
+ # * `HIGH` –   The number of threads used is the same as the number of
3160
+ # available vCPUs.
3161
+ #
3162
+ # * `OVERSUBSCRIBE` –   The number of threads used is the number of
3163
+ # available vCPUs multiplied by 2. If this value is used, the bulk
3164
+ # loader takes up all available resources.
3165
+ #
3166
+ # This does not mean, however, that the `OVERSUBSCRIBE` setting
3167
+ # results in 100% CPU utilization. Because the load operation is I/O
3168
+ # bound, the highest CPU utilization to expect is in the 60% to 70%
3169
+ # range.
3170
+ #
3171
+ # *Default value*: `HIGH`
3172
+ #
3173
+ # The `parallelism` setting can sometimes result in a deadlock between
3174
+ # threads when loading openCypher data. When this happens, Neptune
3175
+ # returns the `LOAD_DATA_DEADLOCK` error. You can generally fix the
3176
+ # issue by setting `parallelism` to a lower setting and retrying the
3177
+ # load command.
3178
+ # @return [String]
3179
+ #
3180
+ # @!attribute [rw] parser_configuration
3181
+ # <b> <code>parserConfiguration</code> </b>   –   An optional object
3182
+ # with additional parser configuration values. Each of the child
3183
+ # parameters is also optional:
3184
+ #
3185
+ # ****
3186
+ #
3187
+ # * <b> <code>namedGraphUri</code> </b>   –   The default graph for
3188
+ # all RDF formats when no graph is specified (for non-quads formats
3189
+ # and NQUAD entries with no graph).
3190
+ #
3191
+ # The default is
3192
+ # `https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph`.
3193
+ #
3194
+ # * <b> <code>baseUri</code> </b>   –   The base URI for RDF/XML and
3195
+ # Turtle formats.
3196
+ #
3197
+ # The default is `https://aws.amazon.com/neptune/default`.
3198
+ #
3199
+ # * <b> <code>allowEmptyStrings</code> </b>   –   Gremlin users need
3200
+ # to be able to pass empty string values("") as node and edge
3201
+ # properties when loading CSV data. If `allowEmptyStrings` is set to
3202
+ # `false` (the default), such empty strings are treated as nulls and
3203
+ # are not loaded.
3204
+ #
3205
+ # If `allowEmptyStrings` is set to `true`, the loader treats empty
3206
+ # strings as valid property values and loads them accordingly.
3207
+ # @return [Hash<String,String>]
3208
+ #
3209
+ # @!attribute [rw] update_single_cardinality_properties
3210
+ # `updateSingleCardinalityProperties` is an optional parameter that
3211
+ # controls how the bulk loader treats a new value for
3212
+ # single-cardinality vertex or edge properties. This is not supported
3213
+ # for loading openCypher data.
3214
+ #
3215
+ # *Allowed values*: `"TRUE"`, `"FALSE"`.
3216
+ #
3217
+ # *Default value*: `"FALSE"`.
3218
+ #
3219
+ # By default, or when `updateSingleCardinalityProperties` is
3220
+ # explicitly set to `"FALSE"`, the loader treats a new value as an
3221
+ # error, because it violates single cardinality.
3222
+ #
3223
+ # When `updateSingleCardinalityProperties` is set to `"TRUE"`, on the
3224
+ # other hand, the bulk loader replaces the existing value with the new
3225
+ # one. If multiple edge or single-cardinality vertex property values
3226
+ # are provided in the source file(s) being loaded, the final value at
3227
+ # the end of the bulk load could be any one of those new values. The
3228
+ # loader only guarantees that the existing value has been replaced by
3229
+ # one of the new ones.
3230
+ # @return [Boolean]
3231
+ #
3232
+ # @!attribute [rw] queue_request
3233
+ # This is an optional flag parameter that indicates whether the load
3234
+ # request can be queued up or not.
3235
+ #
3236
+ # You don't have to wait for one load job to complete before issuing
3237
+ # the next one, because Neptune can queue up as many as 64 jobs at a
3238
+ # time, provided that their `queueRequest` parameters are all set to
3239
+ # `"TRUE"`.
3240
+ #
3241
+ # If the `queueRequest` parameter is omitted or set to `"FALSE"`, the
3242
+ # load request will fail if another load job is already running.
3243
+ #
3244
+ # *Allowed values*: `"TRUE"`, `"FALSE"`.
3245
+ #
3246
+ # *Default value*: `"FALSE"`.
3247
+ # @return [Boolean]
3248
+ #
3249
+ # @!attribute [rw] dependencies
3250
+ # This is an optional parameter that can make a queued load request
3251
+ # contingent on the successful completion of one or more previous jobs
3252
+ # in the queue.
3253
+ #
3254
+ # Neptune can queue up as many as 64 load requests at a time, if their
3255
+ # `queueRequest` parameters are set to `"TRUE"`. The `dependencies`
3256
+ # parameter lets you make execution of such a queued request dependent
3257
+ # on the successful completion of one or more specified previous
3258
+ # requests in the queue.
3259
+ #
3260
+ # For example, if load `Job-A` and `Job-B` are independent of each
3261
+ # other, but load `Job-C` needs `Job-A` and `Job-B` to be finished
3262
+ # before it begins, proceed as follows:
3263
+ #
3264
+ # 1. Submit `load-job-A` and `load-job-B` one after another in any
3265
+ # order, and save their load-ids.
3266
+ #
3267
+ # 2. Submit `load-job-C` with the load-ids of the two jobs in its
3268
+ # `dependencies` field:
3269
+ #
3270
+ # Because of the `dependencies` parameter, the bulk loader will not
3271
+ # start `Job-C` until `Job-A` and `Job-B` have completed successfully.
3272
+ # If either one of them fails, Job-C will not be executed, and its
3273
+ # status will be set to
3274
+ # `LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED`.
3275
+ #
3276
+ # You can set up multiple levels of dependency in this way, so that
3277
+ # the failure of one job will cause all requests that are directly or
3278
+ # indirectly dependent on it to be cancelled.
3279
+ # @return [Array<String>]
3280
+ #
3281
+ # @!attribute [rw] user_provided_edge_ids
3282
+ # This parameter is required only when loading openCypher data that
3283
+ # contains relationship IDs. It must be included and set to `True`
3284
+ # when openCypher relationship IDs are explicitly provided in the load
3285
+ # data (recommended).
3286
+ #
3287
+ # When `userProvidedEdgeIds` is absent or set to `True`, an `:ID`
3288
+ # column must be present in every relationship file in the load.
3289
+ #
3290
+ # When `userProvidedEdgeIds` is present and set to `False`,
3291
+ # relationship files in the load **must not** contain an `:ID` column.
3292
+ # Instead, the Neptune loader automatically generates an ID for each
3293
+ # relationship.
3294
+ #
3295
+ # It's useful to provide relationship IDs explicitly so that the
3296
+ # loader can resume loading after error in the CSV data have been
3297
+ # fixed, without having to reload any relationships that have already
3298
+ # been loaded. If relationship IDs have not been explicitly assigned,
3299
+ # the loader cannot resume a failed load if any relationship file has
3300
+ # had to be corrected, and must instead reload all the relationships.
3301
+ # @return [Boolean]
3302
+ #
3303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartLoaderJobInput AWS API Documentation
3304
+ #
3305
+ class StartLoaderJobInput < Struct.new(
3306
+ :source,
3307
+ :format,
3308
+ :s3_bucket_region,
3309
+ :iam_role_arn,
3310
+ :mode,
3311
+ :fail_on_error,
3312
+ :parallelism,
3313
+ :parser_configuration,
3314
+ :update_single_cardinality_properties,
3315
+ :queue_request,
3316
+ :dependencies,
3317
+ :user_provided_edge_ids)
3318
+ SENSITIVE = []
3319
+ include Aws::Structure
3320
+ end
3321
+
3322
+ # @!attribute [rw] status
3323
+ # The HTTP return code indicating the status of the load job.
3324
+ # @return [String]
3325
+ #
3326
+ # @!attribute [rw] payload
3327
+ # Contains a `loadId` name-value pair that provides an identifier for
3328
+ # the load operation.
3329
+ # @return [Hash<String,String>]
3330
+ #
3331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartLoaderJobOutput AWS API Documentation
3332
+ #
3333
+ class StartLoaderJobOutput < Struct.new(
3334
+ :status,
3335
+ :payload)
3336
+ SENSITIVE = []
3337
+ include Aws::Structure
3338
+ end
3339
+
3340
+ # @!attribute [rw] id
3341
+ # A unique identifier for the new job. The default is an autogenerated
3342
+ # UUID.
3343
+ # @return [String]
3344
+ #
3345
+ # @!attribute [rw] previous_data_processing_job_id
3346
+ # The job ID of a completed data processing job run on an earlier
3347
+ # version of the data.
3348
+ # @return [String]
3349
+ #
3350
+ # @!attribute [rw] input_data_s3_location
3351
+ # The URI of the Amazon S3 location where you want SageMaker to
3352
+ # download the data needed to run the data processing job.
3353
+ # @return [String]
3354
+ #
3355
+ # @!attribute [rw] processed_data_s3_location
3356
+ # The URI of the Amazon S3 location where you want SageMaker to save
3357
+ # the results of a data processing job.
3358
+ # @return [String]
3359
+ #
3360
+ # @!attribute [rw] sagemaker_iam_role_arn
3361
+ # The ARN of an IAM role for SageMaker execution. This must be listed
3362
+ # in your DB cluster parameter group or an error will occur.
3363
+ # @return [String]
3364
+ #
3365
+ # @!attribute [rw] neptune_iam_role_arn
3366
+ # The Amazon Resource Name (ARN) of an IAM role that SageMaker can
3367
+ # assume to perform tasks on your behalf. This must be listed in your
3368
+ # DB cluster parameter group or an error will occur.
3369
+ # @return [String]
3370
+ #
3371
+ # @!attribute [rw] processing_instance_type
3372
+ # The type of ML instance used during data processing. Its memory
3373
+ # should be large enough to hold the processed dataset. The default is
3374
+ # the smallest ml.r5 type whose memory is ten times larger than the
3375
+ # size of the exported graph data on disk.
3376
+ # @return [String]
3377
+ #
3378
+ # @!attribute [rw] processing_instance_volume_size_in_gb
3379
+ # The disk volume size of the processing instance. Both input data and
3380
+ # processed data are stored on disk, so the volume size must be large
3381
+ # enough to hold both data sets. The default is 0. If not specified or
3382
+ # 0, Neptune ML chooses the volume size automatically based on the
3383
+ # data size.
3384
+ # @return [Integer]
3385
+ #
3386
+ # @!attribute [rw] processing_time_out_in_seconds
3387
+ # Timeout in seconds for the data processing job. The default is
3388
+ # 86,400 (1 day).
3389
+ # @return [Integer]
3390
+ #
3391
+ # @!attribute [rw] model_type
3392
+ # One of the two model types that Neptune ML currently supports:
3393
+ # heterogeneous graph models (`heterogeneous`), and knowledge graph
3394
+ # (`kge`). The default is none. If not specified, Neptune ML chooses
3395
+ # the model type automatically based on the data.
3396
+ # @return [String]
3397
+ #
3398
+ # @!attribute [rw] config_file_name
3399
+ # A data specification file that describes how to load the exported
3400
+ # graph data for training. The file is automatically generated by the
3401
+ # Neptune export toolkit. The default is
3402
+ # `training-data-configuration.json`.
3403
+ # @return [String]
3404
+ #
3405
+ # @!attribute [rw] subnets
3406
+ # The IDs of the subnets in the Neptune VPC. The default is None.
3407
+ # @return [Array<String>]
3408
+ #
3409
+ # @!attribute [rw] security_group_ids
3410
+ # The VPC security group IDs. The default is None.
3411
+ # @return [Array<String>]
3412
+ #
3413
+ # @!attribute [rw] volume_encryption_kms_key
3414
+ # The Amazon Key Management Service (Amazon KMS) key that SageMaker
3415
+ # uses to encrypt data on the storage volume attached to the ML
3416
+ # compute instances that run the training job. The default is None.
3417
+ # @return [String]
3418
+ #
3419
+ # @!attribute [rw] s3_output_encryption_kms_key
3420
+ # The Amazon Key Management Service (Amazon KMS) key that SageMaker
3421
+ # uses to encrypt the output of the processing job. The default is
3422
+ # none.
3423
+ # @return [String]
3424
+ #
3425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLDataProcessingJobInput AWS API Documentation
3426
+ #
3427
+ class StartMLDataProcessingJobInput < Struct.new(
3428
+ :id,
3429
+ :previous_data_processing_job_id,
3430
+ :input_data_s3_location,
3431
+ :processed_data_s3_location,
3432
+ :sagemaker_iam_role_arn,
3433
+ :neptune_iam_role_arn,
3434
+ :processing_instance_type,
3435
+ :processing_instance_volume_size_in_gb,
3436
+ :processing_time_out_in_seconds,
3437
+ :model_type,
3438
+ :config_file_name,
3439
+ :subnets,
3440
+ :security_group_ids,
3441
+ :volume_encryption_kms_key,
3442
+ :s3_output_encryption_kms_key)
3443
+ SENSITIVE = []
3444
+ include Aws::Structure
3445
+ end
3446
+
3447
+ # @!attribute [rw] id
3448
+ # The unique ID of the new data processing job.
3449
+ # @return [String]
3450
+ #
3451
+ # @!attribute [rw] arn
3452
+ # The ARN of the data processing job.
3453
+ # @return [String]
3454
+ #
3455
+ # @!attribute [rw] creation_time_in_millis
3456
+ # The time it took to create the new processing job, in milliseconds.
3457
+ # @return [Integer]
3458
+ #
3459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLDataProcessingJobOutput AWS API Documentation
3460
+ #
3461
+ class StartMLDataProcessingJobOutput < Struct.new(
3462
+ :id,
3463
+ :arn,
3464
+ :creation_time_in_millis)
3465
+ SENSITIVE = []
3466
+ include Aws::Structure
3467
+ end
3468
+
3469
+ # @!attribute [rw] id
3470
+ # A unique identifier for the new job. The default is An autogenerated
3471
+ # UUID.
3472
+ # @return [String]
3473
+ #
3474
+ # @!attribute [rw] previous_model_training_job_id
3475
+ # The job ID of a completed model-training job that you want to update
3476
+ # incrementally based on updated data.
3477
+ # @return [String]
3478
+ #
3479
+ # @!attribute [rw] data_processing_job_id
3480
+ # The job ID of the completed data-processing job that has created the
3481
+ # data that the training will work with.
3482
+ # @return [String]
3483
+ #
3484
+ # @!attribute [rw] train_model_s3_location
3485
+ # The location in Amazon S3 where the model artifacts are to be
3486
+ # stored.
3487
+ # @return [String]
3488
+ #
3489
+ # @!attribute [rw] sagemaker_iam_role_arn
3490
+ # The ARN of an IAM role for SageMaker execution.This must be listed
3491
+ # in your DB cluster parameter group or an error will occur.
3492
+ # @return [String]
3493
+ #
3494
+ # @!attribute [rw] neptune_iam_role_arn
3495
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
3496
+ # Amazon S3 resources. This must be listed in your DB cluster
3497
+ # parameter group or an error will occur.
3498
+ # @return [String]
3499
+ #
3500
+ # @!attribute [rw] base_processing_instance_type
3501
+ # The type of ML instance used in preparing and managing training of
3502
+ # ML models. This is a CPU instance chosen based on memory
3503
+ # requirements for processing the training data and model.
3504
+ # @return [String]
3505
+ #
3506
+ # @!attribute [rw] training_instance_type
3507
+ # The type of ML instance used for model training. All Neptune ML
3508
+ # models support CPU, GPU, and multiGPU training. The default is
3509
+ # `ml.p3.2xlarge`. Choosing the right instance type for training
3510
+ # depends on the task type, graph size, and your budget.
3511
+ # @return [String]
3512
+ #
3513
+ # @!attribute [rw] training_instance_volume_size_in_gb
3514
+ # The disk volume size of the training instance. Both input data and
3515
+ # the output model are stored on disk, so the volume size must be
3516
+ # large enough to hold both data sets. The default is 0. If not
3517
+ # specified or 0, Neptune ML selects a disk volume size based on the
3518
+ # recommendation generated in the data processing step.
3519
+ # @return [Integer]
3520
+ #
3521
+ # @!attribute [rw] training_time_out_in_seconds
3522
+ # Timeout in seconds for the training job. The default is 86,400 (1
3523
+ # day).
3524
+ # @return [Integer]
3525
+ #
3526
+ # @!attribute [rw] max_hpo_number_of_training_jobs
3527
+ # Maximum total number of training jobs to start for the
3528
+ # hyperparameter tuning job. The default is 2. Neptune ML
3529
+ # automatically tunes the hyperparameters of the machine learning
3530
+ # model. To obtain a model that performs well, use at least 10 jobs
3531
+ # (in other words, set `maxHPONumberOfTrainingJobs` to 10). In
3532
+ # general, the more tuning runs, the better the results.
3533
+ # @return [Integer]
3534
+ #
3535
+ # @!attribute [rw] max_hpo_parallel_training_jobs
3536
+ # Maximum number of parallel training jobs to start for the
3537
+ # hyperparameter tuning job. The default is 2. The number of parallel
3538
+ # jobs you can run is limited by the available resources on your
3539
+ # training instance.
3540
+ # @return [Integer]
3541
+ #
3542
+ # @!attribute [rw] subnets
3543
+ # The IDs of the subnets in the Neptune VPC. The default is None.
3544
+ # @return [Array<String>]
3545
+ #
3546
+ # @!attribute [rw] security_group_ids
3547
+ # The VPC security group IDs. The default is None.
3548
+ # @return [Array<String>]
3549
+ #
3550
+ # @!attribute [rw] volume_encryption_kms_key
3551
+ # The Amazon Key Management Service (KMS) key that SageMaker uses to
3552
+ # encrypt data on the storage volume attached to the ML compute
3553
+ # instances that run the training job. The default is None.
3554
+ # @return [String]
3555
+ #
3556
+ # @!attribute [rw] s3_output_encryption_kms_key
3557
+ # The Amazon Key Management Service (KMS) key that SageMaker uses to
3558
+ # encrypt the output of the processing job. The default is none.
3559
+ # @return [String]
3560
+ #
3561
+ # @!attribute [rw] enable_managed_spot_training
3562
+ # Optimizes the cost of training machine-learning models by using
3563
+ # Amazon Elastic Compute Cloud spot instances. The default is `False`.
3564
+ # @return [Boolean]
3565
+ #
3566
+ # @!attribute [rw] custom_model_training_parameters
3567
+ # The configuration for custom model training. This is a JSON object.
3568
+ # @return [Types::CustomModelTrainingParameters]
3569
+ #
3570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLModelTrainingJobInput AWS API Documentation
3571
+ #
3572
+ class StartMLModelTrainingJobInput < Struct.new(
3573
+ :id,
3574
+ :previous_model_training_job_id,
3575
+ :data_processing_job_id,
3576
+ :train_model_s3_location,
3577
+ :sagemaker_iam_role_arn,
3578
+ :neptune_iam_role_arn,
3579
+ :base_processing_instance_type,
3580
+ :training_instance_type,
3581
+ :training_instance_volume_size_in_gb,
3582
+ :training_time_out_in_seconds,
3583
+ :max_hpo_number_of_training_jobs,
3584
+ :max_hpo_parallel_training_jobs,
3585
+ :subnets,
3586
+ :security_group_ids,
3587
+ :volume_encryption_kms_key,
3588
+ :s3_output_encryption_kms_key,
3589
+ :enable_managed_spot_training,
3590
+ :custom_model_training_parameters)
3591
+ SENSITIVE = []
3592
+ include Aws::Structure
3593
+ end
3594
+
3595
+ # @!attribute [rw] id
3596
+ # The unique ID of the new model training job.
3597
+ # @return [String]
3598
+ #
3599
+ # @!attribute [rw] arn
3600
+ # The ARN of the new model training job.
3601
+ # @return [String]
3602
+ #
3603
+ # @!attribute [rw] creation_time_in_millis
3604
+ # The model training job creation time, in milliseconds.
3605
+ # @return [Integer]
3606
+ #
3607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLModelTrainingJobOutput AWS API Documentation
3608
+ #
3609
+ class StartMLModelTrainingJobOutput < Struct.new(
3610
+ :id,
3611
+ :arn,
3612
+ :creation_time_in_millis)
3613
+ SENSITIVE = []
3614
+ include Aws::Structure
3615
+ end
3616
+
3617
+ # @!attribute [rw] id
3618
+ # A unique identifier for the new job. The default is an autogenerated
3619
+ # UUID.
3620
+ # @return [String]
3621
+ #
3622
+ # @!attribute [rw] data_processing_job_id
3623
+ # The job ID of a completed data-processing job. You must include
3624
+ # either `dataProcessingJobId` and a `mlModelTrainingJobId`, or a
3625
+ # `trainingJobName`.
3626
+ # @return [String]
3627
+ #
3628
+ # @!attribute [rw] ml_model_training_job_id
3629
+ # The job ID of a completed model-training job. You must include
3630
+ # either `dataProcessingJobId` and a `mlModelTrainingJobId`, or a
3631
+ # `trainingJobName`.
3632
+ # @return [String]
3633
+ #
3634
+ # @!attribute [rw] training_job_name
3635
+ # The name of a completed SageMaker training job. You must include
3636
+ # either `dataProcessingJobId` and a `mlModelTrainingJobId`, or a
3637
+ # `trainingJobName`.
3638
+ # @return [String]
3639
+ #
3640
+ # @!attribute [rw] model_transform_output_s3_location
3641
+ # The location in Amazon S3 where the model artifacts are to be
3642
+ # stored.
3643
+ # @return [String]
3644
+ #
3645
+ # @!attribute [rw] sagemaker_iam_role_arn
3646
+ # The ARN of an IAM role for SageMaker execution. This must be listed
3647
+ # in your DB cluster parameter group or an error will occur.
3648
+ # @return [String]
3649
+ #
3650
+ # @!attribute [rw] neptune_iam_role_arn
3651
+ # The ARN of an IAM role that provides Neptune access to SageMaker and
3652
+ # Amazon S3 resources. This must be listed in your DB cluster
3653
+ # parameter group or an error will occur.
3654
+ # @return [String]
3655
+ #
3656
+ # @!attribute [rw] custom_model_transform_parameters
3657
+ # Configuration information for a model transform using a custom
3658
+ # model. The `customModelTransformParameters` object contains the
3659
+ # following fields, which must have values compatible with the saved
3660
+ # model parameters from the training job:
3661
+ # @return [Types::CustomModelTransformParameters]
3662
+ #
3663
+ # @!attribute [rw] base_processing_instance_type
3664
+ # The type of ML instance used in preparing and managing training of
3665
+ # ML models. This is an ML compute instance chosen based on memory
3666
+ # requirements for processing the training data and model.
3667
+ # @return [String]
3668
+ #
3669
+ # @!attribute [rw] base_processing_instance_volume_size_in_gb
3670
+ # The disk volume size of the training instance in gigabytes. The
3671
+ # default is 0. Both input data and the output model are stored on
3672
+ # disk, so the volume size must be large enough to hold both data
3673
+ # sets. If not specified or 0, Neptune ML selects a disk volume size
3674
+ # based on the recommendation generated in the data processing step.
3675
+ # @return [Integer]
3676
+ #
3677
+ # @!attribute [rw] subnets
3678
+ # The IDs of the subnets in the Neptune VPC. The default is None.
3679
+ # @return [Array<String>]
3680
+ #
3681
+ # @!attribute [rw] security_group_ids
3682
+ # The VPC security group IDs. The default is None.
3683
+ # @return [Array<String>]
3684
+ #
3685
+ # @!attribute [rw] volume_encryption_kms_key
3686
+ # The Amazon Key Management Service (KMS) key that SageMaker uses to
3687
+ # encrypt data on the storage volume attached to the ML compute
3688
+ # instances that run the training job. The default is None.
3689
+ # @return [String]
3690
+ #
3691
+ # @!attribute [rw] s3_output_encryption_kms_key
3692
+ # The Amazon Key Management Service (KMS) key that SageMaker uses to
3693
+ # encrypt the output of the processing job. The default is none.
3694
+ # @return [String]
3695
+ #
3696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLModelTransformJobInput AWS API Documentation
3697
+ #
3698
+ class StartMLModelTransformJobInput < Struct.new(
3699
+ :id,
3700
+ :data_processing_job_id,
3701
+ :ml_model_training_job_id,
3702
+ :training_job_name,
3703
+ :model_transform_output_s3_location,
3704
+ :sagemaker_iam_role_arn,
3705
+ :neptune_iam_role_arn,
3706
+ :custom_model_transform_parameters,
3707
+ :base_processing_instance_type,
3708
+ :base_processing_instance_volume_size_in_gb,
3709
+ :subnets,
3710
+ :security_group_ids,
3711
+ :volume_encryption_kms_key,
3712
+ :s3_output_encryption_kms_key)
3713
+ SENSITIVE = []
3714
+ include Aws::Structure
3715
+ end
3716
+
3717
+ # @!attribute [rw] id
3718
+ # The unique ID of the new model transform job.
3719
+ # @return [String]
3720
+ #
3721
+ # @!attribute [rw] arn
3722
+ # The ARN of the model transform job.
3723
+ # @return [String]
3724
+ #
3725
+ # @!attribute [rw] creation_time_in_millis
3726
+ # The creation time of the model transform job, in milliseconds.
3727
+ # @return [Integer]
3728
+ #
3729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StartMLModelTransformJobOutput AWS API Documentation
3730
+ #
3731
+ class StartMLModelTransformJobOutput < Struct.new(
3732
+ :id,
3733
+ :arn,
3734
+ :creation_time_in_millis)
3735
+ SENSITIVE = []
3736
+ include Aws::Structure
3737
+ end
3738
+
3739
+ # Contains statistics information. The DFE engine uses information about
3740
+ # the data in your Neptune graph to make effective trade-offs when
3741
+ # planning query execution. This information takes the form of
3742
+ # statistics that include so-called characteristic sets and predicate
3743
+ # statistics that can guide query planning. See [Managing statistics for
3744
+ # the Neptune DFE to use][1].
3745
+ #
3746
+ #
3747
+ #
3748
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html
3749
+ #
3750
+ # @!attribute [rw] auto_compute
3751
+ # Indicates whether or not automatic statistics generation is enabled.
3752
+ # @return [Boolean]
3753
+ #
3754
+ # @!attribute [rw] active
3755
+ # Indicates whether or not DFE statistics generation is enabled at
3756
+ # all.
3757
+ # @return [Boolean]
3758
+ #
3759
+ # @!attribute [rw] statistics_id
3760
+ # Reports the ID of the current statistics generation run. A value of
3761
+ # -1 indicates that no statistics have been generated.
3762
+ # @return [String]
3763
+ #
3764
+ # @!attribute [rw] date
3765
+ # The UTC time at which DFE statistics have most recently been
3766
+ # generated.
3767
+ # @return [Time]
3768
+ #
3769
+ # @!attribute [rw] note
3770
+ # A note about problems in the case where statistics are invalid.
3771
+ # @return [String]
3772
+ #
3773
+ # @!attribute [rw] signature_info
3774
+ # A StatisticsSummary structure that contains:
3775
+ #
3776
+ # * `signatureCount` - The total number of signatures across all
3777
+ # characteristic sets.
3778
+ #
3779
+ # * `instanceCount` - The total number of characteristic-set
3780
+ # instances.
3781
+ #
3782
+ # * `predicateCount` - The total number of unique predicates.
3783
+ # @return [Types::StatisticsSummary]
3784
+ #
3785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/Statistics AWS API Documentation
3786
+ #
3787
+ class Statistics < Struct.new(
3788
+ :auto_compute,
3789
+ :active,
3790
+ :statistics_id,
3791
+ :date,
3792
+ :note,
3793
+ :signature_info)
3794
+ SENSITIVE = []
3795
+ include Aws::Structure
3796
+ end
3797
+
3798
+ # Raised when statistics needed to satisfy a request are not available.
3799
+ #
3800
+ # @!attribute [rw] detailed_message
3801
+ # A detailed message describing the problem.
3802
+ # @return [String]
3803
+ #
3804
+ # @!attribute [rw] request_id
3805
+ # The ID of the request in question.
3806
+ # @return [String]
3807
+ #
3808
+ # @!attribute [rw] code
3809
+ # The HTTP status code returned with the exception.
3810
+ # @return [String]
3811
+ #
3812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StatisticsNotAvailableException AWS API Documentation
3813
+ #
3814
+ class StatisticsNotAvailableException < Struct.new(
3815
+ :detailed_message,
3816
+ :request_id,
3817
+ :code)
3818
+ SENSITIVE = []
3819
+ include Aws::Structure
3820
+ end
3821
+
3822
+ # Information about the characteristic sets generated in the statistics.
3823
+ #
3824
+ # @!attribute [rw] signature_count
3825
+ # The total number of signatures across all characteristic sets.
3826
+ # @return [Integer]
3827
+ #
3828
+ # @!attribute [rw] instance_count
3829
+ # The total number of characteristic-set instances.
3830
+ # @return [Integer]
3831
+ #
3832
+ # @!attribute [rw] predicate_count
3833
+ # The total number of unique predicates.
3834
+ # @return [Integer]
3835
+ #
3836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StatisticsSummary AWS API Documentation
3837
+ #
3838
+ class StatisticsSummary < Struct.new(
3839
+ :signature_count,
3840
+ :instance_count,
3841
+ :predicate_count)
3842
+ SENSITIVE = []
3843
+ include Aws::Structure
3844
+ end
3845
+
3846
+ # Raised when stream records requested by a query cannot be found.
3847
+ #
3848
+ # @!attribute [rw] detailed_message
3849
+ # A detailed message describing the problem.
3850
+ # @return [String]
3851
+ #
3852
+ # @!attribute [rw] request_id
3853
+ # The ID of the request in question.
3854
+ # @return [String]
3855
+ #
3856
+ # @!attribute [rw] code
3857
+ # The HTTP status code returned with the exception.
3858
+ # @return [String]
3859
+ #
3860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/StreamRecordsNotFoundException AWS API Documentation
3861
+ #
3862
+ class StreamRecordsNotFoundException < Struct.new(
3863
+ :detailed_message,
3864
+ :request_id,
3865
+ :code)
3866
+ SENSITIVE = []
3867
+ include Aws::Structure
3868
+ end
3869
+
3870
+ # A subject structure.
3871
+ #
3872
+ # @!attribute [rw] count
3873
+ # Number of occurrences of this specific structure.
3874
+ # @return [Integer]
3875
+ #
3876
+ # @!attribute [rw] predicates
3877
+ # A list of predicates present in this specific structure.
3878
+ # @return [Array<String>]
3879
+ #
3880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/SubjectStructure AWS API Documentation
3881
+ #
3882
+ class SubjectStructure < Struct.new(
3883
+ :count,
3884
+ :predicates)
3885
+ SENSITIVE = []
3886
+ include Aws::Structure
3887
+ end
3888
+
3889
+ # Raised when the rate of requests exceeds the maximum throughput.
3890
+ # Requests can be retried after encountering this exception.
3891
+ #
3892
+ # @!attribute [rw] detailed_message
3893
+ # A detailed message describing the problem.
3894
+ # @return [String]
3895
+ #
3896
+ # @!attribute [rw] request_id
3897
+ # The ID of the request that could not be processed for this reason.
3898
+ # @return [String]
3899
+ #
3900
+ # @!attribute [rw] code
3901
+ # The HTTP status code returned with the exception.
3902
+ # @return [String]
3903
+ #
3904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/ThrottlingException AWS API Documentation
3905
+ #
3906
+ class ThrottlingException < Struct.new(
3907
+ :detailed_message,
3908
+ :request_id,
3909
+ :code)
3910
+ SENSITIVE = []
3911
+ include Aws::Structure
3912
+ end
3913
+
3914
+ # Raised when the an operation exceeds the time limit allowed for it.
3915
+ #
3916
+ # @!attribute [rw] detailed_message
3917
+ # A detailed message describing the problem.
3918
+ # @return [String]
3919
+ #
3920
+ # @!attribute [rw] request_id
3921
+ # The ID of the request that could not be processed for this reason.
3922
+ # @return [String]
3923
+ #
3924
+ # @!attribute [rw] code
3925
+ # The HTTP status code returned with the exception.
3926
+ # @return [String]
3927
+ #
3928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/TimeLimitExceededException AWS API Documentation
3929
+ #
3930
+ class TimeLimitExceededException < Struct.new(
3931
+ :detailed_message,
3932
+ :request_id,
3933
+ :code)
3934
+ SENSITIVE = []
3935
+ include Aws::Structure
3936
+ end
3937
+
3938
+ # Raised when the number of requests being processed exceeds the limit.
3939
+ #
3940
+ # @!attribute [rw] detailed_message
3941
+ # A detailed message describing the problem.
3942
+ # @return [String]
3943
+ #
3944
+ # @!attribute [rw] request_id
3945
+ # The ID of the request that could not be processed for this reason.
3946
+ # @return [String]
3947
+ #
3948
+ # @!attribute [rw] code
3949
+ # The HTTP status code returned with the exception.
3950
+ # @return [String]
3951
+ #
3952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/TooManyRequestsException AWS API Documentation
3953
+ #
3954
+ class TooManyRequestsException < Struct.new(
3955
+ :detailed_message,
3956
+ :request_id,
3957
+ :code)
3958
+ SENSITIVE = []
3959
+ include Aws::Structure
3960
+ end
3961
+
3962
+ # Raised when a request attempts to initiate an operation that is not
3963
+ # supported.
3964
+ #
3965
+ # @!attribute [rw] detailed_message
3966
+ # A detailed message describing the problem.
3967
+ # @return [String]
3968
+ #
3969
+ # @!attribute [rw] request_id
3970
+ # The ID of the request in question.
3971
+ # @return [String]
3972
+ #
3973
+ # @!attribute [rw] code
3974
+ # The HTTP status code returned with the exception.
3975
+ # @return [String]
3976
+ #
3977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/UnsupportedOperationException AWS API Documentation
3978
+ #
3979
+ class UnsupportedOperationException < Struct.new(
3980
+ :detailed_message,
3981
+ :request_id,
3982
+ :code)
3983
+ SENSITIVE = []
3984
+ include Aws::Structure
3985
+ end
3986
+
3987
+ end
3988
+ end