1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2023-11-29", 5 "endpointPrefix":"neptune-graph", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "ripServiceName":"neptune-graph", 9 "serviceAbbreviation":"Neptune Graph", 10 "serviceFullName":"Amazon Neptune Graph", 11 "serviceId":"Neptune Graph", 12 "signatureVersion":"v4", 13 "signingName":"neptune-graph", 14 "uid":"neptune-graph-2023-11-29" 15 }, 16 "operations":{ 17 "CancelImportTask":{ 18 "name":"CancelImportTask", 19 "http":{ 20 "method":"DELETE", 21 "requestUri":"/importtasks/{taskIdentifier}", 22 "responseCode":200 23 }, 24 "input":{"shape":"CancelImportTaskInput"}, 25 "output":{"shape":"CancelImportTaskOutput"}, 26 "errors":[ 27 {"shape":"ThrottlingException"}, 28 {"shape":"ValidationException"}, 29 {"shape":"ConflictException"}, 30 {"shape":"InternalServerException"}, 31 {"shape":"ResourceNotFoundException"} 32 ], 33 "documentation":"<p>Deletes the specified import task.</p>", 34 "staticContextParams":{ 35 "ApiType":{"value":"ControlPlane"} 36 } 37 }, 38 "CancelQuery":{ 39 "name":"CancelQuery", 40 "http":{ 41 "method":"DELETE", 42 "requestUri":"/queries/{queryId}", 43 "responseCode":200 44 }, 45 "input":{"shape":"CancelQueryInput"}, 46 "errors":[ 47 {"shape":"ThrottlingException"}, 48 {"shape":"ValidationException"}, 49 {"shape":"AccessDeniedException"}, 50 {"shape":"InternalServerException"}, 51 {"shape":"ResourceNotFoundException"} 52 ], 53 "documentation":"<p>Cancels a specified query.</p>", 54 "endpoint":{ 55 "hostPrefix":"{graphIdentifier}." 56 }, 57 "idempotent":true, 58 "staticContextParams":{ 59 "ApiType":{"value":"DataPlane"} 60 } 61 }, 62 "CreateGraph":{ 63 "name":"CreateGraph", 64 "http":{ 65 "method":"POST", 66 "requestUri":"/graphs", 67 "responseCode":201 68 }, 69 "input":{"shape":"CreateGraphInput"}, 70 "output":{"shape":"CreateGraphOutput"}, 71 "errors":[ 72 {"shape":"ServiceQuotaExceededException"}, 73 {"shape":"ThrottlingException"}, 74 {"shape":"ValidationException"}, 75 {"shape":"ConflictException"}, 76 {"shape":"InternalServerException"} 77 ], 78 "documentation":"<p>Creates a new Neptune Analytics graph.</p>", 79 "staticContextParams":{ 80 "ApiType":{"value":"ControlPlane"} 81 } 82 }, 83 "CreateGraphSnapshot":{ 84 "name":"CreateGraphSnapshot", 85 "http":{ 86 "method":"POST", 87 "requestUri":"/snapshots", 88 "responseCode":201 89 }, 90 "input":{"shape":"CreateGraphSnapshotInput"}, 91 "output":{"shape":"CreateGraphSnapshotOutput"}, 92 "errors":[ 93 {"shape":"ServiceQuotaExceededException"}, 94 {"shape":"ThrottlingException"}, 95 {"shape":"ValidationException"}, 96 {"shape":"ConflictException"}, 97 {"shape":"InternalServerException"}, 98 {"shape":"ResourceNotFoundException"} 99 ], 100 "documentation":"<p>Creates a snapshot of the specific graph.</p>", 101 "staticContextParams":{ 102 "ApiType":{"value":"ControlPlane"} 103 } 104 }, 105 "CreateGraphUsingImportTask":{ 106 "name":"CreateGraphUsingImportTask", 107 "http":{ 108 "method":"POST", 109 "requestUri":"/importtasks", 110 "responseCode":201 111 }, 112 "input":{"shape":"CreateGraphUsingImportTaskInput"}, 113 "output":{"shape":"CreateGraphUsingImportTaskOutput"}, 114 "errors":[ 115 {"shape":"ServiceQuotaExceededException"}, 116 {"shape":"ThrottlingException"}, 117 {"shape":"ValidationException"}, 118 {"shape":"ConflictException"}, 119 {"shape":"InternalServerException"} 120 ], 121 "documentation":"<p>Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.</p> <p>The data can be loaded from files in S3 that in either the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>", 122 "staticContextParams":{ 123 "ApiType":{"value":"ControlPlane"} 124 } 125 }, 126 "CreatePrivateGraphEndpoint":{ 127 "name":"CreatePrivateGraphEndpoint", 128 "http":{ 129 "method":"POST", 130 "requestUri":"/graphs/{graphIdentifier}/endpoints/", 131 "responseCode":201 132 }, 133 "input":{"shape":"CreatePrivateGraphEndpointInput"}, 134 "output":{"shape":"CreatePrivateGraphEndpointOutput"}, 135 "errors":[ 136 {"shape":"ServiceQuotaExceededException"}, 137 {"shape":"ThrottlingException"}, 138 {"shape":"ValidationException"}, 139 {"shape":"ConflictException"}, 140 {"shape":"InternalServerException"}, 141 {"shape":"ResourceNotFoundException"} 142 ], 143 "documentation":"<p>Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.</p>", 144 "staticContextParams":{ 145 "ApiType":{"value":"ControlPlane"} 146 } 147 }, 148 "DeleteGraph":{ 149 "name":"DeleteGraph", 150 "http":{ 151 "method":"DELETE", 152 "requestUri":"/graphs/{graphIdentifier}", 153 "responseCode":200 154 }, 155 "input":{"shape":"DeleteGraphInput"}, 156 "output":{"shape":"DeleteGraphOutput"}, 157 "errors":[ 158 {"shape":"ThrottlingException"}, 159 {"shape":"ValidationException"}, 160 {"shape":"ConflictException"}, 161 {"shape":"InternalServerException"}, 162 {"shape":"ResourceNotFoundException"} 163 ], 164 "documentation":"<p>Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.</p>", 165 "staticContextParams":{ 166 "ApiType":{"value":"ControlPlane"} 167 } 168 }, 169 "DeleteGraphSnapshot":{ 170 "name":"DeleteGraphSnapshot", 171 "http":{ 172 "method":"DELETE", 173 "requestUri":"/snapshots/{snapshotIdentifier}", 174 "responseCode":200 175 }, 176 "input":{"shape":"DeleteGraphSnapshotInput"}, 177 "output":{"shape":"DeleteGraphSnapshotOutput"}, 178 "errors":[ 179 {"shape":"ThrottlingException"}, 180 {"shape":"ValidationException"}, 181 {"shape":"ConflictException"}, 182 {"shape":"InternalServerException"}, 183 {"shape":"ResourceNotFoundException"} 184 ], 185 "documentation":"<p>Deletes the specifed graph snapshot.</p>", 186 "staticContextParams":{ 187 "ApiType":{"value":"ControlPlane"} 188 } 189 }, 190 "DeletePrivateGraphEndpoint":{ 191 "name":"DeletePrivateGraphEndpoint", 192 "http":{ 193 "method":"DELETE", 194 "requestUri":"/graphs/{graphIdentifier}/endpoints/{vpcId}", 195 "responseCode":200 196 }, 197 "input":{"shape":"DeletePrivateGraphEndpointInput"}, 198 "output":{"shape":"DeletePrivateGraphEndpointOutput"}, 199 "errors":[ 200 {"shape":"ThrottlingException"}, 201 {"shape":"ValidationException"}, 202 {"shape":"ConflictException"}, 203 {"shape":"InternalServerException"}, 204 {"shape":"ResourceNotFoundException"} 205 ], 206 "documentation":"<p>Deletes a private graph endpoint.</p>", 207 "staticContextParams":{ 208 "ApiType":{"value":"ControlPlane"} 209 } 210 }, 211 "ExecuteQuery":{ 212 "name":"ExecuteQuery", 213 "http":{ 214 "method":"POST", 215 "requestUri":"/queries", 216 "responseCode":200 217 }, 218 "input":{"shape":"ExecuteQueryInput"}, 219 "output":{"shape":"ExecuteQueryOutput"}, 220 "errors":[ 221 {"shape":"UnprocessableException"}, 222 {"shape":"ThrottlingException"}, 223 {"shape":"ValidationException"}, 224 {"shape":"ConflictException"}, 225 {"shape":"AccessDeniedException"}, 226 {"shape":"InternalServerException"} 227 ], 228 "documentation":"<p>Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a parameterized query call, you can use an HTTP request. </p> <p> When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query: </p> <ul> <li> <p>neptune-graph:ReadDataViaQuery</p> </li> <li> <p>neptune-graph:WriteDataViaQuery</p> </li> <li> <p>neptune-graph:DeleteDataViaQuery</p> </li> </ul> <note> <p> Non-parametrized queries are not considered for plan caching. You can force plan caching with <code>planCache=enabled</code>. The plan cache will be reused only for the same exact query. Slight variations in the query will not be able to reuse the query plan cache. </p> </note>", 229 "endpoint":{ 230 "hostPrefix":"{graphIdentifier}." 231 }, 232 "staticContextParams":{ 233 "ApiType":{"value":"DataPlane"} 234 } 235 }, 236 "GetGraph":{ 237 "name":"GetGraph", 238 "http":{ 239 "method":"GET", 240 "requestUri":"/graphs/{graphIdentifier}", 241 "responseCode":200 242 }, 243 "input":{"shape":"GetGraphInput"}, 244 "output":{"shape":"GetGraphOutput"}, 245 "errors":[ 246 {"shape":"ThrottlingException"}, 247 {"shape":"ValidationException"}, 248 {"shape":"InternalServerException"}, 249 {"shape":"ResourceNotFoundException"} 250 ], 251 "documentation":"<p>Gets information about a specified graph.</p>", 252 "staticContextParams":{ 253 "ApiType":{"value":"ControlPlane"} 254 } 255 }, 256 "GetGraphSnapshot":{ 257 "name":"GetGraphSnapshot", 258 "http":{ 259 "method":"GET", 260 "requestUri":"/snapshots/{snapshotIdentifier}", 261 "responseCode":200 262 }, 263 "input":{"shape":"GetGraphSnapshotInput"}, 264 "output":{"shape":"GetGraphSnapshotOutput"}, 265 "errors":[ 266 {"shape":"ThrottlingException"}, 267 {"shape":"ValidationException"}, 268 {"shape":"InternalServerException"}, 269 {"shape":"ResourceNotFoundException"} 270 ], 271 "documentation":"<p>Retrieves a specified graph snapshot.</p>", 272 "staticContextParams":{ 273 "ApiType":{"value":"ControlPlane"} 274 } 275 }, 276 "GetGraphSummary":{ 277 "name":"GetGraphSummary", 278 "http":{ 279 "method":"GET", 280 "requestUri":"/summary", 281 "responseCode":200 282 }, 283 "input":{"shape":"GetGraphSummaryInput"}, 284 "output":{"shape":"GetGraphSummaryOutput"}, 285 "errors":[ 286 {"shape":"ThrottlingException"}, 287 {"shape":"ValidationException"}, 288 {"shape":"AccessDeniedException"}, 289 {"shape":"InternalServerException"}, 290 {"shape":"ResourceNotFoundException"} 291 ], 292 "documentation":"<p>Gets a graph summary for a property graph.</p>", 293 "endpoint":{ 294 "hostPrefix":"{graphIdentifier}." 295 }, 296 "staticContextParams":{ 297 "ApiType":{"value":"DataPlane"} 298 } 299 }, 300 "GetImportTask":{ 301 "name":"GetImportTask", 302 "http":{ 303 "method":"GET", 304 "requestUri":"/importtasks/{taskIdentifier}", 305 "responseCode":200 306 }, 307 "input":{"shape":"GetImportTaskInput"}, 308 "output":{"shape":"GetImportTaskOutput"}, 309 "errors":[ 310 {"shape":"ThrottlingException"}, 311 {"shape":"ValidationException"}, 312 {"shape":"InternalServerException"}, 313 {"shape":"ResourceNotFoundException"} 314 ], 315 "documentation":"<p>Retrieves a specified import task.</p>", 316 "staticContextParams":{ 317 "ApiType":{"value":"ControlPlane"} 318 } 319 }, 320 "GetPrivateGraphEndpoint":{ 321 "name":"GetPrivateGraphEndpoint", 322 "http":{ 323 "method":"GET", 324 "requestUri":"/graphs/{graphIdentifier}/endpoints/{vpcId}", 325 "responseCode":200 326 }, 327 "input":{"shape":"GetPrivateGraphEndpointInput"}, 328 "output":{"shape":"GetPrivateGraphEndpointOutput"}, 329 "errors":[ 330 {"shape":"ThrottlingException"}, 331 {"shape":"ValidationException"}, 332 {"shape":"InternalServerException"}, 333 {"shape":"ResourceNotFoundException"} 334 ], 335 "documentation":"<p>Retrieves information about a specified private endpoint.</p>", 336 "staticContextParams":{ 337 "ApiType":{"value":"ControlPlane"} 338 } 339 }, 340 "GetQuery":{ 341 "name":"GetQuery", 342 "http":{ 343 "method":"GET", 344 "requestUri":"/queries/{queryId}", 345 "responseCode":200 346 }, 347 "input":{"shape":"GetQueryInput"}, 348 "output":{"shape":"GetQueryOutput"}, 349 "errors":[ 350 {"shape":"ThrottlingException"}, 351 {"shape":"ValidationException"}, 352 {"shape":"AccessDeniedException"}, 353 {"shape":"InternalServerException"}, 354 {"shape":"ResourceNotFoundException"} 355 ], 356 "documentation":"<p>Retrieves the status of a specified query.</p> <note> <p> When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the <code>neptune-graph:GetQueryStatus</code> IAM action attached. </p> </note>", 357 "endpoint":{ 358 "hostPrefix":"{graphIdentifier}." 359 }, 360 "staticContextParams":{ 361 "ApiType":{"value":"DataPlane"} 362 } 363 }, 364 "ListGraphSnapshots":{ 365 "name":"ListGraphSnapshots", 366 "http":{ 367 "method":"GET", 368 "requestUri":"/snapshots", 369 "responseCode":200 370 }, 371 "input":{"shape":"ListGraphSnapshotsInput"}, 372 "output":{"shape":"ListGraphSnapshotsOutput"}, 373 "errors":[ 374 {"shape":"ThrottlingException"}, 375 {"shape":"ValidationException"}, 376 {"shape":"InternalServerException"}, 377 {"shape":"ResourceNotFoundException"} 378 ], 379 "documentation":"<p>Lists available snapshots of a specified Neptune Analytics graph.</p>", 380 "staticContextParams":{ 381 "ApiType":{"value":"ControlPlane"} 382 } 383 }, 384 "ListGraphs":{ 385 "name":"ListGraphs", 386 "http":{ 387 "method":"GET", 388 "requestUri":"/graphs", 389 "responseCode":200 390 }, 391 "input":{"shape":"ListGraphsInput"}, 392 "output":{"shape":"ListGraphsOutput"}, 393 "errors":[ 394 {"shape":"ThrottlingException"}, 395 {"shape":"InternalServerException"}, 396 {"shape":"ResourceNotFoundException"} 397 ], 398 "documentation":"<p>Lists available Neptune Analytics graphs.</p>", 399 "staticContextParams":{ 400 "ApiType":{"value":"ControlPlane"} 401 } 402 }, 403 "ListImportTasks":{ 404 "name":"ListImportTasks", 405 "http":{ 406 "method":"GET", 407 "requestUri":"/importtasks", 408 "responseCode":200 409 }, 410 "input":{"shape":"ListImportTasksInput"}, 411 "output":{"shape":"ListImportTasksOutput"}, 412 "errors":[ 413 {"shape":"ThrottlingException"}, 414 {"shape":"ValidationException"}, 415 {"shape":"InternalServerException"}, 416 {"shape":"ResourceNotFoundException"} 417 ], 418 "documentation":"<p>Lists import tasks.</p>", 419 "staticContextParams":{ 420 "ApiType":{"value":"ControlPlane"} 421 } 422 }, 423 "ListPrivateGraphEndpoints":{ 424 "name":"ListPrivateGraphEndpoints", 425 "http":{ 426 "method":"GET", 427 "requestUri":"/graphs/{graphIdentifier}/endpoints/", 428 "responseCode":200 429 }, 430 "input":{"shape":"ListPrivateGraphEndpointsInput"}, 431 "output":{"shape":"ListPrivateGraphEndpointsOutput"}, 432 "errors":[ 433 {"shape":"ThrottlingException"}, 434 {"shape":"ValidationException"}, 435 {"shape":"InternalServerException"}, 436 {"shape":"ResourceNotFoundException"} 437 ], 438 "documentation":"<p>Lists private endpoints for a specified Neptune Analytics graph.</p>", 439 "staticContextParams":{ 440 "ApiType":{"value":"ControlPlane"} 441 } 442 }, 443 "ListQueries":{ 444 "name":"ListQueries", 445 "http":{ 446 "method":"GET", 447 "requestUri":"/queries", 448 "responseCode":200 449 }, 450 "input":{"shape":"ListQueriesInput"}, 451 "output":{"shape":"ListQueriesOutput"}, 452 "errors":[ 453 {"shape":"ThrottlingException"}, 454 {"shape":"ValidationException"}, 455 {"shape":"AccessDeniedException"}, 456 {"shape":"InternalServerException"} 457 ], 458 "documentation":"<p>Lists active openCypher queries.</p>", 459 "endpoint":{ 460 "hostPrefix":"{graphIdentifier}." 461 }, 462 "staticContextParams":{ 463 "ApiType":{"value":"DataPlane"} 464 } 465 }, 466 "ListTagsForResource":{ 467 "name":"ListTagsForResource", 468 "http":{ 469 "method":"GET", 470 "requestUri":"/tags/{resourceArn}", 471 "responseCode":200 472 }, 473 "input":{"shape":"ListTagsForResourceInput"}, 474 "output":{"shape":"ListTagsForResourceOutput"}, 475 "errors":[ 476 {"shape":"ThrottlingException"}, 477 {"shape":"ValidationException"}, 478 {"shape":"InternalServerException"}, 479 {"shape":"ResourceNotFoundException"} 480 ], 481 "documentation":"<p>Lists tags associated with a specified resource.</p>", 482 "staticContextParams":{ 483 "ApiType":{"value":"ControlPlane"} 484 } 485 }, 486 "ResetGraph":{ 487 "name":"ResetGraph", 488 "http":{ 489 "method":"PUT", 490 "requestUri":"/graphs/{graphIdentifier}", 491 "responseCode":200 492 }, 493 "input":{"shape":"ResetGraphInput"}, 494 "output":{"shape":"ResetGraphOutput"}, 495 "errors":[ 496 {"shape":"ThrottlingException"}, 497 {"shape":"ValidationException"}, 498 {"shape":"ConflictException"}, 499 {"shape":"InternalServerException"}, 500 {"shape":"ResourceNotFoundException"} 501 ], 502 "documentation":"<p>Empties the data from a specified Neptune Analytics graph.</p>", 503 "staticContextParams":{ 504 "ApiType":{"value":"ControlPlane"} 505 } 506 }, 507 "RestoreGraphFromSnapshot":{ 508 "name":"RestoreGraphFromSnapshot", 509 "http":{ 510 "method":"POST", 511 "requestUri":"/snapshots/{snapshotIdentifier}/restore", 512 "responseCode":201 513 }, 514 "input":{"shape":"RestoreGraphFromSnapshotInput"}, 515 "output":{"shape":"RestoreGraphFromSnapshotOutput"}, 516 "errors":[ 517 {"shape":"ServiceQuotaExceededException"}, 518 {"shape":"ThrottlingException"}, 519 {"shape":"ValidationException"}, 520 {"shape":"ConflictException"}, 521 {"shape":"InternalServerException"}, 522 {"shape":"ResourceNotFoundException"} 523 ], 524 "documentation":"<p>Restores a graph from a snapshot.</p>", 525 "staticContextParams":{ 526 "ApiType":{"value":"ControlPlane"} 527 } 528 }, 529 "TagResource":{ 530 "name":"TagResource", 531 "http":{ 532 "method":"POST", 533 "requestUri":"/tags/{resourceArn}", 534 "responseCode":200 535 }, 536 "input":{"shape":"TagResourceInput"}, 537 "output":{"shape":"TagResourceOutput"}, 538 "errors":[ 539 {"shape":"ThrottlingException"}, 540 {"shape":"ValidationException"}, 541 {"shape":"InternalServerException"}, 542 {"shape":"ResourceNotFoundException"} 543 ], 544 "documentation":"<p>Adds tags to the specified resource.</p>", 545 "idempotent":true, 546 "staticContextParams":{ 547 "ApiType":{"value":"ControlPlane"} 548 } 549 }, 550 "UntagResource":{ 551 "name":"UntagResource", 552 "http":{ 553 "method":"DELETE", 554 "requestUri":"/tags/{resourceArn}", 555 "responseCode":200 556 }, 557 "input":{"shape":"UntagResourceInput"}, 558 "output":{"shape":"UntagResourceOutput"}, 559 "errors":[ 560 {"shape":"ThrottlingException"}, 561 {"shape":"ValidationException"}, 562 {"shape":"InternalServerException"}, 563 {"shape":"ResourceNotFoundException"} 564 ], 565 "documentation":"<p>Removes the specified tags from the specified resource.</p>", 566 "idempotent":true, 567 "staticContextParams":{ 568 "ApiType":{"value":"ControlPlane"} 569 } 570 }, 571 "UpdateGraph":{ 572 "name":"UpdateGraph", 573 "http":{ 574 "method":"PATCH", 575 "requestUri":"/graphs/{graphIdentifier}", 576 "responseCode":200 577 }, 578 "input":{"shape":"UpdateGraphInput"}, 579 "output":{"shape":"UpdateGraphOutput"}, 580 "errors":[ 581 {"shape":"ThrottlingException"}, 582 {"shape":"ValidationException"}, 583 {"shape":"ConflictException"}, 584 {"shape":"InternalServerException"}, 585 {"shape":"ResourceNotFoundException"} 586 ], 587 "documentation":"<p>Updates the configuration of a specified Neptune Analytics graph</p>", 588 "staticContextParams":{ 589 "ApiType":{"value":"ControlPlane"} 590 } 591 } 592 }, 593 "shapes":{ 594 "AccessDeniedException":{ 595 "type":"structure", 596 "required":["message"], 597 "members":{ 598 "message":{ 599 "shape":"String", 600 "documentation":"<p>A message describing the problem.</p>" 601 } 602 }, 603 "documentation":"<p>Raised in case of an authentication or authorization failure.</p>", 604 "error":{ 605 "httpStatusCode":403, 606 "senderFault":true 607 }, 608 "exception":true 609 }, 610 "Arn":{ 611 "type":"string", 612 "max":1011, 613 "min":1, 614 "pattern":"arn:.+" 615 }, 616 "Boolean":{ 617 "type":"boolean", 618 "box":true 619 }, 620 "CancelImportTaskInput":{ 621 "type":"structure", 622 "required":["taskIdentifier"], 623 "members":{ 624 "taskIdentifier":{ 625 "shape":"TaskId", 626 "documentation":"<p>The unique identifier of the import task.</p>", 627 "location":"uri", 628 "locationName":"taskIdentifier" 629 } 630 } 631 }, 632 "CancelImportTaskOutput":{ 633 "type":"structure", 634 "required":[ 635 "taskId", 636 "source", 637 "roleArn", 638 "status" 639 ], 640 "members":{ 641 "graphId":{ 642 "shape":"GraphId", 643 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>" 644 }, 645 "taskId":{ 646 "shape":"TaskId", 647 "documentation":"<p>The unique identifier of the import task.</p>" 648 }, 649 "source":{ 650 "shape":"String", 651 "documentation":"<p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>" 652 }, 653 "format":{ 654 "shape":"Format", 655 "documentation":"<p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>" 656 }, 657 "roleArn":{ 658 "shape":"RoleArn", 659 "documentation":"<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>" 660 }, 661 "status":{ 662 "shape":"ImportTaskStatus", 663 "documentation":"<p>Current status of the task. Status is CANCELLING when the import task is cancelled.</p>" 664 } 665 } 666 }, 667 "CancelQueryInput":{ 668 "type":"structure", 669 "required":[ 670 "graphIdentifier", 671 "queryId" 672 ], 673 "members":{ 674 "graphIdentifier":{ 675 "shape":"GraphIdentifier", 676 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 677 "hostLabel":true, 678 "location":"header", 679 "locationName":"graphIdentifier" 680 }, 681 "queryId":{ 682 "shape":"String", 683 "documentation":"<p>The unique identifier of the query to cancel.</p>", 684 "location":"uri", 685 "locationName":"queryId" 686 } 687 } 688 }, 689 "ConflictException":{ 690 "type":"structure", 691 "required":["message"], 692 "members":{ 693 "message":{ 694 "shape":"String", 695 "documentation":"<p>A message describing the problem.</p>" 696 }, 697 "reason":{ 698 "shape":"ConflictExceptionReason", 699 "documentation":"<p>The reason for the conflict exception.</p>" 700 } 701 }, 702 "documentation":"<p>Raised when a conflict is encountered.</p>", 703 "error":{ 704 "httpStatusCode":409, 705 "senderFault":true 706 }, 707 "exception":true 708 }, 709 "ConflictExceptionReason":{ 710 "type":"string", 711 "enum":["CONCURRENT_MODIFICATION"] 712 }, 713 "CreateGraphInput":{ 714 "type":"structure", 715 "required":[ 716 "graphName", 717 "provisionedMemory" 718 ], 719 "members":{ 720 "graphName":{ 721 "shape":"GraphName", 722 "documentation":"<p>A name for the new Neptune Analytics graph to be created.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. </p>" 723 }, 724 "tags":{ 725 "shape":"TagMap", 726 "documentation":"<p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>" 727 }, 728 "publicConnectivity":{ 729 "shape":"Boolean", 730 "documentation":"<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>" 731 }, 732 "kmsKeyIdentifier":{ 733 "shape":"KmsKeyArn", 734 "documentation":"<p>Specifies a KMS key to use to encrypt data in the new graph.</p>" 735 }, 736 "vectorSearchConfiguration":{ 737 "shape":"VectorSearchConfiguration", 738 "documentation":"<p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535</p>" 739 }, 740 "replicaCount":{ 741 "shape":"ReplicaCount", 742 "documentation":"<p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p>" 743 }, 744 "deletionProtection":{ 745 "shape":"Boolean", 746 "documentation":"<p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p>" 747 }, 748 "provisionedMemory":{ 749 "shape":"ProvisionedMemory", 750 "documentation":"<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>" 751 } 752 } 753 }, 754 "CreateGraphOutput":{ 755 "type":"structure", 756 "required":[ 757 "id", 758 "name", 759 "arn" 760 ], 761 "members":{ 762 "id":{ 763 "shape":"GraphId", 764 "documentation":"<p>The ID of the graph.</p>" 765 }, 766 "name":{ 767 "shape":"GraphName", 768 "documentation":"<p>The graph name. For example: <code>my-graph-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. </p>" 769 }, 770 "arn":{ 771 "shape":"String", 772 "documentation":"<p>The ARN of the graph.</p>" 773 }, 774 "status":{ 775 "shape":"GraphStatus", 776 "documentation":"<p>The current status of the graph.</p>" 777 }, 778 "statusReason":{ 779 "shape":"String", 780 "documentation":"<p>The reason the status was given.</p>" 781 }, 782 "createTime":{ 783 "shape":"Timestamp", 784 "documentation":"<p>The time when the graph was created.</p>" 785 }, 786 "provisionedMemory":{ 787 "shape":"ProvisionedMemory", 788 "documentation":"<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>" 789 }, 790 "endpoint":{ 791 "shape":"String", 792 "documentation":"<p>The graph endpoint.</p>" 793 }, 794 "publicConnectivity":{ 795 "shape":"Boolean", 796 "documentation":"<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>" 797 }, 798 "vectorSearchConfiguration":{ 799 "shape":"VectorSearchConfiguration", 800 "documentation":"<p>The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.</p>" 801 }, 802 "replicaCount":{ 803 "shape":"ReplicaCount", 804 "documentation":"<p>The number of replicas in other AZs.</p>" 805 }, 806 "kmsKeyIdentifier":{ 807 "shape":"KmsKeyArn", 808 "documentation":"<p>Specifies the KMS key used to encrypt data in the new graph.</p>" 809 }, 810 "sourceSnapshotId":{ 811 "shape":"SnapshotId", 812 "documentation":"<p>The ID of the source graph.</p>" 813 }, 814 "deletionProtection":{ 815 "shape":"Boolean", 816 "documentation":"<p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>" 817 }, 818 "buildNumber":{ 819 "shape":"String", 820 "documentation":"<p>The build number of the graph software.</p>" 821 } 822 } 823 }, 824 "CreateGraphSnapshotInput":{ 825 "type":"structure", 826 "required":[ 827 "graphIdentifier", 828 "snapshotName" 829 ], 830 "members":{ 831 "graphIdentifier":{ 832 "shape":"GraphIdentifier", 833 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>" 834 }, 835 "snapshotName":{ 836 "shape":"SnapshotName", 837 "documentation":"<p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.</p>" 838 }, 839 "tags":{ 840 "shape":"TagMap", 841 "documentation":"<p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>" 842 } 843 } 844 }, 845 "CreateGraphSnapshotOutput":{ 846 "type":"structure", 847 "required":[ 848 "id", 849 "name", 850 "arn" 851 ], 852 "members":{ 853 "id":{ 854 "shape":"SnapshotId", 855 "documentation":"<p>The ID of the snapshot created.</p>" 856 }, 857 "name":{ 858 "shape":"SnapshotName", 859 "documentation":"<p>The name of the snapshot created.</p>" 860 }, 861 "arn":{ 862 "shape":"String", 863 "documentation":"<p>The ARN of the snapshot created.</p>" 864 }, 865 "sourceGraphId":{ 866 "shape":"GraphId", 867 "documentation":"<p>The Id of the Neptune Analytics graph from which the snapshot is created.</p>" 868 }, 869 "snapshotCreateTime":{ 870 "shape":"Timestamp", 871 "documentation":"<p>The snapshot creation time</p>" 872 }, 873 "status":{ 874 "shape":"SnapshotStatus", 875 "documentation":"<p>The current state of the snapshot.</p>" 876 }, 877 "kmsKeyIdentifier":{ 878 "shape":"KmsKeyArn", 879 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 880 } 881 } 882 }, 883 "CreateGraphUsingImportTaskInput":{ 884 "type":"structure", 885 "required":[ 886 "graphName", 887 "source", 888 "roleArn" 889 ], 890 "members":{ 891 "graphName":{ 892 "shape":"GraphName", 893 "documentation":"<p>A name for the new Neptune Analytics graph to be created.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. </p>" 894 }, 895 "tags":{ 896 "shape":"TagMap", 897 "documentation":"<p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>" 898 }, 899 "publicConnectivity":{ 900 "shape":"Boolean", 901 "documentation":"<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable).</p>" 902 }, 903 "kmsKeyIdentifier":{ 904 "shape":"KmsKeyArn", 905 "documentation":"<p>Specifies a KMS key to use to encrypt data imported into the new graph.</p>" 906 }, 907 "vectorSearchConfiguration":{ 908 "shape":"VectorSearchConfiguration", 909 "documentation":"<p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535 </p>" 910 }, 911 "replicaCount":{ 912 "shape":"ReplicaCount", 913 "documentation":"<p>The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.</p>" 914 }, 915 "deletionProtection":{ 916 "shape":"Boolean", 917 "documentation":"<p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p>" 918 }, 919 "importOptions":{ 920 "shape":"ImportOptions", 921 "documentation":"<p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>" 922 }, 923 "maxProvisionedMemory":{ 924 "shape":"ProvisionedMemory", 925 "documentation":"<p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.</p> <p> If both the minimum and maximum values are specified, the max of the <code>min-provisioned-memory</code> and <code>max-provisioned memory</code> is used to create the graph. If neither value is specified 128 m-NCUs are used.</p>" 926 }, 927 "minProvisionedMemory":{ 928 "shape":"ProvisionedMemory", 929 "documentation":"<p>The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128</p>" 930 }, 931 "failOnError":{ 932 "shape":"Boolean", 933 "documentation":"<p>If set to <code>true</code>, the task halts when an import error is encountered. If set to <code>false</code>, the task skips the data that caused the error and continues if possible.</p>" 934 }, 935 "source":{ 936 "shape":"String", 937 "documentation":"<p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>" 938 }, 939 "format":{ 940 "shape":"Format", 941 "documentation":"<p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>" 942 }, 943 "roleArn":{ 944 "shape":"RoleArn", 945 "documentation":"<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>" 946 } 947 } 948 }, 949 "CreateGraphUsingImportTaskOutput":{ 950 "type":"structure", 951 "required":[ 952 "taskId", 953 "source", 954 "roleArn", 955 "status" 956 ], 957 "members":{ 958 "graphId":{ 959 "shape":"GraphId", 960 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>" 961 }, 962 "taskId":{ 963 "shape":"TaskId", 964 "documentation":"<p>The unique identifier of the import task.</p>" 965 }, 966 "source":{ 967 "shape":"String", 968 "documentation":"<p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>" 969 }, 970 "format":{ 971 "shape":"Format", 972 "documentation":"<p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>" 973 }, 974 "roleArn":{ 975 "shape":"RoleArn", 976 "documentation":"<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>" 977 }, 978 "status":{ 979 "shape":"ImportTaskStatus", 980 "documentation":"<p>The status of the import task.</p>" 981 }, 982 "importOptions":{ 983 "shape":"ImportOptions", 984 "documentation":"<p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>" 985 } 986 } 987 }, 988 "CreatePrivateGraphEndpointInput":{ 989 "type":"structure", 990 "required":["graphIdentifier"], 991 "members":{ 992 "graphIdentifier":{ 993 "shape":"GraphIdentifier", 994 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 995 "location":"uri", 996 "locationName":"graphIdentifier" 997 }, 998 "vpcId":{ 999 "shape":"VpcId", 1000 "documentation":"<p> The VPC in which the private graph endpoint needs to be created.</p>" 1001 }, 1002 "subnetIds":{ 1003 "shape":"SubnetIds", 1004 "documentation":"<p>Subnets in which private graph endpoint ENIs are created.</p>" 1005 }, 1006 "vpcSecurityGroupIds":{ 1007 "shape":"SecurityGroupIds", 1008 "documentation":"<p>Security groups to be attached to the private graph endpoint..</p>" 1009 } 1010 } 1011 }, 1012 "CreatePrivateGraphEndpointOutput":{ 1013 "type":"structure", 1014 "required":[ 1015 "vpcId", 1016 "subnetIds", 1017 "status" 1018 ], 1019 "members":{ 1020 "vpcId":{ 1021 "shape":"VpcId", 1022 "documentation":"<p>VPC in which the private graph endpoint is created.</p>" 1023 }, 1024 "subnetIds":{ 1025 "shape":"SubnetIds", 1026 "documentation":"<p>Subnets in which the private graph endpoint ENIs are created. </p>" 1027 }, 1028 "status":{ 1029 "shape":"PrivateGraphEndpointStatus", 1030 "documentation":"<p>Status of the private graph endpoint.</p>" 1031 }, 1032 "vpcEndpointId":{ 1033 "shape":"VpcEndpointId", 1034 "documentation":"<p>Endpoint ID of the prviate grpah endpoint.</p>" 1035 } 1036 } 1037 }, 1038 "DeleteGraphInput":{ 1039 "type":"structure", 1040 "required":[ 1041 "graphIdentifier", 1042 "skipSnapshot" 1043 ], 1044 "members":{ 1045 "graphIdentifier":{ 1046 "shape":"GraphIdentifier", 1047 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1048 "location":"uri", 1049 "locationName":"graphIdentifier" 1050 }, 1051 "skipSnapshot":{ 1052 "shape":"Boolean", 1053 "documentation":"<p>Determines whether a final graph snapshot is created before the graph is deleted. If <code>true</code> is specified, no graph snapshot is created. If <code>false</code> is specified, a graph snapshot is created before the graph is deleted.</p>", 1054 "location":"querystring", 1055 "locationName":"skipSnapshot" 1056 } 1057 } 1058 }, 1059 "DeleteGraphOutput":{ 1060 "type":"structure", 1061 "required":[ 1062 "id", 1063 "name", 1064 "arn" 1065 ], 1066 "members":{ 1067 "id":{ 1068 "shape":"GraphId", 1069 "documentation":"<p>The unique identifier of the graph.</p>" 1070 }, 1071 "name":{ 1072 "shape":"GraphName", 1073 "documentation":"<p>The name of the graph.</p>" 1074 }, 1075 "arn":{ 1076 "shape":"String", 1077 "documentation":"<p>The ARN associated with the graph.</p>" 1078 }, 1079 "status":{ 1080 "shape":"GraphStatus", 1081 "documentation":"<p>The status of the graph.</p>" 1082 }, 1083 "statusReason":{ 1084 "shape":"String", 1085 "documentation":"<p>The reason for the status of the graph.</p>" 1086 }, 1087 "createTime":{ 1088 "shape":"Timestamp", 1089 "documentation":"<p>The time at which the graph was created.</p>" 1090 }, 1091 "provisionedMemory":{ 1092 "shape":"ProvisionedMemory", 1093 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 1094 }, 1095 "endpoint":{ 1096 "shape":"String", 1097 "documentation":"<p>The graph endpoint.</p>" 1098 }, 1099 "publicConnectivity":{ 1100 "shape":"Boolean", 1101 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 1102 }, 1103 "vectorSearchConfiguration":{"shape":"VectorSearchConfiguration"}, 1104 "replicaCount":{ 1105 "shape":"ReplicaCount", 1106 "documentation":"<p>The number of replicas for the graph.</p>" 1107 }, 1108 "kmsKeyIdentifier":{ 1109 "shape":"KmsKeyArn", 1110 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 1111 }, 1112 "sourceSnapshotId":{ 1113 "shape":"SnapshotId", 1114 "documentation":"<p>The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.</p>" 1115 }, 1116 "deletionProtection":{ 1117 "shape":"Boolean", 1118 "documentation":"<p>If <code>true</code>, deletion protection was enabled for the graph.</p>" 1119 }, 1120 "buildNumber":{ 1121 "shape":"String", 1122 "documentation":"<p>The build number associated with the graph.</p>" 1123 } 1124 } 1125 }, 1126 "DeleteGraphSnapshotInput":{ 1127 "type":"structure", 1128 "required":["snapshotIdentifier"], 1129 "members":{ 1130 "snapshotIdentifier":{ 1131 "shape":"SnapshotIdentifier", 1132 "documentation":"<p>ID of the graph snapshot to be deleted.</p>", 1133 "location":"uri", 1134 "locationName":"snapshotIdentifier" 1135 } 1136 } 1137 }, 1138 "DeleteGraphSnapshotOutput":{ 1139 "type":"structure", 1140 "required":[ 1141 "id", 1142 "name", 1143 "arn" 1144 ], 1145 "members":{ 1146 "id":{ 1147 "shape":"SnapshotId", 1148 "documentation":"<p>The unique identifier of the graph snapshot.</p>" 1149 }, 1150 "name":{ 1151 "shape":"SnapshotName", 1152 "documentation":"<p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.</p>" 1153 }, 1154 "arn":{ 1155 "shape":"String", 1156 "documentation":"<p>The ARN of the graph snapshot.</p>" 1157 }, 1158 "sourceGraphId":{ 1159 "shape":"GraphId", 1160 "documentation":"<p>The graph identifier for the graph from which the snapshot was created.</p>" 1161 }, 1162 "snapshotCreateTime":{ 1163 "shape":"Timestamp", 1164 "documentation":"<p>The time when the snapshot was created.</p>" 1165 }, 1166 "status":{ 1167 "shape":"SnapshotStatus", 1168 "documentation":"<p>The status of the graph snapshot.</p>" 1169 }, 1170 "kmsKeyIdentifier":{ 1171 "shape":"KmsKeyArn", 1172 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>" 1173 } 1174 } 1175 }, 1176 "DeletePrivateGraphEndpointInput":{ 1177 "type":"structure", 1178 "required":[ 1179 "graphIdentifier", 1180 "vpcId" 1181 ], 1182 "members":{ 1183 "graphIdentifier":{ 1184 "shape":"GraphIdentifier", 1185 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1186 "location":"uri", 1187 "locationName":"graphIdentifier" 1188 }, 1189 "vpcId":{ 1190 "shape":"VpcId", 1191 "documentation":"<p>The ID of the VPC where the private endpoint is located.</p>", 1192 "location":"uri", 1193 "locationName":"vpcId" 1194 } 1195 } 1196 }, 1197 "DeletePrivateGraphEndpointOutput":{ 1198 "type":"structure", 1199 "required":[ 1200 "vpcId", 1201 "subnetIds", 1202 "status" 1203 ], 1204 "members":{ 1205 "vpcId":{ 1206 "shape":"VpcId", 1207 "documentation":"<p>The ID of the VPC where the private endpoint was deleted.</p>" 1208 }, 1209 "subnetIds":{ 1210 "shape":"SubnetIds", 1211 "documentation":"<p>The subnet IDs involved.</p>" 1212 }, 1213 "status":{ 1214 "shape":"PrivateGraphEndpointStatus", 1215 "documentation":"<p>The status of the delete operation.</p>" 1216 }, 1217 "vpcEndpointId":{ 1218 "shape":"VpcEndpointId", 1219 "documentation":"<p>The ID of the VPC endpoint that was deleted.</p>" 1220 } 1221 } 1222 }, 1223 "Document":{ 1224 "type":"structure", 1225 "members":{ 1226 }, 1227 "document":true 1228 }, 1229 "DocumentValuedMap":{ 1230 "type":"map", 1231 "key":{"shape":"String"}, 1232 "value":{"shape":"Document"} 1233 }, 1234 "EdgeLabels":{ 1235 "type":"list", 1236 "member":{"shape":"String"} 1237 }, 1238 "EdgeProperties":{ 1239 "type":"list", 1240 "member":{"shape":"String"} 1241 }, 1242 "EdgeStructure":{ 1243 "type":"structure", 1244 "members":{ 1245 "count":{ 1246 "shape":"Long", 1247 "documentation":"<p>The number of instances of the edge in the graph.</p>" 1248 }, 1249 "edgeProperties":{ 1250 "shape":"EdgeProperties", 1251 "documentation":"<p>A list of the properties associated with the edge.</p>" 1252 } 1253 }, 1254 "documentation":"<p>Contains information about an edge in a Neptune Analytics graph.</p>" 1255 }, 1256 "EdgeStructures":{ 1257 "type":"list", 1258 "member":{"shape":"EdgeStructure"} 1259 }, 1260 "ExecuteQueryInput":{ 1261 "type":"structure", 1262 "required":[ 1263 "graphIdentifier", 1264 "queryString", 1265 "language" 1266 ], 1267 "members":{ 1268 "graphIdentifier":{ 1269 "shape":"GraphIdentifier", 1270 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1271 "hostLabel":true, 1272 "location":"header", 1273 "locationName":"graphIdentifier" 1274 }, 1275 "queryString":{ 1276 "shape":"String", 1277 "documentation":"<p>The query string to be executed.</p>", 1278 "locationName":"query" 1279 }, 1280 "language":{ 1281 "shape":"QueryLanguage", 1282 "documentation":"<p>The query language the query is written in. Currently only openCypher is supported.</p>" 1283 }, 1284 "parameters":{ 1285 "shape":"DocumentValuedMap", 1286 "documentation":"<p>The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional) </p>" 1287 }, 1288 "planCache":{ 1289 "shape":"PlanCacheType", 1290 "documentation":"<p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.</p>" 1291 }, 1292 "explainMode":{ 1293 "shape":"ExplainMode", 1294 "documentation":"<p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.</p>", 1295 "locationName":"explain" 1296 }, 1297 "queryTimeoutMilliseconds":{ 1298 "shape":"Integer", 1299 "documentation":"<p>Specifies the query timeout duration, in milliseconds. (optional)</p>" 1300 } 1301 } 1302 }, 1303 "ExecuteQueryOutput":{ 1304 "type":"structure", 1305 "required":["payload"], 1306 "members":{ 1307 "payload":{ 1308 "shape":"QueryResponseBlob", 1309 "documentation":"<p>The query results.</p>" 1310 } 1311 }, 1312 "payload":"payload" 1313 }, 1314 "ExplainMode":{ 1315 "type":"string", 1316 "enum":[ 1317 "STATIC", 1318 "DETAILS" 1319 ] 1320 }, 1321 "Format":{ 1322 "type":"string", 1323 "enum":[ 1324 "CSV", 1325 "OPEN_CYPHER" 1326 ] 1327 }, 1328 "GetGraphInput":{ 1329 "type":"structure", 1330 "required":["graphIdentifier"], 1331 "members":{ 1332 "graphIdentifier":{ 1333 "shape":"GraphIdentifier", 1334 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1335 "location":"uri", 1336 "locationName":"graphIdentifier" 1337 } 1338 } 1339 }, 1340 "GetGraphOutput":{ 1341 "type":"structure", 1342 "required":[ 1343 "id", 1344 "name", 1345 "arn" 1346 ], 1347 "members":{ 1348 "id":{ 1349 "shape":"GraphId", 1350 "documentation":"<p>The unique identifier of the graph.</p>" 1351 }, 1352 "name":{ 1353 "shape":"GraphName", 1354 "documentation":"<p>The name of the graph.</p>" 1355 }, 1356 "arn":{ 1357 "shape":"String", 1358 "documentation":"<p>The ARN associated with the graph.</p>" 1359 }, 1360 "status":{ 1361 "shape":"GraphStatus", 1362 "documentation":"<p>The status of the graph.</p>" 1363 }, 1364 "statusReason":{ 1365 "shape":"String", 1366 "documentation":"<p>The reason that the graph has this status.</p>" 1367 }, 1368 "createTime":{ 1369 "shape":"Timestamp", 1370 "documentation":"<p>The time at which the graph was created.</p>" 1371 }, 1372 "provisionedMemory":{ 1373 "shape":"ProvisionedMemory", 1374 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 1375 }, 1376 "endpoint":{ 1377 "shape":"String", 1378 "documentation":"<p>The graph endpoint.</p>" 1379 }, 1380 "publicConnectivity":{ 1381 "shape":"Boolean", 1382 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 1383 }, 1384 "vectorSearchConfiguration":{"shape":"VectorSearchConfiguration"}, 1385 "replicaCount":{ 1386 "shape":"ReplicaCount", 1387 "documentation":"<p>The number of replicas for the graph.</p>" 1388 }, 1389 "kmsKeyIdentifier":{ 1390 "shape":"KmsKeyArn", 1391 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 1392 }, 1393 "sourceSnapshotId":{ 1394 "shape":"SnapshotId", 1395 "documentation":"<p>The ID of the snapshot from which the graph was created, if it was created from a snapshot.</p>" 1396 }, 1397 "deletionProtection":{ 1398 "shape":"Boolean", 1399 "documentation":"<p>If <code>true</code>, deletion protection is enabled for the graph.</p>" 1400 }, 1401 "buildNumber":{ 1402 "shape":"String", 1403 "documentation":"<p>The build number of the graph.</p>" 1404 } 1405 } 1406 }, 1407 "GetGraphSnapshotInput":{ 1408 "type":"structure", 1409 "required":["snapshotIdentifier"], 1410 "members":{ 1411 "snapshotIdentifier":{ 1412 "shape":"SnapshotIdentifier", 1413 "documentation":"<p>The ID of the snapshot to retrieve.</p>", 1414 "location":"uri", 1415 "locationName":"snapshotIdentifier" 1416 } 1417 } 1418 }, 1419 "GetGraphSnapshotOutput":{ 1420 "type":"structure", 1421 "required":[ 1422 "id", 1423 "name", 1424 "arn" 1425 ], 1426 "members":{ 1427 "id":{ 1428 "shape":"SnapshotId", 1429 "documentation":"<p>The unique identifier of the graph snapshot.</p>" 1430 }, 1431 "name":{ 1432 "shape":"SnapshotName", 1433 "documentation":"<p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.</p>" 1434 }, 1435 "arn":{ 1436 "shape":"String", 1437 "documentation":"<p>The ARN of the graph snapshot.</p>" 1438 }, 1439 "sourceGraphId":{ 1440 "shape":"GraphId", 1441 "documentation":"<p>The graph identifier for the graph for which a snapshot is to be created.</p>" 1442 }, 1443 "snapshotCreateTime":{ 1444 "shape":"Timestamp", 1445 "documentation":"<p>The time when the snapshot was created.</p>" 1446 }, 1447 "status":{ 1448 "shape":"SnapshotStatus", 1449 "documentation":"<p>The status of the graph snapshot.</p>" 1450 }, 1451 "kmsKeyIdentifier":{ 1452 "shape":"KmsKeyArn", 1453 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>" 1454 } 1455 } 1456 }, 1457 "GetGraphSummaryInput":{ 1458 "type":"structure", 1459 "required":["graphIdentifier"], 1460 "members":{ 1461 "graphIdentifier":{ 1462 "shape":"GraphIdentifier", 1463 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1464 "hostLabel":true, 1465 "location":"header", 1466 "locationName":"graphIdentifier" 1467 }, 1468 "mode":{ 1469 "shape":"GraphSummaryMode", 1470 "documentation":"<p>The summary mode can take one of two values: <code>basic</code> (the default), and <code>detailed</code>.</p>", 1471 "location":"querystring", 1472 "locationName":"mode" 1473 } 1474 } 1475 }, 1476 "GetGraphSummaryOutput":{ 1477 "type":"structure", 1478 "members":{ 1479 "version":{ 1480 "shape":"String", 1481 "documentation":"<p>Display the version of this tool.</p>" 1482 }, 1483 "lastStatisticsComputationTime":{ 1484 "shape":"SyntheticTimestamp_date_time", 1485 "documentation":"<p>The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.</p>" 1486 }, 1487 "graphSummary":{ 1488 "shape":"GraphDataSummary", 1489 "documentation":"<p>The graph summary.</p>" 1490 } 1491 } 1492 }, 1493 "GetImportTaskInput":{ 1494 "type":"structure", 1495 "required":["taskIdentifier"], 1496 "members":{ 1497 "taskIdentifier":{ 1498 "shape":"TaskId", 1499 "documentation":"<p>The unique identifier of the import task.</p>", 1500 "location":"uri", 1501 "locationName":"taskIdentifier" 1502 } 1503 } 1504 }, 1505 "GetImportTaskOutput":{ 1506 "type":"structure", 1507 "required":[ 1508 "taskId", 1509 "source", 1510 "roleArn", 1511 "status" 1512 ], 1513 "members":{ 1514 "graphId":{ 1515 "shape":"GraphId", 1516 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>" 1517 }, 1518 "taskId":{ 1519 "shape":"TaskId", 1520 "documentation":"<p>The unique identifier of the import task.</p>" 1521 }, 1522 "source":{ 1523 "shape":"String", 1524 "documentation":"<p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot</p>" 1525 }, 1526 "format":{ 1527 "shape":"Format", 1528 "documentation":"<p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>" 1529 }, 1530 "roleArn":{ 1531 "shape":"RoleArn", 1532 "documentation":"<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>" 1533 }, 1534 "status":{ 1535 "shape":"ImportTaskStatus", 1536 "documentation":"<p>The status of the import task:</p> <ul> <li> <p> <b>INITIALIZING</b> – The necessary resources needed to create the graph are being prepared.</p> </li> <li> <p> <b>ANALYZING_DATA</b> – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.</p> </li> <li> <p> <b>RE_PROVISIONING</b> – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.</p> </li> <li> <p> <b>IMPORTING</b> – The data is being loaded.</p> </li> <li> <p> <b>ERROR_ENCOUNTERED</b> – An error has been encountered while trying to create the graph and import the data.</p> </li> <li> <p> <b>ERROR_ENCOUNTERED_ROLLING_BACK</b> – Because of the error that was encountered, the graph is being rolled back and all its resources released.</p> </li> <li> <p> <b>SUCCEEDED</b> – Graph creation and data loading succeeded.</p> </li> <li> <p> <b>FAILED</b> – Graph creation or data loading failed. When the status is <code>FAILED</code>, you can use <code>get-graphs</code> to get more information about the state of the graph.</p> </li> <li> <p> <b>CANCELLING</b> – Because you cancelled the import task, cancellation is in progress.</p> </li> <li> <p> <b>CANCELLED</b> – You have successfully cancelled the import task.</p> </li> </ul>" 1537 }, 1538 "importOptions":{ 1539 "shape":"ImportOptions", 1540 "documentation":"<p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>" 1541 }, 1542 "importTaskDetails":{ 1543 "shape":"ImportTaskDetails", 1544 "documentation":"<p>Contains details about the specified import task.</p>" 1545 }, 1546 "attemptNumber":{ 1547 "shape":"Integer", 1548 "documentation":"<p>The number of the current attempt to execute the import task.</p>" 1549 }, 1550 "statusReason":{ 1551 "shape":"String", 1552 "documentation":"<p>The reason that the import task has this status value.</p>" 1553 } 1554 } 1555 }, 1556 "GetPrivateGraphEndpointInput":{ 1557 "type":"structure", 1558 "required":[ 1559 "graphIdentifier", 1560 "vpcId" 1561 ], 1562 "members":{ 1563 "graphIdentifier":{ 1564 "shape":"GraphIdentifier", 1565 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1566 "location":"uri", 1567 "locationName":"graphIdentifier" 1568 }, 1569 "vpcId":{ 1570 "shape":"VpcId", 1571 "documentation":"<p>The ID of the VPC where the private endpoint is located.</p>", 1572 "location":"uri", 1573 "locationName":"vpcId" 1574 } 1575 } 1576 }, 1577 "GetPrivateGraphEndpointOutput":{ 1578 "type":"structure", 1579 "required":[ 1580 "vpcId", 1581 "subnetIds", 1582 "status" 1583 ], 1584 "members":{ 1585 "vpcId":{ 1586 "shape":"VpcId", 1587 "documentation":"<p>The ID of the VPC where the private endpoint is located.</p>" 1588 }, 1589 "subnetIds":{ 1590 "shape":"SubnetIds", 1591 "documentation":"<p>The subnet IDs involved.</p>" 1592 }, 1593 "status":{ 1594 "shape":"PrivateGraphEndpointStatus", 1595 "documentation":"<p>The current status of the private endpoint.</p>" 1596 }, 1597 "vpcEndpointId":{ 1598 "shape":"VpcEndpointId", 1599 "documentation":"<p>The ID of the private endpoint.</p>" 1600 } 1601 } 1602 }, 1603 "GetQueryInput":{ 1604 "type":"structure", 1605 "required":[ 1606 "graphIdentifier", 1607 "queryId" 1608 ], 1609 "members":{ 1610 "graphIdentifier":{ 1611 "shape":"GraphIdentifier", 1612 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1613 "hostLabel":true, 1614 "location":"header", 1615 "locationName":"graphIdentifier" 1616 }, 1617 "queryId":{ 1618 "shape":"String", 1619 "documentation":"<p>The ID of the query in question.</p>", 1620 "location":"uri", 1621 "locationName":"queryId" 1622 } 1623 } 1624 }, 1625 "GetQueryOutput":{ 1626 "type":"structure", 1627 "members":{ 1628 "id":{ 1629 "shape":"String", 1630 "documentation":"<p>The ID of the query in question.</p>" 1631 }, 1632 "queryString":{ 1633 "shape":"String", 1634 "documentation":"<p>The query in question.</p>" 1635 }, 1636 "waited":{ 1637 "shape":"Integer", 1638 "documentation":"<p>Indicates how long the query waited, in milliseconds.</p>" 1639 }, 1640 "elapsed":{ 1641 "shape":"Integer", 1642 "documentation":"<p>The number of milliseconds the query has been running.</p>" 1643 }, 1644 "state":{ 1645 "shape":"QueryState", 1646 "documentation":"<p>State of the query.</p>" 1647 } 1648 } 1649 }, 1650 "GraphDataSummary":{ 1651 "type":"structure", 1652 "members":{ 1653 "numNodes":{ 1654 "shape":"Long", 1655 "documentation":"<p>The number of nodes in the graph.</p>" 1656 }, 1657 "numEdges":{ 1658 "shape":"Long", 1659 "documentation":"<p>The number of edges in the graph.</p>" 1660 }, 1661 "numNodeLabels":{ 1662 "shape":"Long", 1663 "documentation":"<p>The number of distinct node labels in the graph.</p>" 1664 }, 1665 "numEdgeLabels":{ 1666 "shape":"Long", 1667 "documentation":"<p>The number of unique edge labels in the graph.</p>" 1668 }, 1669 "nodeLabels":{ 1670 "shape":"NodeLabels", 1671 "documentation":"<p>A list of distinct node labels in the graph.</p>" 1672 }, 1673 "edgeLabels":{ 1674 "shape":"EdgeLabels", 1675 "documentation":"<p>A list of the edge labels in the graph.</p>" 1676 }, 1677 "numNodeProperties":{ 1678 "shape":"Long", 1679 "documentation":"<p>The number of distinct node properties in the graph.</p>" 1680 }, 1681 "numEdgeProperties":{ 1682 "shape":"Long", 1683 "documentation":"<p>The number of edge properties in the graph.</p>" 1684 }, 1685 "nodeProperties":{ 1686 "shape":"LongValuedMapList", 1687 "documentation":"<p>A list of the distinct node properties in the graph, along with the count of nodes where each property is used.</p>" 1688 }, 1689 "edgeProperties":{ 1690 "shape":"LongValuedMapList", 1691 "documentation":"<p>A list of the distinct edge properties in the graph, along with the count of edges where each property is used.</p>" 1692 }, 1693 "totalNodePropertyValues":{ 1694 "shape":"Long", 1695 "documentation":"<p>The total number of usages of all node properties.</p>" 1696 }, 1697 "totalEdgePropertyValues":{ 1698 "shape":"Long", 1699 "documentation":"<p>The total number of usages of all edge properties.</p>" 1700 }, 1701 "nodeStructures":{ 1702 "shape":"NodeStructures", 1703 "documentation":"<p>This field is only present when the requested mode is DETAILED. It contains a list of node structures.</p>" 1704 }, 1705 "edgeStructures":{ 1706 "shape":"EdgeStructures", 1707 "documentation":"<p>This field is only present when the requested mode is DETAILED. It contains a list of edge structures.</p>" 1708 } 1709 }, 1710 "documentation":"<p>Summary information about the graph.</p>" 1711 }, 1712 "GraphId":{ 1713 "type":"string", 1714 "pattern":"g-[a-z0-9]{10}" 1715 }, 1716 "GraphIdentifier":{ 1717 "type":"string", 1718 "pattern":"g-[a-z0-9]{10}" 1719 }, 1720 "GraphName":{ 1721 "type":"string", 1722 "max":63, 1723 "min":1, 1724 "pattern":"(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*" 1725 }, 1726 "GraphSnapshotSummary":{ 1727 "type":"structure", 1728 "required":[ 1729 "id", 1730 "name", 1731 "arn" 1732 ], 1733 "members":{ 1734 "id":{ 1735 "shape":"SnapshotId", 1736 "documentation":"<p>The unique identifier of the graph snapshot.</p>" 1737 }, 1738 "name":{ 1739 "shape":"SnapshotName", 1740 "documentation":"<p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.</p>" 1741 }, 1742 "arn":{ 1743 "shape":"String", 1744 "documentation":"<p>The ARN of the graph snapshot.</p>" 1745 }, 1746 "sourceGraphId":{ 1747 "shape":"GraphId", 1748 "documentation":"<p>The graph identifier for the graph for which a snapshot is to be created.</p>" 1749 }, 1750 "snapshotCreateTime":{ 1751 "shape":"Timestamp", 1752 "documentation":"<p>The time when the snapshot was created.</p>" 1753 }, 1754 "status":{ 1755 "shape":"SnapshotStatus", 1756 "documentation":"<p>The status of the graph snapshot.</p>" 1757 }, 1758 "kmsKeyIdentifier":{ 1759 "shape":"KmsKeyArn", 1760 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>" 1761 } 1762 }, 1763 "documentation":"<p>Details about a graph snapshot.</p>" 1764 }, 1765 "GraphSnapshotSummaryList":{ 1766 "type":"list", 1767 "member":{"shape":"GraphSnapshotSummary"} 1768 }, 1769 "GraphStatus":{ 1770 "type":"string", 1771 "enum":[ 1772 "CREATING", 1773 "AVAILABLE", 1774 "DELETING", 1775 "RESETTING", 1776 "UPDATING", 1777 "SNAPSHOTTING", 1778 "FAILED" 1779 ] 1780 }, 1781 "GraphSummary":{ 1782 "type":"structure", 1783 "required":[ 1784 "id", 1785 "name", 1786 "arn" 1787 ], 1788 "members":{ 1789 "id":{ 1790 "shape":"GraphId", 1791 "documentation":"<p>The unique identifier of the graph.</p>" 1792 }, 1793 "name":{ 1794 "shape":"GraphName", 1795 "documentation":"<p>The name of the graph.</p>" 1796 }, 1797 "arn":{ 1798 "shape":"String", 1799 "documentation":"<p>The ARN associated with the graph.</p>" 1800 }, 1801 "status":{ 1802 "shape":"GraphStatus", 1803 "documentation":"<p>The status of the graph.</p>" 1804 }, 1805 "provisionedMemory":{ 1806 "shape":"ProvisionedMemory", 1807 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 1808 }, 1809 "publicConnectivity":{ 1810 "shape":"Boolean", 1811 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 1812 }, 1813 "endpoint":{ 1814 "shape":"String", 1815 "documentation":"<p>The graph endpoint.</p>" 1816 }, 1817 "replicaCount":{ 1818 "shape":"ReplicaCount", 1819 "documentation":"<p>The number of replicas for the graph.</p>" 1820 }, 1821 "kmsKeyIdentifier":{ 1822 "shape":"String", 1823 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 1824 }, 1825 "deletionProtection":{ 1826 "shape":"Boolean", 1827 "documentation":"<p>If <code>true</code>, deletion protection is enabled for the graph.</p>" 1828 } 1829 }, 1830 "documentation":"<p>Summary details about a graph.</p>" 1831 }, 1832 "GraphSummaryList":{ 1833 "type":"list", 1834 "member":{"shape":"GraphSummary"} 1835 }, 1836 "GraphSummaryMode":{ 1837 "type":"string", 1838 "enum":[ 1839 "BASIC", 1840 "DETAILED" 1841 ] 1842 }, 1843 "ImportOptions":{ 1844 "type":"structure", 1845 "members":{ 1846 "neptune":{ 1847 "shape":"NeptuneImportOptions", 1848 "documentation":"<p>Options for importing data from a Neptune database.</p>" 1849 } 1850 }, 1851 "documentation":"<p>Options for how to perform an import.</p>", 1852 "union":true 1853 }, 1854 "ImportTaskDetails":{ 1855 "type":"structure", 1856 "required":[ 1857 "status", 1858 "startTime", 1859 "timeElapsedSeconds", 1860 "progressPercentage", 1861 "errorCount", 1862 "statementCount", 1863 "dictionaryEntryCount" 1864 ], 1865 "members":{ 1866 "status":{ 1867 "shape":"String", 1868 "documentation":"<p>Status of the import task.</p>" 1869 }, 1870 "startTime":{ 1871 "shape":"Timestamp", 1872 "documentation":"<p>Time at which the import task started.</p>" 1873 }, 1874 "timeElapsedSeconds":{ 1875 "shape":"Long", 1876 "documentation":"<p>Seconds elapsed since the import task started.</p>" 1877 }, 1878 "progressPercentage":{ 1879 "shape":"Integer", 1880 "documentation":"<p>The percentage progress so far.</p>" 1881 }, 1882 "errorCount":{ 1883 "shape":"Integer", 1884 "documentation":"<p>The number of errors encountered so far.</p>" 1885 }, 1886 "errorDetails":{ 1887 "shape":"String", 1888 "documentation":"<p>Details about the errors that have been encountered.</p>" 1889 }, 1890 "statementCount":{ 1891 "shape":"Long", 1892 "documentation":"<p>The number of statements in the import task.</p>" 1893 }, 1894 "dictionaryEntryCount":{ 1895 "shape":"Long", 1896 "documentation":"<p>The number of dictionary entries in the import task.</p>" 1897 } 1898 }, 1899 "documentation":"<p>Contains details about an import task.</p>" 1900 }, 1901 "ImportTaskStatus":{ 1902 "type":"string", 1903 "enum":[ 1904 "INITIALIZING", 1905 "EXPORTING", 1906 "ANALYZING_DATA", 1907 "IMPORTING", 1908 "REPROVISIONING", 1909 "ROLLING_BACK", 1910 "SUCCEEDED", 1911 "FAILED", 1912 "CANCELLING", 1913 "CANCELLED" 1914 ] 1915 }, 1916 "ImportTaskSummary":{ 1917 "type":"structure", 1918 "required":[ 1919 "taskId", 1920 "source", 1921 "roleArn", 1922 "status" 1923 ], 1924 "members":{ 1925 "graphId":{ 1926 "shape":"GraphId", 1927 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>" 1928 }, 1929 "taskId":{ 1930 "shape":"TaskId", 1931 "documentation":"<p>The unique identifier of the import task.</p>" 1932 }, 1933 "source":{ 1934 "shape":"String", 1935 "documentation":"<p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot</p>" 1936 }, 1937 "format":{ 1938 "shape":"Format", 1939 "documentation":"<p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html\">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html\">openCypher load format</a>.</p>" 1940 }, 1941 "roleArn":{ 1942 "shape":"RoleArn", 1943 "documentation":"<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>" 1944 }, 1945 "status":{ 1946 "shape":"ImportTaskStatus", 1947 "documentation":"<p>Status of the import task.</p>" 1948 } 1949 }, 1950 "documentation":"<p>Details about an import task.</p>" 1951 }, 1952 "ImportTaskSummaryList":{ 1953 "type":"list", 1954 "member":{"shape":"ImportTaskSummary"} 1955 }, 1956 "Integer":{ 1957 "type":"integer", 1958 "box":true 1959 }, 1960 "InternalServerException":{ 1961 "type":"structure", 1962 "required":["message"], 1963 "members":{ 1964 "message":{ 1965 "shape":"String", 1966 "documentation":"<p>A message describing the problem.</p>" 1967 } 1968 }, 1969 "documentation":"<p>A failure occurred on the server.</p>", 1970 "error":{"httpStatusCode":500}, 1971 "exception":true, 1972 "fault":true, 1973 "retryable":{"throttling":false} 1974 }, 1975 "KmsKeyArn":{ 1976 "type":"string", 1977 "max":1024, 1978 "min":1, 1979 "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" 1980 }, 1981 "ListGraphSnapshotsInput":{ 1982 "type":"structure", 1983 "members":{ 1984 "graphIdentifier":{ 1985 "shape":"GraphIdentifier", 1986 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 1987 "location":"querystring", 1988 "locationName":"graphIdentifier" 1989 }, 1990 "nextToken":{ 1991 "shape":"PaginationToken", 1992 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>", 1993 "location":"querystring", 1994 "locationName":"nextToken" 1995 }, 1996 "maxResults":{ 1997 "shape":"MaxResults", 1998 "documentation":"<p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>", 1999 "location":"querystring", 2000 "locationName":"maxResults" 2001 } 2002 } 2003 }, 2004 "ListGraphSnapshotsOutput":{ 2005 "type":"structure", 2006 "required":["graphSnapshots"], 2007 "members":{ 2008 "graphSnapshots":{ 2009 "shape":"GraphSnapshotSummaryList", 2010 "documentation":"<p>The requested list of snapshots.</p>" 2011 }, 2012 "nextToken":{ 2013 "shape":"PaginationToken", 2014 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>" 2015 } 2016 } 2017 }, 2018 "ListGraphsInput":{ 2019 "type":"structure", 2020 "members":{ 2021 "nextToken":{ 2022 "shape":"PaginationToken", 2023 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>", 2024 "location":"querystring", 2025 "locationName":"nextToken" 2026 }, 2027 "maxResults":{ 2028 "shape":"MaxResults", 2029 "documentation":"<p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>", 2030 "location":"querystring", 2031 "locationName":"maxResults" 2032 } 2033 } 2034 }, 2035 "ListGraphsOutput":{ 2036 "type":"structure", 2037 "required":["graphs"], 2038 "members":{ 2039 "graphs":{ 2040 "shape":"GraphSummaryList", 2041 "documentation":"<p>A list of the graphs.</p>" 2042 }, 2043 "nextToken":{ 2044 "shape":"PaginationToken", 2045 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>" 2046 } 2047 } 2048 }, 2049 "ListImportTasksInput":{ 2050 "type":"structure", 2051 "members":{ 2052 "nextToken":{ 2053 "shape":"PaginationToken", 2054 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>", 2055 "location":"querystring", 2056 "locationName":"nextToken" 2057 }, 2058 "maxResults":{ 2059 "shape":"MaxResults", 2060 "documentation":"<p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>", 2061 "location":"querystring", 2062 "locationName":"maxResults" 2063 } 2064 } 2065 }, 2066 "ListImportTasksOutput":{ 2067 "type":"structure", 2068 "required":["tasks"], 2069 "members":{ 2070 "tasks":{ 2071 "shape":"ImportTaskSummaryList", 2072 "documentation":"<p>The requested list of import tasks.</p>" 2073 }, 2074 "nextToken":{ 2075 "shape":"PaginationToken", 2076 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>" 2077 } 2078 } 2079 }, 2080 "ListPrivateGraphEndpointsInput":{ 2081 "type":"structure", 2082 "required":["graphIdentifier"], 2083 "members":{ 2084 "graphIdentifier":{ 2085 "shape":"GraphIdentifier", 2086 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 2087 "location":"uri", 2088 "locationName":"graphIdentifier" 2089 }, 2090 "nextToken":{ 2091 "shape":"PaginationToken", 2092 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>", 2093 "location":"querystring", 2094 "locationName":"nextToken" 2095 }, 2096 "maxResults":{ 2097 "shape":"MaxResults", 2098 "documentation":"<p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>", 2099 "location":"querystring", 2100 "locationName":"maxResults" 2101 } 2102 } 2103 }, 2104 "ListPrivateGraphEndpointsOutput":{ 2105 "type":"structure", 2106 "required":["privateGraphEndpoints"], 2107 "members":{ 2108 "privateGraphEndpoints":{ 2109 "shape":"PrivateGraphEndpointSummaryList", 2110 "documentation":"<p>A list of private endpoints for the specified Neptune Analytics graph.</p>" 2111 }, 2112 "nextToken":{ 2113 "shape":"PaginationToken", 2114 "documentation":"<p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>" 2115 } 2116 } 2117 }, 2118 "ListQueriesInput":{ 2119 "type":"structure", 2120 "required":[ 2121 "graphIdentifier", 2122 "maxResults" 2123 ], 2124 "members":{ 2125 "graphIdentifier":{ 2126 "shape":"GraphIdentifier", 2127 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 2128 "hostLabel":true, 2129 "location":"header", 2130 "locationName":"graphIdentifier" 2131 }, 2132 "maxResults":{ 2133 "shape":"Integer", 2134 "documentation":"<p>The maximum number of results to be fetched by the API.</p>", 2135 "location":"querystring", 2136 "locationName":"maxResults" 2137 }, 2138 "state":{ 2139 "shape":"QueryStateInput", 2140 "documentation":"<p>Filtered list of queries based on state.</p>", 2141 "location":"querystring", 2142 "locationName":"state" 2143 } 2144 } 2145 }, 2146 "ListQueriesOutput":{ 2147 "type":"structure", 2148 "required":["queries"], 2149 "members":{ 2150 "queries":{ 2151 "shape":"QuerySummaryList", 2152 "documentation":"<p>A list of current openCypher queries.</p>" 2153 } 2154 } 2155 }, 2156 "ListTagsForResourceInput":{ 2157 "type":"structure", 2158 "required":["resourceArn"], 2159 "members":{ 2160 "resourceArn":{ 2161 "shape":"Arn", 2162 "documentation":"<p>The ARN of the resource.</p>", 2163 "location":"uri", 2164 "locationName":"resourceArn" 2165 } 2166 } 2167 }, 2168 "ListTagsForResourceOutput":{ 2169 "type":"structure", 2170 "members":{ 2171 "tags":{ 2172 "shape":"TagMap", 2173 "documentation":"<p>The list of metadata tags associated with the resource.</p>" 2174 } 2175 } 2176 }, 2177 "Long":{ 2178 "type":"long", 2179 "box":true 2180 }, 2181 "LongValuedMap":{ 2182 "type":"map", 2183 "key":{"shape":"String"}, 2184 "value":{"shape":"Long"} 2185 }, 2186 "LongValuedMapList":{ 2187 "type":"list", 2188 "member":{"shape":"LongValuedMap"} 2189 }, 2190 "MaxResults":{ 2191 "type":"integer", 2192 "box":true, 2193 "max":100, 2194 "min":1 2195 }, 2196 "NeptuneImportOptions":{ 2197 "type":"structure", 2198 "required":[ 2199 "s3ExportPath", 2200 "s3ExportKmsKeyId" 2201 ], 2202 "members":{ 2203 "s3ExportPath":{ 2204 "shape":"NeptuneImportOptionsS3ExportPathString", 2205 "documentation":"<p>The path to an S3 bucket from which to import data.</p>" 2206 }, 2207 "s3ExportKmsKeyId":{ 2208 "shape":"NeptuneImportOptionsS3ExportKmsKeyIdString", 2209 "documentation":"<p>The KMS key to use to encrypt data in the S3 bucket where the graph data is exported</p>" 2210 }, 2211 "preserveDefaultVertexLabels":{ 2212 "shape":"Boolean", 2213 "documentation":"<p>Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting <i>preserveDefaultVertexLabels</i> to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.</p>" 2214 }, 2215 "preserveEdgeIds":{ 2216 "shape":"Boolean", 2217 "documentation":"<p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as properties on the relationships with the property name <i>neptuneEdgeId</i>.</p>" 2218 } 2219 }, 2220 "documentation":"<p>Options for how to import Neptune data.</p>" 2221 }, 2222 "NeptuneImportOptionsS3ExportKmsKeyIdString":{ 2223 "type":"string", 2224 "max":1024, 2225 "min":1 2226 }, 2227 "NeptuneImportOptionsS3ExportPathString":{ 2228 "type":"string", 2229 "max":1024, 2230 "min":1 2231 }, 2232 "NodeLabels":{ 2233 "type":"list", 2234 "member":{"shape":"String"} 2235 }, 2236 "NodeProperties":{ 2237 "type":"list", 2238 "member":{"shape":"String"} 2239 }, 2240 "NodeStructure":{ 2241 "type":"structure", 2242 "members":{ 2243 "count":{ 2244 "shape":"Long", 2245 "documentation":"<p>The number of instances of this node.</p>" 2246 }, 2247 "nodeProperties":{ 2248 "shape":"NodeProperties", 2249 "documentation":"<p>Properties associated with this node.</p>" 2250 }, 2251 "distinctOutgoingEdgeLabels":{ 2252 "shape":"OutgoingEdgeLabels", 2253 "documentation":"<p>The outgoing edge labels associated with this node.</p>" 2254 } 2255 }, 2256 "documentation":"<p>Information about a node.</p>" 2257 }, 2258 "NodeStructures":{ 2259 "type":"list", 2260 "member":{"shape":"NodeStructure"} 2261 }, 2262 "OutgoingEdgeLabels":{ 2263 "type":"list", 2264 "member":{"shape":"String"} 2265 }, 2266 "PaginationToken":{ 2267 "type":"string", 2268 "max":8192, 2269 "min":1 2270 }, 2271 "PlanCacheType":{ 2272 "type":"string", 2273 "enum":[ 2274 "ENABLED", 2275 "DISABLED", 2276 "AUTO" 2277 ] 2278 }, 2279 "PrivateGraphEndpointStatus":{ 2280 "type":"string", 2281 "enum":[ 2282 "CREATING", 2283 "AVAILABLE", 2284 "DELETING", 2285 "FAILED" 2286 ] 2287 }, 2288 "PrivateGraphEndpointSummary":{ 2289 "type":"structure", 2290 "required":[ 2291 "vpcId", 2292 "subnetIds", 2293 "status" 2294 ], 2295 "members":{ 2296 "vpcId":{ 2297 "shape":"VpcId", 2298 "documentation":"<p>The ID of the VPC in which the private graph endpoint is located.</p>" 2299 }, 2300 "subnetIds":{ 2301 "shape":"SubnetIds", 2302 "documentation":"<p>The subnet IDs associated with the private graph endpoint.</p>" 2303 }, 2304 "status":{ 2305 "shape":"PrivateGraphEndpointStatus", 2306 "documentation":"<p>The status of the private graph endpoint.</p>" 2307 }, 2308 "vpcEndpointId":{ 2309 "shape":"VpcEndpointId", 2310 "documentation":"<p>The ID of the VPC endpoint.</p>" 2311 } 2312 }, 2313 "documentation":"<p>Details about a private graph endpoint.</p>" 2314 }, 2315 "PrivateGraphEndpointSummaryList":{ 2316 "type":"list", 2317 "member":{"shape":"PrivateGraphEndpointSummary"} 2318 }, 2319 "ProvisionedMemory":{ 2320 "type":"integer", 2321 "box":true, 2322 "max":24576, 2323 "min":128 2324 }, 2325 "QueryLanguage":{ 2326 "type":"string", 2327 "enum":["OPEN_CYPHER"] 2328 }, 2329 "QueryResponseBlob":{ 2330 "type":"blob", 2331 "streaming":true 2332 }, 2333 "QueryState":{ 2334 "type":"string", 2335 "enum":[ 2336 "RUNNING", 2337 "WAITING", 2338 "CANCELLING" 2339 ] 2340 }, 2341 "QueryStateInput":{ 2342 "type":"string", 2343 "enum":[ 2344 "ALL", 2345 "RUNNING", 2346 "WAITING", 2347 "CANCELLING" 2348 ] 2349 }, 2350 "QuerySummary":{ 2351 "type":"structure", 2352 "members":{ 2353 "id":{ 2354 "shape":"String", 2355 "documentation":"<p>A string representation of the id of the query.</p>" 2356 }, 2357 "queryString":{ 2358 "shape":"String", 2359 "documentation":"<p>The actual query text. The <code>queryString</code> may be truncated if the actual query string is too long.</p>" 2360 }, 2361 "waited":{ 2362 "shape":"Integer", 2363 "documentation":"<p>The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.</p>" 2364 }, 2365 "elapsed":{ 2366 "shape":"Integer", 2367 "documentation":"<p>The running time of the query, in milliseconds.</p>" 2368 }, 2369 "state":{ 2370 "shape":"QueryState", 2371 "documentation":"<p>State of the query.</p>" 2372 } 2373 }, 2374 "documentation":"<p>Details of the query listed.</p>" 2375 }, 2376 "QuerySummaryList":{ 2377 "type":"list", 2378 "member":{"shape":"QuerySummary"} 2379 }, 2380 "ReplicaCount":{ 2381 "type":"integer", 2382 "box":true, 2383 "max":2, 2384 "min":0 2385 }, 2386 "ResetGraphInput":{ 2387 "type":"structure", 2388 "required":[ 2389 "graphIdentifier", 2390 "skipSnapshot" 2391 ], 2392 "members":{ 2393 "graphIdentifier":{ 2394 "shape":"GraphIdentifier", 2395 "documentation":"<p>ID of the graph to reset.</p>", 2396 "location":"uri", 2397 "locationName":"graphIdentifier" 2398 }, 2399 "skipSnapshot":{ 2400 "shape":"Boolean", 2401 "documentation":"<p>Determines whether a final graph snapshot is created before the graph data is deleted. If set to <code>true</code>, no graph snapshot is created. If set to <code>false</code>, a graph snapshot is created before the data is deleted.</p>" 2402 } 2403 } 2404 }, 2405 "ResetGraphOutput":{ 2406 "type":"structure", 2407 "required":[ 2408 "id", 2409 "name", 2410 "arn" 2411 ], 2412 "members":{ 2413 "id":{ 2414 "shape":"GraphId", 2415 "documentation":"<p>The unique identifier of the graph.</p>" 2416 }, 2417 "name":{ 2418 "shape":"GraphName", 2419 "documentation":"<p>The name of the graph.</p>" 2420 }, 2421 "arn":{ 2422 "shape":"String", 2423 "documentation":"<p>The ARN associated with the graph.</p>" 2424 }, 2425 "status":{ 2426 "shape":"GraphStatus", 2427 "documentation":"<p>The status of the graph.</p>" 2428 }, 2429 "statusReason":{ 2430 "shape":"String", 2431 "documentation":"<p>The reason that the graph has this status.</p>" 2432 }, 2433 "createTime":{ 2434 "shape":"Timestamp", 2435 "documentation":"<p>The time at which the graph was created.</p>" 2436 }, 2437 "provisionedMemory":{ 2438 "shape":"ProvisionedMemory", 2439 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 2440 }, 2441 "endpoint":{ 2442 "shape":"String", 2443 "documentation":"<p>The graph endpoint.</p>" 2444 }, 2445 "publicConnectivity":{ 2446 "shape":"Boolean", 2447 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 2448 }, 2449 "vectorSearchConfiguration":{"shape":"VectorSearchConfiguration"}, 2450 "replicaCount":{ 2451 "shape":"ReplicaCount", 2452 "documentation":"<p>The number of replicas for the graph.</p>" 2453 }, 2454 "kmsKeyIdentifier":{ 2455 "shape":"KmsKeyArn", 2456 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 2457 }, 2458 "sourceSnapshotId":{ 2459 "shape":"SnapshotId", 2460 "documentation":"<p>The ID of the snapshot from which the graph was created, if any.</p>" 2461 }, 2462 "deletionProtection":{ 2463 "shape":"Boolean", 2464 "documentation":"<p>If <code>true</code>, deletion protection is enabled for the graph.</p>" 2465 }, 2466 "buildNumber":{ 2467 "shape":"String", 2468 "documentation":"<p>The build number of the graph.</p>" 2469 } 2470 } 2471 }, 2472 "ResourceNotFoundException":{ 2473 "type":"structure", 2474 "required":["message"], 2475 "members":{ 2476 "message":{ 2477 "shape":"String", 2478 "documentation":"<p>A message describing the problem.</p>" 2479 } 2480 }, 2481 "documentation":"<p>A specified resource could not be located.</p>", 2482 "error":{ 2483 "httpStatusCode":404, 2484 "senderFault":true 2485 }, 2486 "exception":true 2487 }, 2488 "RestoreGraphFromSnapshotInput":{ 2489 "type":"structure", 2490 "required":[ 2491 "snapshotIdentifier", 2492 "graphName" 2493 ], 2494 "members":{ 2495 "snapshotIdentifier":{ 2496 "shape":"SnapshotIdentifier", 2497 "documentation":"<p>The ID of the snapshot in question.</p>", 2498 "location":"uri", 2499 "locationName":"snapshotIdentifier" 2500 }, 2501 "graphName":{ 2502 "shape":"GraphName", 2503 "documentation":"<p>A name for the new Neptune Analytics graph to be created from the snapshot.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. </p>" 2504 }, 2505 "provisionedMemory":{ 2506 "shape":"ProvisionedMemory", 2507 "documentation":"<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>" 2508 }, 2509 "deletionProtection":{ 2510 "shape":"Boolean", 2511 "documentation":"<p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>" 2512 }, 2513 "tags":{ 2514 "shape":"TagMap", 2515 "documentation":"<p>Adds metadata tags to the snapshot. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>" 2516 }, 2517 "replicaCount":{ 2518 "shape":"ReplicaCount", 2519 "documentation":"<p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>" 2520 }, 2521 "publicConnectivity":{ 2522 "shape":"Boolean", 2523 "documentation":"<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable).</p>" 2524 } 2525 } 2526 }, 2527 "RestoreGraphFromSnapshotOutput":{ 2528 "type":"structure", 2529 "required":[ 2530 "id", 2531 "name", 2532 "arn" 2533 ], 2534 "members":{ 2535 "id":{ 2536 "shape":"GraphId", 2537 "documentation":"<p>The unique identifier of the graph.</p>" 2538 }, 2539 "name":{ 2540 "shape":"GraphName", 2541 "documentation":"<p>The name of the graph.</p>" 2542 }, 2543 "arn":{ 2544 "shape":"String", 2545 "documentation":"<p>The ARN associated with the graph.</p>" 2546 }, 2547 "status":{ 2548 "shape":"GraphStatus", 2549 "documentation":"<p>The status of the graph.</p>" 2550 }, 2551 "statusReason":{ 2552 "shape":"String", 2553 "documentation":"<p>The reason that the graph has this status.</p>" 2554 }, 2555 "createTime":{ 2556 "shape":"Timestamp", 2557 "documentation":"<p>The time at which the graph was created.</p>" 2558 }, 2559 "provisionedMemory":{ 2560 "shape":"ProvisionedMemory", 2561 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 2562 }, 2563 "endpoint":{ 2564 "shape":"String", 2565 "documentation":"<p>The graph endpoint.</p>" 2566 }, 2567 "publicConnectivity":{ 2568 "shape":"Boolean", 2569 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 2570 }, 2571 "vectorSearchConfiguration":{"shape":"VectorSearchConfiguration"}, 2572 "replicaCount":{ 2573 "shape":"ReplicaCount", 2574 "documentation":"<p>The number of replicas for the graph.</p>" 2575 }, 2576 "kmsKeyIdentifier":{ 2577 "shape":"KmsKeyArn", 2578 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 2579 }, 2580 "sourceSnapshotId":{ 2581 "shape":"SnapshotId", 2582 "documentation":"<p>The ID of the snapshot from which the graph was created, if any.</p>" 2583 }, 2584 "deletionProtection":{ 2585 "shape":"Boolean", 2586 "documentation":"<p>If <code>true</code>, deletion protection is enabled for the graph.</p>" 2587 }, 2588 "buildNumber":{ 2589 "shape":"String", 2590 "documentation":"<p>The build number of the graph.</p>" 2591 } 2592 } 2593 }, 2594 "RoleArn":{ 2595 "type":"string", 2596 "pattern":"arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*" 2597 }, 2598 "SecurityGroupId":{ 2599 "type":"string", 2600 "pattern":"sg-[a-z0-9]+" 2601 }, 2602 "SecurityGroupIds":{ 2603 "type":"list", 2604 "member":{"shape":"SecurityGroupId"}, 2605 "max":10, 2606 "min":1 2607 }, 2608 "ServiceQuotaExceededException":{ 2609 "type":"structure", 2610 "required":["message"], 2611 "members":{ 2612 "message":{"shape":"String"}, 2613 "resourceId":{ 2614 "shape":"String", 2615 "documentation":"<p>The identifier of the resource that exceeded quota.</p>" 2616 }, 2617 "resourceType":{ 2618 "shape":"String", 2619 "documentation":"<p>The type of the resource that exceeded quota. Ex: Graph, Snapshot</p>" 2620 }, 2621 "serviceCode":{ 2622 "shape":"String", 2623 "documentation":"<p>The service code that exceeded quota.</p>" 2624 }, 2625 "quotaCode":{ 2626 "shape":"String", 2627 "documentation":"<p>Service quota code of the resource for which quota was exceeded.</p>" 2628 } 2629 }, 2630 "documentation":"<p>A service quota was exceeded.</p>", 2631 "error":{ 2632 "httpStatusCode":402, 2633 "senderFault":true 2634 }, 2635 "exception":true 2636 }, 2637 "SnapshotId":{ 2638 "type":"string", 2639 "pattern":"gs-[a-z0-9]{10}" 2640 }, 2641 "SnapshotIdentifier":{ 2642 "type":"string", 2643 "pattern":"gs-[a-z0-9]{10}" 2644 }, 2645 "SnapshotName":{ 2646 "type":"string", 2647 "max":63, 2648 "min":1, 2649 "pattern":"(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*" 2650 }, 2651 "SnapshotStatus":{ 2652 "type":"string", 2653 "enum":[ 2654 "CREATING", 2655 "AVAILABLE", 2656 "DELETING", 2657 "FAILED" 2658 ] 2659 }, 2660 "String":{"type":"string"}, 2661 "SubnetId":{ 2662 "type":"string", 2663 "pattern":"subnet-[a-z0-9]+" 2664 }, 2665 "SubnetIds":{ 2666 "type":"list", 2667 "member":{"shape":"SubnetId"}, 2668 "max":6, 2669 "min":1 2670 }, 2671 "SyntheticTimestamp_date_time":{ 2672 "type":"timestamp", 2673 "timestampFormat":"iso8601" 2674 }, 2675 "TagKey":{ 2676 "type":"string", 2677 "max":128, 2678 "min":1, 2679 "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" 2680 }, 2681 "TagKeyList":{ 2682 "type":"list", 2683 "member":{"shape":"TagKey"}, 2684 "max":50, 2685 "min":0 2686 }, 2687 "TagMap":{ 2688 "type":"map", 2689 "key":{"shape":"TagKey"}, 2690 "value":{"shape":"TagValue"}, 2691 "max":50, 2692 "min":0 2693 }, 2694 "TagResourceInput":{ 2695 "type":"structure", 2696 "required":[ 2697 "resourceArn", 2698 "tags" 2699 ], 2700 "members":{ 2701 "resourceArn":{ 2702 "shape":"Arn", 2703 "documentation":"<p>ARN of the resource for which tags need to be added.</p>", 2704 "location":"uri", 2705 "locationName":"resourceArn" 2706 }, 2707 "tags":{ 2708 "shape":"TagMap", 2709 "documentation":"<p>The tags to be assigned to the Neptune Analytics resource.</p> <p>The tags are metadata that are specified as a list of key-value pairs:</p> <p> <b>Key</b> (string) – A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length. It can't be prefixed with <code>aws:</code> and can only contain the set of Unicode characters specified by this Java regular expression: <code>\"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\")</code>.</p> <p> <b>Value</b> (string) – A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length. It can't be prefixed with <code>aws:</code> and can only contain the set of Unicode characters specified by this Java regular expression: <code>\"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\")</code>.</p>" 2710 } 2711 } 2712 }, 2713 "TagResourceOutput":{ 2714 "type":"structure", 2715 "members":{ 2716 } 2717 }, 2718 "TagValue":{ 2719 "type":"string", 2720 "max":256, 2721 "min":0 2722 }, 2723 "TaskId":{ 2724 "type":"string", 2725 "pattern":"t-[a-z0-9]{10}" 2726 }, 2727 "ThrottlingException":{ 2728 "type":"structure", 2729 "required":["message"], 2730 "members":{ 2731 "message":{ 2732 "shape":"String", 2733 "documentation":"<p>A message describing the problem.</p>" 2734 } 2735 }, 2736 "documentation":"<p>The exception was interrupted by throttling.</p>", 2737 "error":{ 2738 "httpStatusCode":429, 2739 "senderFault":true 2740 }, 2741 "exception":true, 2742 "retryable":{"throttling":true} 2743 }, 2744 "Timestamp":{"type":"timestamp"}, 2745 "UnprocessableException":{ 2746 "type":"structure", 2747 "required":[ 2748 "message", 2749 "reason" 2750 ], 2751 "members":{ 2752 "message":{"shape":"String"}, 2753 "reason":{ 2754 "shape":"UnprocessableExceptionReason", 2755 "documentation":"<p>The reason for the unprocessable exception.</p>" 2756 } 2757 }, 2758 "documentation":"<p>Request cannot be processed due to known reasons. Eg. partition full.</p>", 2759 "error":{ 2760 "httpStatusCode":422, 2761 "senderFault":true 2762 }, 2763 "exception":true 2764 }, 2765 "UnprocessableExceptionReason":{ 2766 "type":"string", 2767 "enum":[ 2768 "QUERY_TIMEOUT", 2769 "INTERNAL_LIMIT_EXCEEDED", 2770 "MEMORY_LIMIT_EXCEEDED", 2771 "STORAGE_LIMIT_EXCEEDED", 2772 "PARTITION_FULL" 2773 ] 2774 }, 2775 "UntagResourceInput":{ 2776 "type":"structure", 2777 "required":[ 2778 "resourceArn", 2779 "tagKeys" 2780 ], 2781 "members":{ 2782 "resourceArn":{ 2783 "shape":"Arn", 2784 "documentation":"<p>ARN of the resource whose tag needs to be removed.</p>", 2785 "location":"uri", 2786 "locationName":"resourceArn" 2787 }, 2788 "tagKeys":{ 2789 "shape":"TagKeyList", 2790 "documentation":"<p>Tag keys for the tags to be removed.</p>", 2791 "location":"querystring", 2792 "locationName":"tagKeys" 2793 } 2794 } 2795 }, 2796 "UntagResourceOutput":{ 2797 "type":"structure", 2798 "members":{ 2799 } 2800 }, 2801 "UpdateGraphInput":{ 2802 "type":"structure", 2803 "required":["graphIdentifier"], 2804 "members":{ 2805 "graphIdentifier":{ 2806 "shape":"GraphIdentifier", 2807 "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", 2808 "location":"uri", 2809 "locationName":"graphIdentifier" 2810 }, 2811 "publicConnectivity":{ 2812 "shape":"Boolean", 2813 "documentation":"<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>" 2814 }, 2815 "provisionedMemory":{ 2816 "shape":"ProvisionedMemory", 2817 "documentation":"<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>" 2818 }, 2819 "deletionProtection":{ 2820 "shape":"Boolean", 2821 "documentation":"<p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>" 2822 } 2823 } 2824 }, 2825 "UpdateGraphOutput":{ 2826 "type":"structure", 2827 "required":[ 2828 "id", 2829 "name", 2830 "arn" 2831 ], 2832 "members":{ 2833 "id":{ 2834 "shape":"GraphId", 2835 "documentation":"<p>The unique identifier of the graph.</p>" 2836 }, 2837 "name":{ 2838 "shape":"GraphName", 2839 "documentation":"<p>The name of the graph.</p>" 2840 }, 2841 "arn":{ 2842 "shape":"String", 2843 "documentation":"<p>The ARN associated with the graph.</p>" 2844 }, 2845 "status":{ 2846 "shape":"GraphStatus", 2847 "documentation":"<p>The status of the graph.</p>" 2848 }, 2849 "statusReason":{ 2850 "shape":"String", 2851 "documentation":"<p>The reason that the graph has this status.</p>" 2852 }, 2853 "createTime":{ 2854 "shape":"Timestamp", 2855 "documentation":"<p>The time at which the graph was created.</p>" 2856 }, 2857 "provisionedMemory":{ 2858 "shape":"ProvisionedMemory", 2859 "documentation":"<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>" 2860 }, 2861 "endpoint":{ 2862 "shape":"String", 2863 "documentation":"<p>The graph endpoint.</p>" 2864 }, 2865 "publicConnectivity":{ 2866 "shape":"Boolean", 2867 "documentation":"<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>" 2868 }, 2869 "vectorSearchConfiguration":{"shape":"VectorSearchConfiguration"}, 2870 "replicaCount":{ 2871 "shape":"ReplicaCount", 2872 "documentation":"<p>The number of replicas for the graph.</p>" 2873 }, 2874 "kmsKeyIdentifier":{ 2875 "shape":"KmsKeyArn", 2876 "documentation":"<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>" 2877 }, 2878 "sourceSnapshotId":{ 2879 "shape":"SnapshotId", 2880 "documentation":"<p>The ID of the snapshot from which the graph was created, if any.</p>" 2881 }, 2882 "deletionProtection":{ 2883 "shape":"Boolean", 2884 "documentation":"<p>If <code>true</code>, deletion protection is enabled for the graph.</p>" 2885 }, 2886 "buildNumber":{ 2887 "shape":"String", 2888 "documentation":"<p>The build number of the graph.</p>" 2889 } 2890 } 2891 }, 2892 "ValidationException":{ 2893 "type":"structure", 2894 "required":["message"], 2895 "members":{ 2896 "message":{ 2897 "shape":"String", 2898 "documentation":"<p>A message describing the problem.</p>" 2899 }, 2900 "reason":{ 2901 "shape":"ValidationExceptionReason", 2902 "documentation":"<p>The reason that the resource could not be validated.</p>" 2903 } 2904 }, 2905 "documentation":"<p>A resource could not be validated.</p>", 2906 "error":{ 2907 "httpStatusCode":400, 2908 "senderFault":true 2909 }, 2910 "exception":true 2911 }, 2912 "ValidationExceptionReason":{ 2913 "type":"string", 2914 "enum":[ 2915 "CONSTRAINT_VIOLATION", 2916 "ILLEGAL_ARGUMENT", 2917 "MALFORMED_QUERY", 2918 "QUERY_CANCELLED", 2919 "QUERY_TOO_LARGE", 2920 "UNSUPPORTED_OPERATION", 2921 "BAD_REQUEST" 2922 ] 2923 }, 2924 "VectorSearchConfiguration":{ 2925 "type":"structure", 2926 "required":["dimension"], 2927 "members":{ 2928 "dimension":{ 2929 "shape":"VectorSearchDimension", 2930 "documentation":"<p>The number of dimensions.</p>" 2931 } 2932 }, 2933 "documentation":"<p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>" 2934 }, 2935 "VectorSearchDimension":{ 2936 "type":"integer", 2937 "box":true, 2938 "max":65536, 2939 "min":1 2940 }, 2941 "VpcEndpointId":{ 2942 "type":"string", 2943 "pattern":"vpce-[0-9a-f]{17}" 2944 }, 2945 "VpcId":{ 2946 "type":"string", 2947 "pattern":"vpc-[a-z0-9]+" 2948 } 2949 }, 2950 "documentation":"<p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.</p>" 2951} 2952