aws-sdk-neptunegraph 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1704 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
35
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
36
+
37
+ Aws::Plugins::GlobalConfiguration.add_identifier(:neptunegraph)
38
+
39
+ module Aws::NeptuneGraph
40
+ # An API client for NeptuneGraph. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::NeptuneGraph::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :neptunegraph
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::JsonvalueConverter)
76
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
78
+ add_plugin(Aws::Plugins::TransferEncoding)
79
+ add_plugin(Aws::Plugins::HttpChecksum)
80
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
81
+ add_plugin(Aws::Plugins::RequestCompression)
82
+ add_plugin(Aws::Plugins::DefaultsMode)
83
+ add_plugin(Aws::Plugins::RecursionDetection)
84
+ add_plugin(Aws::Plugins::Sign)
85
+ add_plugin(Aws::Plugins::Protocols::RestJson)
86
+ add_plugin(Aws::NeptuneGraph::Plugins::Endpoints)
87
+
88
+ # @overload initialize(options)
89
+ # @param [Hash] options
90
+ # @option options [required, Aws::CredentialProvider] :credentials
91
+ # Your AWS credentials. This can be an instance of any one of the
92
+ # following classes:
93
+ #
94
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
95
+ # credentials.
96
+ #
97
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
98
+ # shared file, such as `~/.aws/config`.
99
+ #
100
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
101
+ #
102
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
103
+ # assume a role after providing credentials via the web.
104
+ #
105
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
106
+ # access token generated from `aws login`.
107
+ #
108
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
109
+ # process that outputs to stdout.
110
+ #
111
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
112
+ # from an EC2 IMDS on an EC2 instance.
113
+ #
114
+ # * `Aws::ECSCredentials` - Used for loading credentials from
115
+ # instances running in ECS.
116
+ #
117
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
118
+ # from the Cognito Identity service.
119
+ #
120
+ # When `:credentials` are not configured directly, the following
121
+ # locations will be searched for credentials:
122
+ #
123
+ # * `Aws.config[:credentials]`
124
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
125
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
126
+ # * `~/.aws/credentials`
127
+ # * `~/.aws/config`
128
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
129
+ # are very aggressive. Construct and pass an instance of
130
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
131
+ # enable retries and extended timeouts. Instance profile credential
132
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
133
+ # to true.
134
+ #
135
+ # @option options [required, String] :region
136
+ # The AWS region to connect to. The configured `:region` is
137
+ # used to determine the service `:endpoint`. When not passed,
138
+ # a default `:region` is searched for in the following locations:
139
+ #
140
+ # * `Aws.config[:region]`
141
+ # * `ENV['AWS_REGION']`
142
+ # * `ENV['AMAZON_REGION']`
143
+ # * `ENV['AWS_DEFAULT_REGION']`
144
+ # * `~/.aws/credentials`
145
+ # * `~/.aws/config`
146
+ #
147
+ # @option options [String] :access_key_id
148
+ #
149
+ # @option options [Boolean] :active_endpoint_cache (false)
150
+ # When set to `true`, a thread polling for endpoints will be running in
151
+ # the background every 60 secs (default). Defaults to `false`.
152
+ #
153
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
154
+ # Used only in `adaptive` retry mode. When true, the request will sleep
155
+ # until there is sufficent client side capacity to retry the request.
156
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
157
+ # not retry instead of sleeping.
158
+ #
159
+ # @option options [Boolean] :client_side_monitoring (false)
160
+ # When `true`, client-side metrics will be collected for all API requests from
161
+ # this client.
162
+ #
163
+ # @option options [String] :client_side_monitoring_client_id ("")
164
+ # Allows you to provide an identifier for this client which will be attached to
165
+ # all generated client side metrics. Defaults to an empty string.
166
+ #
167
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
168
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
169
+ # side monitoring agent is running on, where client metrics will be published via UDP.
170
+ #
171
+ # @option options [Integer] :client_side_monitoring_port (31000)
172
+ # Required for publishing client metrics. The port that the client side monitoring
173
+ # agent is running on, where client metrics will be published via UDP.
174
+ #
175
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
176
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
177
+ # will use the Client Side Monitoring Agent Publisher.
178
+ #
179
+ # @option options [Boolean] :convert_params (true)
180
+ # When `true`, an attempt is made to coerce request parameters into
181
+ # the required types.
182
+ #
183
+ # @option options [Boolean] :correct_clock_skew (true)
184
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
185
+ # a clock skew correction and retry requests with skewed client clocks.
186
+ #
187
+ # @option options [String] :defaults_mode ("legacy")
188
+ # See {Aws::DefaultsModeConfiguration} for a list of the
189
+ # accepted modes and the configuration defaults that are included.
190
+ #
191
+ # @option options [Boolean] :disable_host_prefix_injection (false)
192
+ # Set to true to disable SDK automatically adding host prefix
193
+ # to default service endpoint when available.
194
+ #
195
+ # @option options [Boolean] :disable_request_compression (false)
196
+ # When set to 'true' the request body will not be compressed
197
+ # for supported operations.
198
+ #
199
+ # @option options [String] :endpoint
200
+ # The client endpoint is normally constructed from the `:region`
201
+ # option. You should only configure an `:endpoint` when connecting
202
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
205
+ # Used for the maximum size limit of the LRU cache storing endpoints data
206
+ # for endpoint discovery enabled operations. Defaults to 1000.
207
+ #
208
+ # @option options [Integer] :endpoint_cache_max_threads (10)
209
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
210
+ #
211
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
212
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
213
+ # Use this option to config the time interval in seconds for making
214
+ # requests fetching endpoints information. Defaults to 60 sec.
215
+ #
216
+ # @option options [Boolean] :endpoint_discovery (false)
217
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
218
+ #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
223
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
224
+ # The log formatter.
225
+ #
226
+ # @option options [Symbol] :log_level (:info)
227
+ # The log level to send messages to the `:logger` at.
228
+ #
229
+ # @option options [Logger] :logger
230
+ # The Logger instance to send log messages to. If this option
231
+ # is not set, logging will be disabled.
232
+ #
233
+ # @option options [Integer] :max_attempts (3)
234
+ # An integer representing the maximum number attempts that will be made for
235
+ # a single request, including the initial attempt. For example,
236
+ # setting this value to 5 will result in a request being retried up to
237
+ # 4 times. Used in `standard` and `adaptive` retry modes.
238
+ #
239
+ # @option options [String] :profile ("default")
240
+ # Used when loading credentials from the shared credentials file
241
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
242
+ #
243
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
244
+ # The minimum size in bytes that triggers compression for request
245
+ # bodies. The value must be non-negative integer value between 0
246
+ # and 10485780 bytes inclusive.
247
+ #
248
+ # @option options [Proc] :retry_backoff
249
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
250
+ # This option is only used in the `legacy` retry mode.
251
+ #
252
+ # @option options [Float] :retry_base_delay (0.3)
253
+ # The base delay in seconds used by the default backoff function. This option
254
+ # is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Symbol] :retry_jitter (:none)
257
+ # A delay randomiser function used by the default backoff function.
258
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
259
+ # otherwise a Proc that takes and returns a number. This option is only used
260
+ # in the `legacy` retry mode.
261
+ #
262
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
263
+ #
264
+ # @option options [Integer] :retry_limit (3)
265
+ # The maximum number of times to retry failed requests. Only
266
+ # ~ 500 level server errors and certain ~ 400 level client errors
267
+ # are retried. Generally, these are throttling errors, data
268
+ # checksum errors, networking errors, timeout errors, auth errors,
269
+ # endpoint discovery, and errors from expired credentials.
270
+ # This option is only used in the `legacy` retry mode.
271
+ #
272
+ # @option options [Integer] :retry_max_delay (0)
273
+ # The maximum number of seconds to delay between retries (0 for no limit)
274
+ # used by the default backoff function. This option is only used in the
275
+ # `legacy` retry mode.
276
+ #
277
+ # @option options [String] :retry_mode ("legacy")
278
+ # Specifies which retry algorithm to use. Values are:
279
+ #
280
+ # * `legacy` - The pre-existing retry behavior. This is default value if
281
+ # no retry mode is provided.
282
+ #
283
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
284
+ # This includes support for retry quotas, which limit the number of
285
+ # unsuccessful retries a client can make.
286
+ #
287
+ # * `adaptive` - An experimental retry mode that includes all the
288
+ # functionality of `standard` mode along with automatic client side
289
+ # throttling. This is a provisional mode that may change behavior
290
+ # in the future.
291
+ #
292
+ #
293
+ # @option options [String] :sdk_ua_app_id
294
+ # A unique and opaque application ID that is appended to the
295
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
+ # maximum length of 50.
297
+ #
298
+ # @option options [String] :secret_access_key
299
+ #
300
+ # @option options [String] :session_token
301
+ #
302
+ # @option options [Boolean] :stub_responses (false)
303
+ # Causes the client to return stubbed responses. By default
304
+ # fake responses are generated and returned. You can specify
305
+ # the response data to return or errors to raise by calling
306
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
307
+ #
308
+ # ** Please note ** When response stubbing is enabled, no HTTP
309
+ # requests are made, and retries are disabled.
310
+ #
311
+ # @option options [Aws::TokenProvider] :token_provider
312
+ # A Bearer Token Provider. This can be an instance of any one of the
313
+ # following classes:
314
+ #
315
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
316
+ # tokens.
317
+ #
318
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
319
+ # access token generated from `aws login`.
320
+ #
321
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
322
+ # will be used to search for tokens configured for your profile in shared configuration files.
323
+ #
324
+ # @option options [Boolean] :use_dualstack_endpoint
325
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
326
+ # will be used if available.
327
+ #
328
+ # @option options [Boolean] :use_fips_endpoint
329
+ # When set to `true`, fips compatible endpoints will be used if available.
330
+ # When a `fips` region is used, the region is normalized and this config
331
+ # is set to `true`.
332
+ #
333
+ # @option options [Boolean] :validate_params (true)
334
+ # When `true`, request parameters are validated before
335
+ # sending the request.
336
+ #
337
+ # @option options [Aws::NeptuneGraph::EndpointProvider] :endpoint_provider
338
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::NeptuneGraph::EndpointParameters`
339
+ #
340
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
+ # requests through. Formatted like 'http://proxy.com:123'.
342
+ #
343
+ # @option options [Float] :http_open_timeout (15) The number of
344
+ # seconds to wait when opening a HTTP session before raising a
345
+ # `Timeout::Error`.
346
+ #
347
+ # @option options [Float] :http_read_timeout (60) The default
348
+ # number of seconds to wait for response data. This value can
349
+ # safely be set per-request on the session.
350
+ #
351
+ # @option options [Float] :http_idle_timeout (5) The number of
352
+ # seconds a connection is allowed to sit idle before it is
353
+ # considered stale. Stale connections are closed and removed
354
+ # from the pool before making a request.
355
+ #
356
+ # @option options [Float] :http_continue_timeout (1) The number of
357
+ # seconds to wait for a 100-continue response before sending the
358
+ # request body. This option has no effect unless the request has
359
+ # "Expect" header set to "100-continue". Defaults to `nil` which
360
+ # disables this behaviour. This value can safely be set per
361
+ # request on the session.
362
+ #
363
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
+ # in seconds.
365
+ #
366
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
367
+ # HTTP debug output will be sent to the `:logger`.
368
+ #
369
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
+ # SSL peer certificates are verified when establishing a
371
+ # connection.
372
+ #
373
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
374
+ # certificate authority bundle file that should be used when
375
+ # verifying peer certificates. If you do not pass
376
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
+ # will be used if available.
378
+ #
379
+ # @option options [String] :ssl_ca_directory Full path of the
380
+ # directory that contains the unbundled SSL certificate
381
+ # authority files for verifying peer certificates. If you do
382
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
+ # system default will be used if available.
384
+ #
385
+ def initialize(*args)
386
+ super
387
+ end
388
+
389
+ # @!group API Operations
390
+
391
+ # Deletes the specified import task
392
+ #
393
+ # @option params [required, String] :task_identifier
394
+ # The unique identifier of the import task.
395
+ #
396
+ # @return [Types::CancelImportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
397
+ #
398
+ # * {Types::CancelImportTaskOutput#graph_id #graph_id} => String
399
+ # * {Types::CancelImportTaskOutput#task_id #task_id} => String
400
+ # * {Types::CancelImportTaskOutput#source #source} => String
401
+ # * {Types::CancelImportTaskOutput#format #format} => String
402
+ # * {Types::CancelImportTaskOutput#role_arn #role_arn} => String
403
+ # * {Types::CancelImportTaskOutput#status #status} => String
404
+ #
405
+ # @example Request syntax with placeholder values
406
+ #
407
+ # resp = client.cancel_import_task({
408
+ # task_identifier: "TaskId", # required
409
+ # })
410
+ #
411
+ # @example Response structure
412
+ #
413
+ # resp.graph_id #=> String
414
+ # resp.task_id #=> String
415
+ # resp.source #=> String
416
+ # resp.format #=> String, one of "CSV", "OPEN_CYPHER"
417
+ # resp.role_arn #=> String
418
+ # resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CancelImportTask AWS API Documentation
421
+ #
422
+ # @overload cancel_import_task(params = {})
423
+ # @param [Hash] params ({})
424
+ def cancel_import_task(params = {}, options = {})
425
+ req = build_request(:cancel_import_task, params)
426
+ req.send_request(options)
427
+ end
428
+
429
+ # Creates a new Neptune Analytics graph.
430
+ #
431
+ # @option params [required, String] :graph_name
432
+ # A name for the new Neptune Analytics graph to be created.
433
+ #
434
+ # The name must contain from 1 to 63 letters, numbers, or hyphens, and
435
+ # its first character must be a letter. It cannot end with a hyphen or
436
+ # contain two consecutive hyphens.
437
+ #
438
+ # @option params [Hash<String,String>] :tags
439
+ # Adds metadata tags to the new graph. These tags can also be used with
440
+ # cost allocation reporting, or used in a Condition statement in an IAM
441
+ # policy.
442
+ #
443
+ # @option params [Boolean] :public_connectivity
444
+ # Specifies whether or not the graph can be reachable over the internet.
445
+ # All access to graphs IAM authenticated. (`true` to enable, or `false`
446
+ # to disable.
447
+ #
448
+ # @option params [String] :kms_key_identifier
449
+ # Specifies a KMS key to use to encrypt data in the new graph.
450
+ #
451
+ # @option params [Types::VectorSearchConfiguration] :vector_search_configuration
452
+ # Specifies the number of dimensions for vector embeddings that will be
453
+ # loaded into the graph. The value is specified as `dimension=`value.
454
+ # Max = 65,535
455
+ #
456
+ # @option params [Integer] :replica_count
457
+ # The number of replicas in other AZs. Min =0, Max = 2, Default =1
458
+ #
459
+ # @option params [Boolean] :deletion_protection
460
+ # Indicates whether or not to enable deletion protection on the graph.
461
+ # The graph can’t be deleted when deletion protection is enabled.
462
+ # (`true` or `false`).
463
+ #
464
+ # @option params [required, Integer] :provisioned_memory
465
+ # The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to
466
+ # use for the graph. Min = 128
467
+ #
468
+ # @return [Types::CreateGraphOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
469
+ #
470
+ # * {Types::CreateGraphOutput#id #id} => String
471
+ # * {Types::CreateGraphOutput#name #name} => String
472
+ # * {Types::CreateGraphOutput#arn #arn} => String
473
+ # * {Types::CreateGraphOutput#status #status} => String
474
+ # * {Types::CreateGraphOutput#status_reason #status_reason} => String
475
+ # * {Types::CreateGraphOutput#create_time #create_time} => Time
476
+ # * {Types::CreateGraphOutput#provisioned_memory #provisioned_memory} => Integer
477
+ # * {Types::CreateGraphOutput#endpoint #endpoint} => String
478
+ # * {Types::CreateGraphOutput#public_connectivity #public_connectivity} => Boolean
479
+ # * {Types::CreateGraphOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
480
+ # * {Types::CreateGraphOutput#replica_count #replica_count} => Integer
481
+ # * {Types::CreateGraphOutput#kms_key_identifier #kms_key_identifier} => String
482
+ # * {Types::CreateGraphOutput#source_snapshot_id #source_snapshot_id} => String
483
+ # * {Types::CreateGraphOutput#deletion_protection #deletion_protection} => Boolean
484
+ # * {Types::CreateGraphOutput#build_number #build_number} => String
485
+ #
486
+ # @example Request syntax with placeholder values
487
+ #
488
+ # resp = client.create_graph({
489
+ # graph_name: "GraphName", # required
490
+ # tags: {
491
+ # "TagKey" => "TagValue",
492
+ # },
493
+ # public_connectivity: false,
494
+ # kms_key_identifier: "KmsKeyArn",
495
+ # vector_search_configuration: {
496
+ # dimension: 1, # required
497
+ # },
498
+ # replica_count: 1,
499
+ # deletion_protection: false,
500
+ # provisioned_memory: 1, # required
501
+ # })
502
+ #
503
+ # @example Response structure
504
+ #
505
+ # resp.id #=> String
506
+ # resp.name #=> String
507
+ # resp.arn #=> String
508
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
509
+ # resp.status_reason #=> String
510
+ # resp.create_time #=> Time
511
+ # resp.provisioned_memory #=> Integer
512
+ # resp.endpoint #=> String
513
+ # resp.public_connectivity #=> Boolean
514
+ # resp.vector_search_configuration.dimension #=> Integer
515
+ # resp.replica_count #=> Integer
516
+ # resp.kms_key_identifier #=> String
517
+ # resp.source_snapshot_id #=> String
518
+ # resp.deletion_protection #=> Boolean
519
+ # resp.build_number #=> String
520
+ #
521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CreateGraph AWS API Documentation
522
+ #
523
+ # @overload create_graph(params = {})
524
+ # @param [Hash] params ({})
525
+ def create_graph(params = {}, options = {})
526
+ req = build_request(:create_graph, params)
527
+ req.send_request(options)
528
+ end
529
+
530
+ # Creates a snapshot of the specific graph.
531
+ #
532
+ # @option params [required, String] :graph_identifier
533
+ # The unique identifier of the Neptune Analytics graph.
534
+ #
535
+ # @option params [required, String] :snapshot_name
536
+ # The snapshot name. For example: `my-snapshot-1`.
537
+ #
538
+ # The name must contain from 1 to 63 letters, numbers, or hyphens, and
539
+ # its first character must be a letter. It cannot end with a hyphen or
540
+ # contain two consecutive hyphens.
541
+ #
542
+ # @option params [Hash<String,String>] :tags
543
+ # Adds metadata tags to the new graph. These tags can also be used with
544
+ # cost allocation reporting, or used in a Condition statement in an IAM
545
+ # policy.
546
+ #
547
+ # @return [Types::CreateGraphSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
548
+ #
549
+ # * {Types::CreateGraphSnapshotOutput#id #id} => String
550
+ # * {Types::CreateGraphSnapshotOutput#name #name} => String
551
+ # * {Types::CreateGraphSnapshotOutput#arn #arn} => String
552
+ # * {Types::CreateGraphSnapshotOutput#source_graph_id #source_graph_id} => String
553
+ # * {Types::CreateGraphSnapshotOutput#snapshot_create_time #snapshot_create_time} => Time
554
+ # * {Types::CreateGraphSnapshotOutput#status #status} => String
555
+ # * {Types::CreateGraphSnapshotOutput#kms_key_identifier #kms_key_identifier} => String
556
+ #
557
+ # @example Request syntax with placeholder values
558
+ #
559
+ # resp = client.create_graph_snapshot({
560
+ # graph_identifier: "GraphIdentifier", # required
561
+ # snapshot_name: "SnapshotName", # required
562
+ # tags: {
563
+ # "TagKey" => "TagValue",
564
+ # },
565
+ # })
566
+ #
567
+ # @example Response structure
568
+ #
569
+ # resp.id #=> String
570
+ # resp.name #=> String
571
+ # resp.arn #=> String
572
+ # resp.source_graph_id #=> String
573
+ # resp.snapshot_create_time #=> Time
574
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
575
+ # resp.kms_key_identifier #=> String
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CreateGraphSnapshot AWS API Documentation
578
+ #
579
+ # @overload create_graph_snapshot(params = {})
580
+ # @param [Hash] params ({})
581
+ def create_graph_snapshot(params = {}, options = {})
582
+ req = build_request(:create_graph_snapshot, params)
583
+ req.send_request(options)
584
+ end
585
+
586
+ # Creates a new Neptune Analytics graph and imports data into it, either
587
+ # from Amazon Simple Storage Service (S3) or from a Neptune database or
588
+ # a Neptune database snapshot.
589
+ #
590
+ # The data can be loaded from files in S3 that in either the [Gremlin
591
+ # CSV format][1] or the [openCypher load format][2].
592
+ #
593
+ #
594
+ #
595
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html
596
+ # [2]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
597
+ #
598
+ # @option params [required, String] :graph_name
599
+ # A name for the new Neptune Analytics graph to be created.
600
+ #
601
+ # The name must contain from 1 to 63 letters, numbers, or hyphens, and
602
+ # its first character must be a letter. It cannot end with a hyphen or
603
+ # contain two consecutive hyphens.
604
+ #
605
+ # @option params [Hash<String,String>] :tags
606
+ # Adds metadata tags to the new graph. These tags can also be used with
607
+ # cost allocation reporting, or used in a Condition statement in an IAM
608
+ # policy.
609
+ #
610
+ # @option params [Boolean] :public_connectivity
611
+ # Specifies whether or not the graph can be reachable over the internet.
612
+ # All access to graphs IAM authenticated. (`true` to enable, or `false`
613
+ # to disable.
614
+ #
615
+ # @option params [String] :kms_key_identifier
616
+ # Specifies a KMS key to use to encrypt data imported into the new
617
+ # graph.
618
+ #
619
+ # @option params [Types::VectorSearchConfiguration] :vector_search_configuration
620
+ # Specifies the number of dimensions for vector embeddings that will be
621
+ # loaded into the graph. The value is specified as `dimension=`value.
622
+ # Max = 65,535
623
+ #
624
+ # @option params [Integer] :replica_count
625
+ # The number of replicas in other AZs to provision on the new graph
626
+ # after import. Default = 0, Min = 0, Max = 2.
627
+ #
628
+ # @option params [Boolean] :deletion_protection
629
+ # Indicates whether or not to enable deletion protection on the graph.
630
+ # The graph can’t be deleted when deletion protection is enabled.
631
+ # (`true` or `false`).
632
+ #
633
+ # @option params [Types::ImportOptions] :import_options
634
+ # Contains options for controlling the import process. For example, if
635
+ # the `failOnError` key is set to `false`, the import skips problem data
636
+ # and attempts to continue (whereas if set to `true`, the default, or if
637
+ # omitted, the import operation halts immediately when an error is
638
+ # encountered.
639
+ #
640
+ # @option params [Integer] :max_provisioned_memory
641
+ # The maximum provisioned memory-optimized Neptune Capacity Units
642
+ # (m-NCUs) to use for the graph. Default: 1024, or the approved upper
643
+ # limit for your account.
644
+ #
645
+ # If both the minimum and maximum values are specified, the max of the
646
+ # `min-provisioned-memory` and `max-provisioned memory` is used to
647
+ # create the graph. If neither value is specified 128 m-NCUs are used.
648
+ #
649
+ # @option params [Integer] :min_provisioned_memory
650
+ # The minimum provisioned memory-optimized Neptune Capacity Units
651
+ # (m-NCUs) to use for the graph. Default: 128
652
+ #
653
+ # @option params [Boolean] :fail_on_error
654
+ # If set to `true`, the task halts when an import error is encountered.
655
+ # If set to `false`, the task skips the data that caused the error and
656
+ # continues if possible.
657
+ #
658
+ # @option params [required, String] :source
659
+ # A URL identifying to the location of the data to be imported. This can
660
+ # be an Amazon S3 path, or can point to a Neptune database endpoint or
661
+ # snapshot.
662
+ #
663
+ # @option params [String] :format
664
+ # Specifies the format of S3 data to be imported. Valid values are
665
+ # `CSV`, which identifies the [Gremlin CSV format][1] or `OPENCYPHER`,
666
+ # which identies the [openCypher load format][2].
667
+ #
668
+ #
669
+ #
670
+ # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html
671
+ # [2]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
672
+ #
673
+ # @option params [required, String] :role_arn
674
+ # The ARN of the IAM role that will allow access to the data that is to
675
+ # be imported.
676
+ #
677
+ # @return [Types::CreateGraphUsingImportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
678
+ #
679
+ # * {Types::CreateGraphUsingImportTaskOutput#graph_id #graph_id} => String
680
+ # * {Types::CreateGraphUsingImportTaskOutput#task_id #task_id} => String
681
+ # * {Types::CreateGraphUsingImportTaskOutput#source #source} => String
682
+ # * {Types::CreateGraphUsingImportTaskOutput#format #format} => String
683
+ # * {Types::CreateGraphUsingImportTaskOutput#role_arn #role_arn} => String
684
+ # * {Types::CreateGraphUsingImportTaskOutput#status #status} => String
685
+ # * {Types::CreateGraphUsingImportTaskOutput#import_options #import_options} => Types::ImportOptions
686
+ #
687
+ # @example Request syntax with placeholder values
688
+ #
689
+ # resp = client.create_graph_using_import_task({
690
+ # graph_name: "GraphName", # required
691
+ # tags: {
692
+ # "TagKey" => "TagValue",
693
+ # },
694
+ # public_connectivity: false,
695
+ # kms_key_identifier: "KmsKeyArn",
696
+ # vector_search_configuration: {
697
+ # dimension: 1, # required
698
+ # },
699
+ # replica_count: 1,
700
+ # deletion_protection: false,
701
+ # import_options: {
702
+ # neptune: {
703
+ # s3_export_path: "NeptuneImportOptionsS3ExportPathString", # required
704
+ # s3_export_kms_key_id: "NeptuneImportOptionsS3ExportKmsKeyIdString", # required
705
+ # preserve_default_vertex_labels: false,
706
+ # preserve_edge_ids: false,
707
+ # },
708
+ # },
709
+ # max_provisioned_memory: 1,
710
+ # min_provisioned_memory: 1,
711
+ # fail_on_error: false,
712
+ # source: "String", # required
713
+ # format: "CSV", # accepts CSV, OPEN_CYPHER
714
+ # role_arn: "RoleArn", # required
715
+ # })
716
+ #
717
+ # @example Response structure
718
+ #
719
+ # resp.graph_id #=> String
720
+ # resp.task_id #=> String
721
+ # resp.source #=> String
722
+ # resp.format #=> String, one of "CSV", "OPEN_CYPHER"
723
+ # resp.role_arn #=> String
724
+ # resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
725
+ # resp.import_options.neptune.s3_export_path #=> String
726
+ # resp.import_options.neptune.s3_export_kms_key_id #=> String
727
+ # resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
728
+ # resp.import_options.neptune.preserve_edge_ids #=> Boolean
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CreateGraphUsingImportTask AWS API Documentation
731
+ #
732
+ # @overload create_graph_using_import_task(params = {})
733
+ # @param [Hash] params ({})
734
+ def create_graph_using_import_task(params = {}, options = {})
735
+ req = build_request(:create_graph_using_import_task, params)
736
+ req.send_request(options)
737
+ end
738
+
739
+ # Create a private graph endpoint to allow private access from to the
740
+ # graph from within a VPC. You can attach security groups to the private
741
+ # graph endpoint. VPC endpoint charges apply.
742
+ #
743
+ # @option params [required, String] :graph_identifier
744
+ # The unique identifier of the Neptune Analytics graph.
745
+ #
746
+ # @option params [String] :vpc_id
747
+ # The VPC in which the private graph endpoint needs to be created.
748
+ #
749
+ # @option params [Array<String>] :subnet_ids
750
+ # Subnets in which private graph endpoint ENIs are created.
751
+ #
752
+ # @option params [Array<String>] :vpc_security_group_ids
753
+ # Security groups to be attached to the private graph endpoint..
754
+ #
755
+ # @return [Types::CreatePrivateGraphEndpointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
756
+ #
757
+ # * {Types::CreatePrivateGraphEndpointOutput#vpc_id #vpc_id} => String
758
+ # * {Types::CreatePrivateGraphEndpointOutput#subnet_ids #subnet_ids} => Array&lt;String&gt;
759
+ # * {Types::CreatePrivateGraphEndpointOutput#status #status} => String
760
+ # * {Types::CreatePrivateGraphEndpointOutput#vpc_endpoint_id #vpc_endpoint_id} => String
761
+ #
762
+ # @example Request syntax with placeholder values
763
+ #
764
+ # resp = client.create_private_graph_endpoint({
765
+ # graph_identifier: "GraphIdentifier", # required
766
+ # vpc_id: "VpcId",
767
+ # subnet_ids: ["SubnetId"],
768
+ # vpc_security_group_ids: ["SecurityGroupId"],
769
+ # })
770
+ #
771
+ # @example Response structure
772
+ #
773
+ # resp.vpc_id #=> String
774
+ # resp.subnet_ids #=> Array
775
+ # resp.subnet_ids[0] #=> String
776
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
777
+ # resp.vpc_endpoint_id #=> String
778
+ #
779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint AWS API Documentation
780
+ #
781
+ # @overload create_private_graph_endpoint(params = {})
782
+ # @param [Hash] params ({})
783
+ def create_private_graph_endpoint(params = {}, options = {})
784
+ req = build_request(:create_private_graph_endpoint, params)
785
+ req.send_request(options)
786
+ end
787
+
788
+ # Deletes the specified graph. Graphs cannot be deleted if
789
+ # delete-protection is enabled.
790
+ #
791
+ # @option params [required, String] :graph_identifier
792
+ # The unique identifier of the Neptune Analytics graph.
793
+ #
794
+ # @option params [required, Boolean] :skip_snapshot
795
+ # Determines whether a final graph snapshot is created before the graph
796
+ # is deleted. If `true` is specified, no graph snapshot is created. If
797
+ # `false` is specified, a graph snapshot is created before the graph is
798
+ # deleted.
799
+ #
800
+ # @return [Types::DeleteGraphOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
801
+ #
802
+ # * {Types::DeleteGraphOutput#id #id} => String
803
+ # * {Types::DeleteGraphOutput#name #name} => String
804
+ # * {Types::DeleteGraphOutput#arn #arn} => String
805
+ # * {Types::DeleteGraphOutput#status #status} => String
806
+ # * {Types::DeleteGraphOutput#status_reason #status_reason} => String
807
+ # * {Types::DeleteGraphOutput#create_time #create_time} => Time
808
+ # * {Types::DeleteGraphOutput#provisioned_memory #provisioned_memory} => Integer
809
+ # * {Types::DeleteGraphOutput#endpoint #endpoint} => String
810
+ # * {Types::DeleteGraphOutput#public_connectivity #public_connectivity} => Boolean
811
+ # * {Types::DeleteGraphOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
812
+ # * {Types::DeleteGraphOutput#replica_count #replica_count} => Integer
813
+ # * {Types::DeleteGraphOutput#kms_key_identifier #kms_key_identifier} => String
814
+ # * {Types::DeleteGraphOutput#source_snapshot_id #source_snapshot_id} => String
815
+ # * {Types::DeleteGraphOutput#deletion_protection #deletion_protection} => Boolean
816
+ # * {Types::DeleteGraphOutput#build_number #build_number} => String
817
+ #
818
+ # @example Request syntax with placeholder values
819
+ #
820
+ # resp = client.delete_graph({
821
+ # graph_identifier: "GraphIdentifier", # required
822
+ # skip_snapshot: false, # required
823
+ # })
824
+ #
825
+ # @example Response structure
826
+ #
827
+ # resp.id #=> String
828
+ # resp.name #=> String
829
+ # resp.arn #=> String
830
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
831
+ # resp.status_reason #=> String
832
+ # resp.create_time #=> Time
833
+ # resp.provisioned_memory #=> Integer
834
+ # resp.endpoint #=> String
835
+ # resp.public_connectivity #=> Boolean
836
+ # resp.vector_search_configuration.dimension #=> Integer
837
+ # resp.replica_count #=> Integer
838
+ # resp.kms_key_identifier #=> String
839
+ # resp.source_snapshot_id #=> String
840
+ # resp.deletion_protection #=> Boolean
841
+ # resp.build_number #=> String
842
+ #
843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/DeleteGraph AWS API Documentation
844
+ #
845
+ # @overload delete_graph(params = {})
846
+ # @param [Hash] params ({})
847
+ def delete_graph(params = {}, options = {})
848
+ req = build_request(:delete_graph, params)
849
+ req.send_request(options)
850
+ end
851
+
852
+ # Deletes the specifed graph snapshot.
853
+ #
854
+ # @option params [required, String] :snapshot_identifier
855
+ # ID of the graph snapshot to be deleted.
856
+ #
857
+ # @return [Types::DeleteGraphSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
858
+ #
859
+ # * {Types::DeleteGraphSnapshotOutput#id #id} => String
860
+ # * {Types::DeleteGraphSnapshotOutput#name #name} => String
861
+ # * {Types::DeleteGraphSnapshotOutput#arn #arn} => String
862
+ # * {Types::DeleteGraphSnapshotOutput#source_graph_id #source_graph_id} => String
863
+ # * {Types::DeleteGraphSnapshotOutput#snapshot_create_time #snapshot_create_time} => Time
864
+ # * {Types::DeleteGraphSnapshotOutput#status #status} => String
865
+ # * {Types::DeleteGraphSnapshotOutput#kms_key_identifier #kms_key_identifier} => String
866
+ #
867
+ # @example Request syntax with placeholder values
868
+ #
869
+ # resp = client.delete_graph_snapshot({
870
+ # snapshot_identifier: "SnapshotIdentifier", # required
871
+ # })
872
+ #
873
+ # @example Response structure
874
+ #
875
+ # resp.id #=> String
876
+ # resp.name #=> String
877
+ # resp.arn #=> String
878
+ # resp.source_graph_id #=> String
879
+ # resp.snapshot_create_time #=> Time
880
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
881
+ # resp.kms_key_identifier #=> String
882
+ #
883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/DeleteGraphSnapshot AWS API Documentation
884
+ #
885
+ # @overload delete_graph_snapshot(params = {})
886
+ # @param [Hash] params ({})
887
+ def delete_graph_snapshot(params = {}, options = {})
888
+ req = build_request(:delete_graph_snapshot, params)
889
+ req.send_request(options)
890
+ end
891
+
892
+ # Deletes a private graph endpoint.
893
+ #
894
+ # @option params [required, String] :graph_identifier
895
+ # The unique identifier of the Neptune Analytics graph.
896
+ #
897
+ # @option params [required, String] :vpc_id
898
+ # The ID of the VPC where the private endpoint is located.
899
+ #
900
+ # @return [Types::DeletePrivateGraphEndpointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
901
+ #
902
+ # * {Types::DeletePrivateGraphEndpointOutput#vpc_id #vpc_id} => String
903
+ # * {Types::DeletePrivateGraphEndpointOutput#subnet_ids #subnet_ids} => Array&lt;String&gt;
904
+ # * {Types::DeletePrivateGraphEndpointOutput#status #status} => String
905
+ # * {Types::DeletePrivateGraphEndpointOutput#vpc_endpoint_id #vpc_endpoint_id} => String
906
+ #
907
+ # @example Request syntax with placeholder values
908
+ #
909
+ # resp = client.delete_private_graph_endpoint({
910
+ # graph_identifier: "GraphIdentifier", # required
911
+ # vpc_id: "VpcId", # required
912
+ # })
913
+ #
914
+ # @example Response structure
915
+ #
916
+ # resp.vpc_id #=> String
917
+ # resp.subnet_ids #=> Array
918
+ # resp.subnet_ids[0] #=> String
919
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
920
+ # resp.vpc_endpoint_id #=> String
921
+ #
922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint AWS API Documentation
923
+ #
924
+ # @overload delete_private_graph_endpoint(params = {})
925
+ # @param [Hash] params ({})
926
+ def delete_private_graph_endpoint(params = {}, options = {})
927
+ req = build_request(:delete_private_graph_endpoint, params)
928
+ req.send_request(options)
929
+ end
930
+
931
+ # Gets information about a specified graph.
932
+ #
933
+ # @option params [required, String] :graph_identifier
934
+ # The unique identifier of the Neptune Analytics graph.
935
+ #
936
+ # @return [Types::GetGraphOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
937
+ #
938
+ # * {Types::GetGraphOutput#id #id} => String
939
+ # * {Types::GetGraphOutput#name #name} => String
940
+ # * {Types::GetGraphOutput#arn #arn} => String
941
+ # * {Types::GetGraphOutput#status #status} => String
942
+ # * {Types::GetGraphOutput#status_reason #status_reason} => String
943
+ # * {Types::GetGraphOutput#create_time #create_time} => Time
944
+ # * {Types::GetGraphOutput#provisioned_memory #provisioned_memory} => Integer
945
+ # * {Types::GetGraphOutput#endpoint #endpoint} => String
946
+ # * {Types::GetGraphOutput#public_connectivity #public_connectivity} => Boolean
947
+ # * {Types::GetGraphOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
948
+ # * {Types::GetGraphOutput#replica_count #replica_count} => Integer
949
+ # * {Types::GetGraphOutput#kms_key_identifier #kms_key_identifier} => String
950
+ # * {Types::GetGraphOutput#source_snapshot_id #source_snapshot_id} => String
951
+ # * {Types::GetGraphOutput#deletion_protection #deletion_protection} => Boolean
952
+ # * {Types::GetGraphOutput#build_number #build_number} => String
953
+ #
954
+ # @example Request syntax with placeholder values
955
+ #
956
+ # resp = client.get_graph({
957
+ # graph_identifier: "GraphIdentifier", # required
958
+ # })
959
+ #
960
+ # @example Response structure
961
+ #
962
+ # resp.id #=> String
963
+ # resp.name #=> String
964
+ # resp.arn #=> String
965
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
966
+ # resp.status_reason #=> String
967
+ # resp.create_time #=> Time
968
+ # resp.provisioned_memory #=> Integer
969
+ # resp.endpoint #=> String
970
+ # resp.public_connectivity #=> Boolean
971
+ # resp.vector_search_configuration.dimension #=> Integer
972
+ # resp.replica_count #=> Integer
973
+ # resp.kms_key_identifier #=> String
974
+ # resp.source_snapshot_id #=> String
975
+ # resp.deletion_protection #=> Boolean
976
+ # resp.build_number #=> String
977
+ #
978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraph AWS API Documentation
979
+ #
980
+ # @overload get_graph(params = {})
981
+ # @param [Hash] params ({})
982
+ def get_graph(params = {}, options = {})
983
+ req = build_request(:get_graph, params)
984
+ req.send_request(options)
985
+ end
986
+
987
+ # Retrieves a specified graph snapshot.
988
+ #
989
+ # @option params [required, String] :snapshot_identifier
990
+ # The ID of the snapshot to retrieve.
991
+ #
992
+ # @return [Types::GetGraphSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
993
+ #
994
+ # * {Types::GetGraphSnapshotOutput#id #id} => String
995
+ # * {Types::GetGraphSnapshotOutput#name #name} => String
996
+ # * {Types::GetGraphSnapshotOutput#arn #arn} => String
997
+ # * {Types::GetGraphSnapshotOutput#source_graph_id #source_graph_id} => String
998
+ # * {Types::GetGraphSnapshotOutput#snapshot_create_time #snapshot_create_time} => Time
999
+ # * {Types::GetGraphSnapshotOutput#status #status} => String
1000
+ # * {Types::GetGraphSnapshotOutput#kms_key_identifier #kms_key_identifier} => String
1001
+ #
1002
+ # @example Request syntax with placeholder values
1003
+ #
1004
+ # resp = client.get_graph_snapshot({
1005
+ # snapshot_identifier: "SnapshotIdentifier", # required
1006
+ # })
1007
+ #
1008
+ # @example Response structure
1009
+ #
1010
+ # resp.id #=> String
1011
+ # resp.name #=> String
1012
+ # resp.arn #=> String
1013
+ # resp.source_graph_id #=> String
1014
+ # resp.snapshot_create_time #=> Time
1015
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
1016
+ # resp.kms_key_identifier #=> String
1017
+ #
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSnapshot AWS API Documentation
1019
+ #
1020
+ # @overload get_graph_snapshot(params = {})
1021
+ # @param [Hash] params ({})
1022
+ def get_graph_snapshot(params = {}, options = {})
1023
+ req = build_request(:get_graph_snapshot, params)
1024
+ req.send_request(options)
1025
+ end
1026
+
1027
+ # Retrieves a specified import task.
1028
+ #
1029
+ # @option params [required, String] :task_identifier
1030
+ # The unique identifier of the import task.
1031
+ #
1032
+ # @return [Types::GetImportTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1033
+ #
1034
+ # * {Types::GetImportTaskOutput#graph_id #graph_id} => String
1035
+ # * {Types::GetImportTaskOutput#task_id #task_id} => String
1036
+ # * {Types::GetImportTaskOutput#source #source} => String
1037
+ # * {Types::GetImportTaskOutput#format #format} => String
1038
+ # * {Types::GetImportTaskOutput#role_arn #role_arn} => String
1039
+ # * {Types::GetImportTaskOutput#status #status} => String
1040
+ # * {Types::GetImportTaskOutput#import_options #import_options} => Types::ImportOptions
1041
+ # * {Types::GetImportTaskOutput#import_task_details #import_task_details} => Types::ImportTaskDetails
1042
+ # * {Types::GetImportTaskOutput#attempt_number #attempt_number} => Integer
1043
+ # * {Types::GetImportTaskOutput#status_reason #status_reason} => String
1044
+ #
1045
+ # @example Request syntax with placeholder values
1046
+ #
1047
+ # resp = client.get_import_task({
1048
+ # task_identifier: "TaskId", # required
1049
+ # })
1050
+ #
1051
+ # @example Response structure
1052
+ #
1053
+ # resp.graph_id #=> String
1054
+ # resp.task_id #=> String
1055
+ # resp.source #=> String
1056
+ # resp.format #=> String, one of "CSV", "OPEN_CYPHER"
1057
+ # resp.role_arn #=> String
1058
+ # resp.status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
1059
+ # resp.import_options.neptune.s3_export_path #=> String
1060
+ # resp.import_options.neptune.s3_export_kms_key_id #=> String
1061
+ # resp.import_options.neptune.preserve_default_vertex_labels #=> Boolean
1062
+ # resp.import_options.neptune.preserve_edge_ids #=> Boolean
1063
+ # resp.import_task_details.status #=> String
1064
+ # resp.import_task_details.start_time #=> Time
1065
+ # resp.import_task_details.time_elapsed_seconds #=> Integer
1066
+ # resp.import_task_details.progress_percentage #=> Integer
1067
+ # resp.import_task_details.error_count #=> Integer
1068
+ # resp.import_task_details.error_details #=> String
1069
+ # resp.import_task_details.statement_count #=> Integer
1070
+ # resp.import_task_details.dictionary_entry_count #=> Integer
1071
+ # resp.attempt_number #=> Integer
1072
+ # resp.status_reason #=> String
1073
+ #
1074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetImportTask AWS API Documentation
1075
+ #
1076
+ # @overload get_import_task(params = {})
1077
+ # @param [Hash] params ({})
1078
+ def get_import_task(params = {}, options = {})
1079
+ req = build_request(:get_import_task, params)
1080
+ req.send_request(options)
1081
+ end
1082
+
1083
+ # Retrieves information about a specified private endpoint.
1084
+ #
1085
+ # @option params [required, String] :graph_identifier
1086
+ # The unique identifier of the Neptune Analytics graph.
1087
+ #
1088
+ # @option params [required, String] :vpc_id
1089
+ # The ID of the VPC where the private endpoint is located.
1090
+ #
1091
+ # @return [Types::GetPrivateGraphEndpointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1092
+ #
1093
+ # * {Types::GetPrivateGraphEndpointOutput#vpc_id #vpc_id} => String
1094
+ # * {Types::GetPrivateGraphEndpointOutput#subnet_ids #subnet_ids} => Array&lt;String&gt;
1095
+ # * {Types::GetPrivateGraphEndpointOutput#status #status} => String
1096
+ # * {Types::GetPrivateGraphEndpointOutput#vpc_endpoint_id #vpc_endpoint_id} => String
1097
+ #
1098
+ # @example Request syntax with placeholder values
1099
+ #
1100
+ # resp = client.get_private_graph_endpoint({
1101
+ # graph_identifier: "GraphIdentifier", # required
1102
+ # vpc_id: "VpcId", # required
1103
+ # })
1104
+ #
1105
+ # @example Response structure
1106
+ #
1107
+ # resp.vpc_id #=> String
1108
+ # resp.subnet_ids #=> Array
1109
+ # resp.subnet_ids[0] #=> String
1110
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
1111
+ # resp.vpc_endpoint_id #=> String
1112
+ #
1113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetPrivateGraphEndpoint AWS API Documentation
1114
+ #
1115
+ # @overload get_private_graph_endpoint(params = {})
1116
+ # @param [Hash] params ({})
1117
+ def get_private_graph_endpoint(params = {}, options = {})
1118
+ req = build_request(:get_private_graph_endpoint, params)
1119
+ req.send_request(options)
1120
+ end
1121
+
1122
+ # Lists available snapshots of a specified Neptune Analytics graph.
1123
+ #
1124
+ # @option params [String] :graph_identifier
1125
+ # The unique identifier of the Neptune Analytics graph.
1126
+ #
1127
+ # @option params [String] :next_token
1128
+ # Pagination token used to paginate output.
1129
+ #
1130
+ # When this value is provided as input, the service returns results from
1131
+ # where the previous response left off. When this value is present in
1132
+ # output, it indicates that there are more results to retrieve.
1133
+ #
1134
+ # @option params [Integer] :max_results
1135
+ # The total number of records to return in the command's output.
1136
+ #
1137
+ # If the total number of records available is more than the value
1138
+ # specified, `nextToken` is provided in the command's output. To resume
1139
+ # pagination, provide the `nextToken` output value in the `nextToken`
1140
+ # argument of a subsequent command. Do not use the `nextToken` response
1141
+ # element directly outside of the Amazon CLI.
1142
+ #
1143
+ # @return [Types::ListGraphSnapshotsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1144
+ #
1145
+ # * {Types::ListGraphSnapshotsOutput#graph_snapshots #graph_snapshots} => Array&lt;Types::GraphSnapshotSummary&gt;
1146
+ # * {Types::ListGraphSnapshotsOutput#next_token #next_token} => String
1147
+ #
1148
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1149
+ #
1150
+ # @example Request syntax with placeholder values
1151
+ #
1152
+ # resp = client.list_graph_snapshots({
1153
+ # graph_identifier: "GraphIdentifier",
1154
+ # next_token: "PaginationToken",
1155
+ # max_results: 1,
1156
+ # })
1157
+ #
1158
+ # @example Response structure
1159
+ #
1160
+ # resp.graph_snapshots #=> Array
1161
+ # resp.graph_snapshots[0].id #=> String
1162
+ # resp.graph_snapshots[0].name #=> String
1163
+ # resp.graph_snapshots[0].arn #=> String
1164
+ # resp.graph_snapshots[0].source_graph_id #=> String
1165
+ # resp.graph_snapshots[0].snapshot_create_time #=> Time
1166
+ # resp.graph_snapshots[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
1167
+ # resp.graph_snapshots[0].kms_key_identifier #=> String
1168
+ # resp.next_token #=> String
1169
+ #
1170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListGraphSnapshots AWS API Documentation
1171
+ #
1172
+ # @overload list_graph_snapshots(params = {})
1173
+ # @param [Hash] params ({})
1174
+ def list_graph_snapshots(params = {}, options = {})
1175
+ req = build_request(:list_graph_snapshots, params)
1176
+ req.send_request(options)
1177
+ end
1178
+
1179
+ # Lists available Neptune Analytics graphs.
1180
+ #
1181
+ # @option params [String] :next_token
1182
+ # Pagination token used to paginate output.
1183
+ #
1184
+ # When this value is provided as input, the service returns results from
1185
+ # where the previous response left off. When this value is present in
1186
+ # output, it indicates that there are more results to retrieve.
1187
+ #
1188
+ # @option params [Integer] :max_results
1189
+ # The total number of records to return in the command's output.
1190
+ #
1191
+ # If the total number of records available is more than the value
1192
+ # specified, `nextToken` is provided in the command's output. To resume
1193
+ # pagination, provide the `nextToken` output value in the `nextToken`
1194
+ # argument of a subsequent command. Do not use the `nextToken` response
1195
+ # element directly outside of the Amazon CLI.
1196
+ #
1197
+ # @return [Types::ListGraphsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1198
+ #
1199
+ # * {Types::ListGraphsOutput#graphs #graphs} => Array&lt;Types::GraphSummary&gt;
1200
+ # * {Types::ListGraphsOutput#next_token #next_token} => String
1201
+ #
1202
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1203
+ #
1204
+ # @example Request syntax with placeholder values
1205
+ #
1206
+ # resp = client.list_graphs({
1207
+ # next_token: "PaginationToken",
1208
+ # max_results: 1,
1209
+ # })
1210
+ #
1211
+ # @example Response structure
1212
+ #
1213
+ # resp.graphs #=> Array
1214
+ # resp.graphs[0].id #=> String
1215
+ # resp.graphs[0].name #=> String
1216
+ # resp.graphs[0].arn #=> String
1217
+ # resp.graphs[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
1218
+ # resp.graphs[0].provisioned_memory #=> Integer
1219
+ # resp.graphs[0].public_connectivity #=> Boolean
1220
+ # resp.graphs[0].endpoint #=> String
1221
+ # resp.graphs[0].replica_count #=> Integer
1222
+ # resp.graphs[0].kms_key_identifier #=> String
1223
+ # resp.graphs[0].deletion_protection #=> Boolean
1224
+ # resp.next_token #=> String
1225
+ #
1226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListGraphs AWS API Documentation
1227
+ #
1228
+ # @overload list_graphs(params = {})
1229
+ # @param [Hash] params ({})
1230
+ def list_graphs(params = {}, options = {})
1231
+ req = build_request(:list_graphs, params)
1232
+ req.send_request(options)
1233
+ end
1234
+
1235
+ # Lists import tasks.
1236
+ #
1237
+ # @option params [String] :next_token
1238
+ # Pagination token used to paginate output.
1239
+ #
1240
+ # When this value is provided as input, the service returns results from
1241
+ # where the previous response left off. When this value is present in
1242
+ # output, it indicates that there are more results to retrieve.
1243
+ #
1244
+ # @option params [Integer] :max_results
1245
+ # The total number of records to return in the command's output.
1246
+ #
1247
+ # If the total number of records available is more than the value
1248
+ # specified, `nextToken` is provided in the command's output. To resume
1249
+ # pagination, provide the `nextToken` output value in the `nextToken`
1250
+ # argument of a subsequent command. Do not use the `nextToken` response
1251
+ # element directly outside of the Amazon CLI.
1252
+ #
1253
+ # @return [Types::ListImportTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1254
+ #
1255
+ # * {Types::ListImportTasksOutput#tasks #tasks} => Array&lt;Types::ImportTaskSummary&gt;
1256
+ # * {Types::ListImportTasksOutput#next_token #next_token} => String
1257
+ #
1258
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1259
+ #
1260
+ # @example Request syntax with placeholder values
1261
+ #
1262
+ # resp = client.list_import_tasks({
1263
+ # next_token: "PaginationToken",
1264
+ # max_results: 1,
1265
+ # })
1266
+ #
1267
+ # @example Response structure
1268
+ #
1269
+ # resp.tasks #=> Array
1270
+ # resp.tasks[0].graph_id #=> String
1271
+ # resp.tasks[0].task_id #=> String
1272
+ # resp.tasks[0].source #=> String
1273
+ # resp.tasks[0].format #=> String, one of "CSV", "OPEN_CYPHER"
1274
+ # resp.tasks[0].role_arn #=> String
1275
+ # resp.tasks[0].status #=> String, one of "INITIALIZING", "EXPORTING", "ANALYZING_DATA", "IMPORTING", "REPROVISIONING", "ROLLING_BACK", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
1276
+ # resp.next_token #=> String
1277
+ #
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListImportTasks AWS API Documentation
1279
+ #
1280
+ # @overload list_import_tasks(params = {})
1281
+ # @param [Hash] params ({})
1282
+ def list_import_tasks(params = {}, options = {})
1283
+ req = build_request(:list_import_tasks, params)
1284
+ req.send_request(options)
1285
+ end
1286
+
1287
+ # Lists private endpoints for a specified Neptune Analytics graph.
1288
+ #
1289
+ # @option params [required, String] :graph_identifier
1290
+ # The unique identifier of the Neptune Analytics graph.
1291
+ #
1292
+ # @option params [String] :next_token
1293
+ # Pagination token used to paginate output.
1294
+ #
1295
+ # When this value is provided as input, the service returns results from
1296
+ # where the previous response left off. When this value is present in
1297
+ # output, it indicates that there are more results to retrieve.
1298
+ #
1299
+ # @option params [Integer] :max_results
1300
+ # The total number of records to return in the command's output.
1301
+ #
1302
+ # If the total number of records available is more than the value
1303
+ # specified, `nextToken` is provided in the command's output. To resume
1304
+ # pagination, provide the `nextToken` output value in the `nextToken`
1305
+ # argument of a subsequent command. Do not use the `nextToken` response
1306
+ # element directly outside of the Amazon CLI.
1307
+ #
1308
+ # @return [Types::ListPrivateGraphEndpointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1309
+ #
1310
+ # * {Types::ListPrivateGraphEndpointsOutput#private_graph_endpoints #private_graph_endpoints} => Array&lt;Types::PrivateGraphEndpointSummary&gt;
1311
+ # * {Types::ListPrivateGraphEndpointsOutput#next_token #next_token} => String
1312
+ #
1313
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1314
+ #
1315
+ # @example Request syntax with placeholder values
1316
+ #
1317
+ # resp = client.list_private_graph_endpoints({
1318
+ # graph_identifier: "GraphIdentifier", # required
1319
+ # next_token: "PaginationToken",
1320
+ # max_results: 1,
1321
+ # })
1322
+ #
1323
+ # @example Response structure
1324
+ #
1325
+ # resp.private_graph_endpoints #=> Array
1326
+ # resp.private_graph_endpoints[0].vpc_id #=> String
1327
+ # resp.private_graph_endpoints[0].subnet_ids #=> Array
1328
+ # resp.private_graph_endpoints[0].subnet_ids[0] #=> String
1329
+ # resp.private_graph_endpoints[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
1330
+ # resp.private_graph_endpoints[0].vpc_endpoint_id #=> String
1331
+ # resp.next_token #=> String
1332
+ #
1333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListPrivateGraphEndpoints AWS API Documentation
1334
+ #
1335
+ # @overload list_private_graph_endpoints(params = {})
1336
+ # @param [Hash] params ({})
1337
+ def list_private_graph_endpoints(params = {}, options = {})
1338
+ req = build_request(:list_private_graph_endpoints, params)
1339
+ req.send_request(options)
1340
+ end
1341
+
1342
+ # Lists tags associated with a specified resource.
1343
+ #
1344
+ # @option params [required, String] :resource_arn
1345
+ # The ARN of the resource.
1346
+ #
1347
+ # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1348
+ #
1349
+ # * {Types::ListTagsForResourceOutput#tags #tags} => Hash&lt;String,String&gt;
1350
+ #
1351
+ # @example Request syntax with placeholder values
1352
+ #
1353
+ # resp = client.list_tags_for_resource({
1354
+ # resource_arn: "Arn", # required
1355
+ # })
1356
+ #
1357
+ # @example Response structure
1358
+ #
1359
+ # resp.tags #=> Hash
1360
+ # resp.tags["TagKey"] #=> String
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ListTagsForResource AWS API Documentation
1363
+ #
1364
+ # @overload list_tags_for_resource(params = {})
1365
+ # @param [Hash] params ({})
1366
+ def list_tags_for_resource(params = {}, options = {})
1367
+ req = build_request(:list_tags_for_resource, params)
1368
+ req.send_request(options)
1369
+ end
1370
+
1371
+ # Empties the data from a specified Neptune Analytics graph.
1372
+ #
1373
+ # @option params [required, String] :graph_identifier
1374
+ # ID of the graph to reset.
1375
+ #
1376
+ # @option params [required, Boolean] :skip_snapshot
1377
+ # Determines whether a final graph snapshot is created before the graph
1378
+ # data is deleted. If set to `true`, no graph snapshot is created. If
1379
+ # set to `false`, a graph snapshot is created before the data is
1380
+ # deleted.
1381
+ #
1382
+ # @return [Types::ResetGraphOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1383
+ #
1384
+ # * {Types::ResetGraphOutput#id #id} => String
1385
+ # * {Types::ResetGraphOutput#name #name} => String
1386
+ # * {Types::ResetGraphOutput#arn #arn} => String
1387
+ # * {Types::ResetGraphOutput#status #status} => String
1388
+ # * {Types::ResetGraphOutput#status_reason #status_reason} => String
1389
+ # * {Types::ResetGraphOutput#create_time #create_time} => Time
1390
+ # * {Types::ResetGraphOutput#provisioned_memory #provisioned_memory} => Integer
1391
+ # * {Types::ResetGraphOutput#endpoint #endpoint} => String
1392
+ # * {Types::ResetGraphOutput#public_connectivity #public_connectivity} => Boolean
1393
+ # * {Types::ResetGraphOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
1394
+ # * {Types::ResetGraphOutput#replica_count #replica_count} => Integer
1395
+ # * {Types::ResetGraphOutput#kms_key_identifier #kms_key_identifier} => String
1396
+ # * {Types::ResetGraphOutput#source_snapshot_id #source_snapshot_id} => String
1397
+ # * {Types::ResetGraphOutput#deletion_protection #deletion_protection} => Boolean
1398
+ # * {Types::ResetGraphOutput#build_number #build_number} => String
1399
+ #
1400
+ # @example Request syntax with placeholder values
1401
+ #
1402
+ # resp = client.reset_graph({
1403
+ # graph_identifier: "GraphIdentifier", # required
1404
+ # skip_snapshot: false, # required
1405
+ # })
1406
+ #
1407
+ # @example Response structure
1408
+ #
1409
+ # resp.id #=> String
1410
+ # resp.name #=> String
1411
+ # resp.arn #=> String
1412
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
1413
+ # resp.status_reason #=> String
1414
+ # resp.create_time #=> Time
1415
+ # resp.provisioned_memory #=> Integer
1416
+ # resp.endpoint #=> String
1417
+ # resp.public_connectivity #=> Boolean
1418
+ # resp.vector_search_configuration.dimension #=> Integer
1419
+ # resp.replica_count #=> Integer
1420
+ # resp.kms_key_identifier #=> String
1421
+ # resp.source_snapshot_id #=> String
1422
+ # resp.deletion_protection #=> Boolean
1423
+ # resp.build_number #=> String
1424
+ #
1425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/ResetGraph AWS API Documentation
1426
+ #
1427
+ # @overload reset_graph(params = {})
1428
+ # @param [Hash] params ({})
1429
+ def reset_graph(params = {}, options = {})
1430
+ req = build_request(:reset_graph, params)
1431
+ req.send_request(options)
1432
+ end
1433
+
1434
+ # Restores a graph from a snapshot.
1435
+ #
1436
+ # @option params [required, String] :snapshot_identifier
1437
+ # The ID of the snapshot in question.
1438
+ #
1439
+ # @option params [required, String] :graph_name
1440
+ # A name for the new Neptune Analytics graph to be created from the
1441
+ # snapshot.
1442
+ #
1443
+ # The name must contain from 1 to 63 letters, numbers, or hyphens, and
1444
+ # its first character must be a letter. It cannot end with a hyphen or
1445
+ # contain two consecutive hyphens.
1446
+ #
1447
+ # @option params [Integer] :provisioned_memory
1448
+ # The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to
1449
+ # use for the graph. Min = 128
1450
+ #
1451
+ # @option params [Boolean] :deletion_protection
1452
+ # A value that indicates whether the graph has deletion protection
1453
+ # enabled. The graph can't be deleted when deletion protection is
1454
+ # enabled.
1455
+ #
1456
+ # @option params [Hash<String,String>] :tags
1457
+ # Adds metadata tags to the snapshot. These tags can also be used with
1458
+ # cost allocation reporting, or used in a Condition statement in an IAM
1459
+ # policy.
1460
+ #
1461
+ # @option params [Integer] :replica_count
1462
+ # The number of replicas in other AZs. Min =0, Max = 2, Default =1
1463
+ #
1464
+ # @option params [Boolean] :public_connectivity
1465
+ # Specifies whether or not the graph can be reachable over the internet.
1466
+ # All access to graphs IAM authenticated. (`true` to enable, or `false`
1467
+ # to disable).
1468
+ #
1469
+ # @return [Types::RestoreGraphFromSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1470
+ #
1471
+ # * {Types::RestoreGraphFromSnapshotOutput#id #id} => String
1472
+ # * {Types::RestoreGraphFromSnapshotOutput#name #name} => String
1473
+ # * {Types::RestoreGraphFromSnapshotOutput#arn #arn} => String
1474
+ # * {Types::RestoreGraphFromSnapshotOutput#status #status} => String
1475
+ # * {Types::RestoreGraphFromSnapshotOutput#status_reason #status_reason} => String
1476
+ # * {Types::RestoreGraphFromSnapshotOutput#create_time #create_time} => Time
1477
+ # * {Types::RestoreGraphFromSnapshotOutput#provisioned_memory #provisioned_memory} => Integer
1478
+ # * {Types::RestoreGraphFromSnapshotOutput#endpoint #endpoint} => String
1479
+ # * {Types::RestoreGraphFromSnapshotOutput#public_connectivity #public_connectivity} => Boolean
1480
+ # * {Types::RestoreGraphFromSnapshotOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
1481
+ # * {Types::RestoreGraphFromSnapshotOutput#replica_count #replica_count} => Integer
1482
+ # * {Types::RestoreGraphFromSnapshotOutput#kms_key_identifier #kms_key_identifier} => String
1483
+ # * {Types::RestoreGraphFromSnapshotOutput#source_snapshot_id #source_snapshot_id} => String
1484
+ # * {Types::RestoreGraphFromSnapshotOutput#deletion_protection #deletion_protection} => Boolean
1485
+ # * {Types::RestoreGraphFromSnapshotOutput#build_number #build_number} => String
1486
+ #
1487
+ # @example Request syntax with placeholder values
1488
+ #
1489
+ # resp = client.restore_graph_from_snapshot({
1490
+ # snapshot_identifier: "SnapshotIdentifier", # required
1491
+ # graph_name: "GraphName", # required
1492
+ # provisioned_memory: 1,
1493
+ # deletion_protection: false,
1494
+ # tags: {
1495
+ # "TagKey" => "TagValue",
1496
+ # },
1497
+ # replica_count: 1,
1498
+ # public_connectivity: false,
1499
+ # })
1500
+ #
1501
+ # @example Response structure
1502
+ #
1503
+ # resp.id #=> String
1504
+ # resp.name #=> String
1505
+ # resp.arn #=> String
1506
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
1507
+ # resp.status_reason #=> String
1508
+ # resp.create_time #=> Time
1509
+ # resp.provisioned_memory #=> Integer
1510
+ # resp.endpoint #=> String
1511
+ # resp.public_connectivity #=> Boolean
1512
+ # resp.vector_search_configuration.dimension #=> Integer
1513
+ # resp.replica_count #=> Integer
1514
+ # resp.kms_key_identifier #=> String
1515
+ # resp.source_snapshot_id #=> String
1516
+ # resp.deletion_protection #=> Boolean
1517
+ # resp.build_number #=> String
1518
+ #
1519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/RestoreGraphFromSnapshot AWS API Documentation
1520
+ #
1521
+ # @overload restore_graph_from_snapshot(params = {})
1522
+ # @param [Hash] params ({})
1523
+ def restore_graph_from_snapshot(params = {}, options = {})
1524
+ req = build_request(:restore_graph_from_snapshot, params)
1525
+ req.send_request(options)
1526
+ end
1527
+
1528
+ # Adds tags to the specified resource.
1529
+ #
1530
+ # @option params [required, String] :resource_arn
1531
+ # ARN of the resource for which tags need to be added.
1532
+ #
1533
+ # @option params [required, Hash<String,String>] :tags
1534
+ # The tags to be assigned to the Neptune Analytics resource.
1535
+ #
1536
+ # The tags are metadata that are specified as a list of key-value pairs:
1537
+ #
1538
+ # **Key** (string)   –   A key is the required name of the tag. The
1539
+ # string value can be from 1 to 128 Unicode characters in length. It
1540
+ # can't be prefixed with `aws:` and can only contain the set of Unicode
1541
+ # characters specified by this Java regular expression:
1542
+ # `"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")`.
1543
+ #
1544
+ # **Value** (string)   –   A value is the optional value of the tag. The
1545
+ # string value can be from 1 to 256 Unicode characters in length. It
1546
+ # can't be prefixed with `aws:` and can only contain the set of Unicode
1547
+ # characters specified by this Java regular expression:
1548
+ # `"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")`.
1549
+ #
1550
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1551
+ #
1552
+ # @example Request syntax with placeholder values
1553
+ #
1554
+ # resp = client.tag_resource({
1555
+ # resource_arn: "Arn", # required
1556
+ # tags: { # required
1557
+ # "TagKey" => "TagValue",
1558
+ # },
1559
+ # })
1560
+ #
1561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/TagResource AWS API Documentation
1562
+ #
1563
+ # @overload tag_resource(params = {})
1564
+ # @param [Hash] params ({})
1565
+ def tag_resource(params = {}, options = {})
1566
+ req = build_request(:tag_resource, params)
1567
+ req.send_request(options)
1568
+ end
1569
+
1570
+ # Removes the specified tags from the specified resource.
1571
+ #
1572
+ # @option params [required, String] :resource_arn
1573
+ # ARN of the resource whose tag needs to be removed.
1574
+ #
1575
+ # @option params [required, Array<String>] :tag_keys
1576
+ # Tag keys for the tags to be removed.
1577
+ #
1578
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1579
+ #
1580
+ # @example Request syntax with placeholder values
1581
+ #
1582
+ # resp = client.untag_resource({
1583
+ # resource_arn: "Arn", # required
1584
+ # tag_keys: ["TagKey"], # required
1585
+ # })
1586
+ #
1587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/UntagResource AWS API Documentation
1588
+ #
1589
+ # @overload untag_resource(params = {})
1590
+ # @param [Hash] params ({})
1591
+ def untag_resource(params = {}, options = {})
1592
+ req = build_request(:untag_resource, params)
1593
+ req.send_request(options)
1594
+ end
1595
+
1596
+ # Updates the configuration of a specified Neptune Analytics graph
1597
+ #
1598
+ # @option params [required, String] :graph_identifier
1599
+ # The unique identifier of the Neptune Analytics graph.
1600
+ #
1601
+ # @option params [Boolean] :public_connectivity
1602
+ # Specifies whether or not the graph can be reachable over the internet.
1603
+ # All access to graphs IAM authenticated. (`true` to enable, or `false`
1604
+ # to disable.
1605
+ #
1606
+ # @option params [Integer] :provisioned_memory
1607
+ # The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to
1608
+ # use for the graph. Min = 128
1609
+ #
1610
+ # @option params [Boolean] :deletion_protection
1611
+ # A value that indicates whether the graph has deletion protection
1612
+ # enabled. The graph can't be deleted when deletion protection is
1613
+ # enabled.
1614
+ #
1615
+ # @return [Types::UpdateGraphOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1616
+ #
1617
+ # * {Types::UpdateGraphOutput#id #id} => String
1618
+ # * {Types::UpdateGraphOutput#name #name} => String
1619
+ # * {Types::UpdateGraphOutput#arn #arn} => String
1620
+ # * {Types::UpdateGraphOutput#status #status} => String
1621
+ # * {Types::UpdateGraphOutput#status_reason #status_reason} => String
1622
+ # * {Types::UpdateGraphOutput#create_time #create_time} => Time
1623
+ # * {Types::UpdateGraphOutput#provisioned_memory #provisioned_memory} => Integer
1624
+ # * {Types::UpdateGraphOutput#endpoint #endpoint} => String
1625
+ # * {Types::UpdateGraphOutput#public_connectivity #public_connectivity} => Boolean
1626
+ # * {Types::UpdateGraphOutput#vector_search_configuration #vector_search_configuration} => Types::VectorSearchConfiguration
1627
+ # * {Types::UpdateGraphOutput#replica_count #replica_count} => Integer
1628
+ # * {Types::UpdateGraphOutput#kms_key_identifier #kms_key_identifier} => String
1629
+ # * {Types::UpdateGraphOutput#source_snapshot_id #source_snapshot_id} => String
1630
+ # * {Types::UpdateGraphOutput#deletion_protection #deletion_protection} => Boolean
1631
+ # * {Types::UpdateGraphOutput#build_number #build_number} => String
1632
+ #
1633
+ # @example Request syntax with placeholder values
1634
+ #
1635
+ # resp = client.update_graph({
1636
+ # graph_identifier: "GraphIdentifier", # required
1637
+ # public_connectivity: false,
1638
+ # provisioned_memory: 1,
1639
+ # deletion_protection: false,
1640
+ # })
1641
+ #
1642
+ # @example Response structure
1643
+ #
1644
+ # resp.id #=> String
1645
+ # resp.name #=> String
1646
+ # resp.arn #=> String
1647
+ # resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "RESETTING", "UPDATING", "SNAPSHOTTING", "FAILED"
1648
+ # resp.status_reason #=> String
1649
+ # resp.create_time #=> Time
1650
+ # resp.provisioned_memory #=> Integer
1651
+ # resp.endpoint #=> String
1652
+ # resp.public_connectivity #=> Boolean
1653
+ # resp.vector_search_configuration.dimension #=> Integer
1654
+ # resp.replica_count #=> Integer
1655
+ # resp.kms_key_identifier #=> String
1656
+ # resp.source_snapshot_id #=> String
1657
+ # resp.deletion_protection #=> Boolean
1658
+ # resp.build_number #=> String
1659
+ #
1660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/UpdateGraph AWS API Documentation
1661
+ #
1662
+ # @overload update_graph(params = {})
1663
+ # @param [Hash] params ({})
1664
+ def update_graph(params = {}, options = {})
1665
+ req = build_request(:update_graph, params)
1666
+ req.send_request(options)
1667
+ end
1668
+
1669
+ # @!endgroup
1670
+
1671
+ # @param params ({})
1672
+ # @api private
1673
+ def build_request(operation_name, params = {})
1674
+ handlers = @handlers.for(operation_name)
1675
+ context = Seahorse::Client::RequestContext.new(
1676
+ operation_name: operation_name,
1677
+ operation: config.api.operation(operation_name),
1678
+ client: self,
1679
+ params: params,
1680
+ config: config)
1681
+ context[:gem_name] = 'aws-sdk-neptunegraph'
1682
+ context[:gem_version] = '1.0.0'
1683
+ Seahorse::Client::Request.new(handlers, context)
1684
+ end
1685
+
1686
+ # @api private
1687
+ # @deprecated
1688
+ def waiter_names
1689
+ []
1690
+ end
1691
+
1692
+ class << self
1693
+
1694
+ # @api private
1695
+ attr_reader :identifier
1696
+
1697
+ # @api private
1698
+ def errors_module
1699
+ Errors
1700
+ end
1701
+
1702
+ end
1703
+ end
1704
+ end