# Actions


The following actions are supported:
+  [CancelExportTask](API_CancelExportTask.md) 
+  [CancelImportTask](API_CancelImportTask.md) 
+  [CancelQuery](API_CancelQuery.md) 
+  [CreateGraph](API_CreateGraph.md) 
+  [CreateGraphSnapshot](API_CreateGraphSnapshot.md) 
+  [CreateGraphUsingImportTask](API_CreateGraphUsingImportTask.md) 
+  [CreatePrivateGraphEndpoint](API_CreatePrivateGraphEndpoint.md) 
+  [DeleteGraph](API_DeleteGraph.md) 
+  [DeleteGraphSnapshot](API_DeleteGraphSnapshot.md) 
+  [DeletePrivateGraphEndpoint](API_DeletePrivateGraphEndpoint.md) 
+  [ExecuteQuery](API_ExecuteQuery.md) 
+  [GetExportTask](API_GetExportTask.md) 
+  [GetGraph](API_GetGraph.md) 
+  [GetGraphSnapshot](API_GetGraphSnapshot.md) 
+  [GetGraphSummary](API_GetGraphSummary.md) 
+  [GetImportTask](API_GetImportTask.md) 
+  [GetPrivateGraphEndpoint](API_GetPrivateGraphEndpoint.md) 
+  [GetQuery](API_GetQuery.md) 
+  [ListExportTasks](API_ListExportTasks.md) 
+  [ListGraphs](API_ListGraphs.md) 
+  [ListGraphSnapshots](API_ListGraphSnapshots.md) 
+  [ListImportTasks](API_ListImportTasks.md) 
+  [ListPrivateGraphEndpoints](API_ListPrivateGraphEndpoints.md) 
+  [ListQueries](API_ListQueries.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ResetGraph](API_ResetGraph.md) 
+  [RestoreGraphFromSnapshot](API_RestoreGraphFromSnapshot.md) 
+  [StartExportTask](API_StartExportTask.md) 
+  [StartGraph](API_StartGraph.md) 
+  [StartImportTask](API_StartImportTask.md) 
+  [StopGraph](API_StopGraph.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateGraph](API_UpdateGraph.md) 

# CancelExportTask


Cancel the specified export task.

## Request Syntax


```
DELETE /exporttasks/taskIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [taskIdentifier](#API_CancelExportTask_RequestSyntax) **   <a name="neptunegraph-CancelExportTask-request-uri-taskIdentifier"></a>
The unique identifier of the export task.  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "destination": "string",
   "format": "string",
   "graphId": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [destination](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-destination"></a>
The Amazon S3 URI of the cancelled export task where data will be exported to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [format](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-format"></a>
The format of the cancelled export task.  
Type: String  
Valid Values: `PARQUET | CSV` 

 ** [graphId](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-graphId"></a>
The source graph identifier of the cancelled export task.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-kmsKeyIdentifier"></a>
The KMS key identifier of the cancelled export task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [parquetType](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-parquetType"></a>
The parquet type of the cancelled export task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-roleArn"></a>
The ARN of the IAM role that will allow the exporting of data to the destination.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [status](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-status"></a>
The current status of the export task. The status is `CANCELLING` when the export task is cancelled.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [statusReason](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-statusReason"></a>
The reason that the export task has this status value.  
Type: String

 ** [taskId](#API_CancelExportTask_ResponseSyntax) **   <a name="neptunegraph-CancelExportTask-response-taskId"></a>
The unique identifier of the export task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CancelExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CancelExportTask) 

# CancelImportTask


Deletes the specified import task.

## Request Syntax


```
DELETE /importtasks/taskIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [taskIdentifier](#API_CancelImportTask_RequestSyntax) **   <a name="neptunegraph-CancelImportTask-request-uri-taskIdentifier"></a>
The unique identifier of the import task.  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "format": "string",
   "graphId": "string",
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [format](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-format"></a>
Specifies the format of S3 data to be imported. Valid values are `CSV`, which identifies the [Gremlin CSV format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) or `OPENCYPHER`, which identies the [openCypher load format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html).  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES` 

 ** [graphId](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-graphId"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [parquetType](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-parquetType"></a>
The parquet type of the cancelled import task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [source](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-source"></a>
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.  
Type: String

 ** [status](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-status"></a>
Current status of the task. Status is CANCELLING when the import task is cancelled.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | ANALYZING_DATA | IMPORTING | REPROVISIONING | ROLLING_BACK | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [taskId](#API_CancelImportTask_ResponseSyntax) **   <a name="neptunegraph-CancelImportTask-response-taskId"></a>
The unique identifier of the import task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CancelImportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CancelImportTask) 

# CancelQuery


Cancels a specified query.

## Request Syntax


```
DELETE /queries/queryId HTTP/1.1
graphIdentifier: graphIdentifier
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_CancelQuery_RequestSyntax) **   <a name="neptunegraph-CancelQuery-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [queryId](#API_CancelQuery_RequestSyntax) **   <a name="neptunegraph-CancelQuery-request-uri-queryId"></a>
The unique identifier of the query to cancel.  
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Raised in case of an authentication or authorization failure.    
 ** message **   
A message describing the problem.
HTTP Status Code: 403

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CancelQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CancelQuery) 

# CreateGraph


Creates a new Neptune Analytics graph.

## Request Syntax


```
POST /graphs HTTP/1.1
Content-type: application/json

{
   "deletionProtection": boolean,
   "graphName": "string",
   "kmsKeyIdentifier": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "tags": { 
      "string" : "string" 
   },
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [deletionProtection](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-deletionProtection"></a>
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (`true` or `false`).  
Type: Boolean  
Required: No

 ** [graphName](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-graphName"></a>
A name for the new Neptune Analytics graph to be created.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*`   
Required: Yes

 ** [kmsKeyIdentifier](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-kmsKeyIdentifier"></a>
Specifies a KMS key to use to encrypt data in the new graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`   
Required: No

 ** [provisionedMemory](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-provisionedMemory"></a>
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.  
Required: Yes

 ** [publicConnectivity](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-publicConnectivity"></a>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (`true` to enable, or `false` to disable.  
Type: Boolean  
Required: No

 ** [replicaCount](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-replicaCount"></a>
The number of replicas in other AZs. Min =0, Max = 2, Default = 1.  
 Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. 
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.  
Required: No

 ** [tags](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-tags"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [vectorSearchConfiguration](#API_CreateGraph_RequestSyntax) **   <a name="neptunegraph-CreateGraph-request-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as `dimension=`value. Max = 65,535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-arn"></a>
The ARN of the graph.  
Type: String

 ** [buildNumber](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-buildNumber"></a>
The build number of the graph software.  
Type: String

 ** [createTime](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-createTime"></a>
The time when the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-deletionProtection"></a>
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.  
Type: Boolean

 ** [endpoint](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-id"></a>
The ID of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-kmsKeyIdentifier"></a>
Specifies the KMS key used to encrypt data in the new graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-name"></a>
The graph name. For example: `my-graph-1`.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-provisionedMemory"></a>
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.  
Min = 16  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-publicConnectivity"></a>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.  
If enabling public connectivity for the first time, there will be a delay while it is enabled.
Type: Boolean

 ** [replicaCount](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-replicaCount"></a>
The number of replicas in other AZs.  
Default: If not specified, the default value is 1.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-sourceSnapshotId"></a>
The ID of the source graph.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-status"></a>
The current status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-statusReason"></a>
The reason the status was given.  
Type: String

 ** [vectorSearchConfiguration](#API_CreateGraph_ResponseSyntax) **   <a name="neptunegraph-CreateGraph-response-vectorSearchConfiguration"></a>
The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
A service quota was exceeded.    
 ** quotaCode **   
Service quota code of the resource for which quota was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded quota.  
 ** resourceType **   
The type of the resource that exceeded quota. Ex: Graph, Snapshot  
 ** serviceCode **   
The service code that exceeded quota.
HTTP Status Code: 402

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CreateGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CreateGraph) 

# CreateGraphSnapshot


Creates a snapshot of the specific graph.

## Request Syntax


```
POST /snapshots HTTP/1.1
Content-type: application/json

{
   "graphIdentifier": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [graphIdentifier](#API_CreateGraphSnapshot_RequestSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [snapshotName](#API_CreateGraphSnapshot_RequestSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-request-snapshotName"></a>
The snapshot name. For example: `my-snapshot-1`.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*`   
Required: Yes

 ** [tags](#API_CreateGraphSnapshot_RequestSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-request-tags"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "snapshotCreateTime": number,
   "sourceGraphId": "string",
   "status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-arn"></a>
The ARN of the snapshot created.  
Type: String

 ** [id](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-id"></a>
The ID of the snapshot created.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-name"></a>
The name of the snapshot created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [snapshotCreateTime](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-snapshotCreateTime"></a>
The snapshot creation time  
Type: Timestamp

 ** [sourceGraphId](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-sourceGraphId"></a>
The Id of the Neptune Analytics graph from which the snapshot is created.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [status](#API_CreateGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-CreateGraphSnapshot-response-status"></a>
The current state of the snapshot.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
A service quota was exceeded.    
 ** quotaCode **   
Service quota code of the resource for which quota was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded quota.  
 ** resourceType **   
The type of the resource that exceeded quota. Ex: Graph, Snapshot  
 ** serviceCode **   
The service code that exceeded quota.
HTTP Status Code: 402

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CreateGraphSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CreateGraphSnapshot) 

# CreateGraphUsingImportTask


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.

The data can be loaded from files in S3 that in either the [Gremlin CSV format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) or the [openCypher load format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html).

## Request Syntax


```
POST /importtasks HTTP/1.1
Content-type: application/json

{
   "blankNodeHandling": "string",
   "deletionProtection": boolean,
   "failOnError": boolean,
   "format": "string",
   "graphName": "string",
   "importOptions": { ... },
   "kmsKeyIdentifier": "string",
   "maxProvisionedMemory": number,
   "minProvisionedMemory": number,
   "parquetType": "string",
   "publicConnectivity": boolean,
   "replicaCount": number,
   "roleArn": "string",
   "source": "string",
   "tags": { 
      "string" : "string" 
   },
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [blankNodeHandling](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-blankNodeHandling"></a>
The method to handle blank nodes in the dataset. Currently, only `convertToIri` is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is `ntriples`. For more information, see [Handling RDF values](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling).  
Type: String  
Valid Values: `convertToIri`   
Required: No

 ** [deletionProtection](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-deletionProtection"></a>
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (`true` or `false`).  
Type: Boolean  
Required: No

 ** [failOnError](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-failOnError"></a>
If set to `true`, the task halts when an import error is encountered. If set to `false`, the task skips the data that caused the error and continues if possible.  
Type: Boolean  
Required: No

 ** [format](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-format"></a>
Specifies the format of S3 data to be imported. Valid values are `CSV`, which identifies the [Gremlin CSV format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html), `OPEN_CYPHER`, which identifies the [openCypher load format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html), or `ntriples`, which identifies the [RDF n-triples](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html) format.  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES`   
Required: No

 ** [graphName](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-graphName"></a>
A name for the new Neptune Analytics graph to be created.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*`   
Required: Yes

 ** [importOptions](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-importOptions"></a>
Contains options for controlling the import process. For example, if the `failOnError` key is set to `false`, the import skips problem data and attempts to continue (whereas if set to `true`, the default, or if omitted, the import operation halts immediately when an error is encountered.  
Type: [ImportOptions](API_ImportOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [kmsKeyIdentifier](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-kmsKeyIdentifier"></a>
Specifies a KMS key to use to encrypt data imported into the new graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`   
Required: No

 ** [maxProvisionedMemory](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-maxProvisionedMemory"></a>
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.  
 If both the minimum and maximum values are specified, the final `provisioned-memory` will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.  
Required: No

 ** [minProvisionedMemory](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-minProvisionedMemory"></a>
The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 16  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.  
Required: No

 ** [parquetType](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR`   
Required: No

 ** [publicConnectivity](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-publicConnectivity"></a>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (`true` to enable, or `false` to disable).  
Type: Boolean  
Required: No

 ** [replicaCount](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-replicaCount"></a>
The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.  
 Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. 
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.  
Required: No

 ** [roleArn](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+`   
Required: Yes

 ** [source](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-source"></a>
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.  
Type: String  
Required: Yes

 ** [tags](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-tags"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [vectorSearchConfiguration](#API_CreateGraphUsingImportTask_RequestSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-request-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as `dimension=`value. Max = 65,535   
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "format": "string",
   "graphId": "string",
   "importOptions": { ... },
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [format](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-format"></a>
Specifies the format of S3 data to be imported. Valid values are `CSV`, which identifies the [Gremlin CSV format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html), `OPENCYPHER`, which identifies the [openCypher load format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html), or `ntriples`, which identifies the [RDF n-triples](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html) format.  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES` 

 ** [graphId](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-graphId"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [importOptions](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-importOptions"></a>
Contains options for controlling the import process. For example, if the `failOnError` key is set to `false`, the import skips problem data and attempts to continue (whereas if set to `true`, the default, or if omitted, the import operation halts immediately when an error is encountered.  
Type: [ImportOptions](API_ImportOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [parquetType](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [source](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-source"></a>
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.  
Type: String

 ** [status](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-status"></a>
The status of the import task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | ANALYZING_DATA | IMPORTING | REPROVISIONING | ROLLING_BACK | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [taskId](#API_CreateGraphUsingImportTask_ResponseSyntax) **   <a name="neptunegraph-CreateGraphUsingImportTask-response-taskId"></a>
The unique identifier of the import task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
A service quota was exceeded.    
 ** quotaCode **   
Service quota code of the resource for which quota was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded quota.  
 ** resourceType **   
The type of the resource that exceeded quota. Ex: Graph, Snapshot  
 ** serviceCode **   
The service code that exceeded quota.
HTTP Status Code: 402

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CreateGraphUsingImportTask) 

# CreatePrivateGraphEndpoint


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.

**Note**  
VPC endpoint charges apply.

## Request Syntax


```
POST /graphs/graphIdentifier/endpoints/ HTTP/1.1
Content-type: application/json

{
   "subnetIds": [ "string" ],
   "vpcId": "string",
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_CreatePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [subnetIds](#API_CreatePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-request-subnetIds"></a>
Subnets in which private graph endpoint ENIs are created.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Pattern: `subnet-[a-z0-9]+`   
Required: No

 ** [vpcId](#API_CreatePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-request-vpcId"></a>
 The VPC in which the private graph endpoint needs to be created.  
Type: String  
Pattern: `vpc-[a-z0-9]+`   
Required: No

 ** [vpcSecurityGroupIds](#API_CreatePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-request-vpcSecurityGroupIds"></a>
Security groups to be attached to the private graph endpoint..  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `sg-[a-z0-9]+`   
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "status": "string",
   "subnetIds": [ "string" ],
   "vpcEndpointId": "string",
   "vpcId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [status](#API_CreatePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-response-status"></a>
Status of the private graph endpoint.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

 ** [subnetIds](#API_CreatePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-response-subnetIds"></a>
Subnets in which the private graph endpoint ENIs are created.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Pattern: `subnet-[a-z0-9]+` 

 ** [vpcEndpointId](#API_CreatePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-response-vpcEndpointId"></a>
Endpoint ID of the prviate grpah endpoint.  
Type: String  
Pattern: `vpce-[0-9a-f]{17}` 

 ** [vpcId](#API_CreatePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-CreatePrivateGraphEndpoint-response-vpcId"></a>
VPC in which the private graph endpoint is created.  
Type: String  
Pattern: `vpc-[a-z0-9]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
A service quota was exceeded.    
 ** quotaCode **   
Service quota code of the resource for which quota was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded quota.  
 ** resourceType **   
The type of the resource that exceeded quota. Ex: Graph, Snapshot  
 ** serviceCode **   
The service code that exceeded quota.
HTTP Status Code: 402

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/CreatePrivateGraphEndpoint) 

# DeleteGraph


Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.

## Request Syntax


```
DELETE /graphs/graphIdentifier?skipSnapshot=skipSnapshot HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_DeleteGraph_RequestSyntax) **   <a name="neptunegraph-DeleteGraph-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [skipSnapshot](#API_DeleteGraph_RequestSyntax) **   <a name="neptunegraph-DeleteGraph-request-uri-skipSnapshot"></a>
Determines whether a final graph snapshot is created before the graph is deleted. If `true` is specified, no graph snapshot is created. If `false` is specified, a graph snapshot is created before the graph is deleted.  
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-buildNumber"></a>
The build number associated with the graph.  
Type: String

 ** [createTime](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-deletionProtection"></a>
If `true`, deletion protection was enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-statusReason"></a>
The reason for the status of the graph.  
Type: String

 ** [vectorSearchConfiguration](#API_DeleteGraph_ResponseSyntax) **   <a name="neptunegraph-DeleteGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/DeleteGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/DeleteGraph) 

# DeleteGraphSnapshot


Deletes the specifed graph snapshot.

## Request Syntax


```
DELETE /snapshots/snapshotIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [snapshotIdentifier](#API_DeleteGraphSnapshot_RequestSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-request-uri-snapshotIdentifier"></a>
ID of the graph snapshot to be deleted.  
Pattern: `gs-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "snapshotCreateTime": number,
   "sourceGraphId": "string",
   "status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-arn"></a>
The ARN of the graph snapshot.  
Type: String

 ** [id](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-id"></a>
The unique identifier of the graph snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt the snapshot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-name"></a>
The snapshot name. For example: `my-snapshot-1`.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [snapshotCreateTime](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-snapshotCreateTime"></a>
The time when the snapshot was created.  
Type: Timestamp

 ** [sourceGraphId](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-sourceGraphId"></a>
The graph identifier for the graph from which the snapshot was created.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [status](#API_DeleteGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-DeleteGraphSnapshot-response-status"></a>
The status of the graph snapshot.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/DeleteGraphSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/DeleteGraphSnapshot) 

# DeletePrivateGraphEndpoint


Deletes a private graph endpoint.

## Request Syntax


```
DELETE /graphs/graphIdentifier/endpoints/vpcId HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_DeletePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [vpcId](#API_DeletePrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-request-uri-vpcId"></a>
The ID of the VPC where the private endpoint is located.  
Pattern: `vpc-[a-z0-9]+`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string",
   "subnetIds": [ "string" ],
   "vpcEndpointId": "string",
   "vpcId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeletePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-response-status"></a>
The status of the delete operation.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

 ** [subnetIds](#API_DeletePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-response-subnetIds"></a>
The subnet IDs involved.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Pattern: `subnet-[a-z0-9]+` 

 ** [vpcEndpointId](#API_DeletePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-response-vpcEndpointId"></a>
The ID of the VPC endpoint that was deleted.  
Type: String  
Pattern: `vpce-[0-9a-f]{17}` 

 ** [vpcId](#API_DeletePrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-DeletePrivateGraphEndpoint-response-vpcId"></a>
The ID of the VPC where the private endpoint was deleted.  
Type: String  
Pattern: `vpc-[a-z0-9]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/DeletePrivateGraphEndpoint) 

# ExecuteQuery


Execute an openCypher query.

 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: 
+ neptune-graph:ReadDataViaQuery
+ neptune-graph:WriteDataViaQuery
+ neptune-graph:DeleteDataViaQuery

## Request Syntax


```
POST /queries HTTP/1.1
graphIdentifier: graphIdentifier
Content-type: application/json

{
   "explain": "string",
   "language": "string",
   "parameters": { 
      "string" : JSON value 
   },
   "planCache": "string",
   "query": "string",
   "queryTimeoutMilliseconds": number
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [explain](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-explain"></a>
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.  
Type: String  
Valid Values: `STATIC | DETAILS`   
Required: No

 ** [language](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-language"></a>
The query language the query is written in. Currently only openCypher is supported.  
Type: String  
Valid Values: `OPEN_CYPHER`   
Required: Yes

 ** [parameters](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-parameters"></a>
The data parameters the query can use in JSON format. For example: \$1"name": "john", "age": 20\$1. (optional)   
Type: String to JSON value map  
Required: No

 ** [planCache](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-planCache"></a>
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 `READ` and `UPDATE` queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.  
Type: String  
Valid Values: `ENABLED | DISABLED | AUTO`   
Required: No

 ** [query](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-query"></a>
The query string to be executed.  
Type: String  
Required: Yes

 ** [queryTimeoutMilliseconds](#API_ExecuteQuery_RequestSyntax) **   <a name="neptunegraph-ExecuteQuery-request-queryTimeoutMilliseconds"></a>
Specifies the query timeout duration, in milliseconds. (optional)  
Type: Integer  
Required: No

## Response Syntax


```
HTTP/1.1 200

payload
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

 ** [payload](#API_ExecuteQuery_ResponseSyntax) **   <a name="neptunegraph-ExecuteQuery-response-payload"></a>
The query results.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Raised in case of an authentication or authorization failure.    
 ** message **   
A message describing the problem.
HTTP Status Code: 403

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** UnprocessableException **   
Request cannot be processed due to known reasons. Eg. partition full.    
 ** reason **   
The reason for the unprocessable exception.
HTTP Status Code: 422

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ExecuteQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExecuteQuery) 

# GetExportTask


Retrieves a specified export task.

## Request Syntax


```
GET /exporttasks/taskIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [taskIdentifier](#API_GetExportTask_RequestSyntax) **   <a name="neptunegraph-GetExportTask-request-uri-taskIdentifier"></a>
The unique identifier of the export task.  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "destination": "string",
   "exportFilter": { 
      "edgeFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      },
      "vertexFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      }
   },
   "exportTaskDetails": { 
      "numEdgesWritten": number,
      "numVerticesWritten": number,
      "progressPercentage": number,
      "startTime": number,
      "timeElapsedSeconds": number
   },
   "format": "string",
   "graphId": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [destination](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-destination"></a>
The Amazon S3 URI of the export task where data will be exported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [exportFilter](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-exportFilter"></a>
The export filter of the export task.  
Type: [ExportFilter](API_ExportFilter.md) object

 ** [exportTaskDetails](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-exportTaskDetails"></a>
The details of the export task.  
Type: [ExportTaskDetails](API_ExportTaskDetails.md) object

 ** [format](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-format"></a>
The format of the export task.  
Type: String  
Valid Values: `PARQUET | CSV` 

 ** [graphId](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-graphId"></a>
The source graph identifier of the export task.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-kmsKeyIdentifier"></a>
The KMS key identifier of the export task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [parquetType](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-parquetType"></a>
The parquet type of the export task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-roleArn"></a>
The ARN of the IAM role that will allow data to be exported to the destination.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [status](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-status"></a>
The current status of the export task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [statusReason](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-statusReason"></a>
The reason that the export task has this status value.  
Type: String

 ** [taskId](#API_GetExportTask_ResponseSyntax) **   <a name="neptunegraph-GetExportTask-response-taskId"></a>
The unique identifier of the export task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetExportTask) 

# GetGraph


Gets information about a specified graph.

## Request Syntax


```
GET /graphs/graphIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_GetGraph_RequestSyntax) **   <a name="neptunegraph-GetGraph-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if it was created from a snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_GetGraph_ResponseSyntax) **   <a name="neptunegraph-GetGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetGraph) 

# GetGraphSnapshot


Retrieves a specified graph snapshot.

## Request Syntax


```
GET /snapshots/snapshotIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [snapshotIdentifier](#API_GetGraphSnapshot_RequestSyntax) **   <a name="neptunegraph-GetGraphSnapshot-request-uri-snapshotIdentifier"></a>
The ID of the snapshot to retrieve.  
Pattern: `gs-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "snapshotCreateTime": number,
   "sourceGraphId": "string",
   "status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-arn"></a>
The ARN of the graph snapshot.  
Type: String

 ** [id](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-id"></a>
The unique identifier of the graph snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt the snapshot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-name"></a>
The snapshot name. For example: `my-snapshot-1`.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [snapshotCreateTime](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-snapshotCreateTime"></a>
The time when the snapshot was created.  
Type: Timestamp

 ** [sourceGraphId](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-sourceGraphId"></a>
The graph identifier for the graph for which a snapshot is to be created.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [status](#API_GetGraphSnapshot_ResponseSyntax) **   <a name="neptunegraph-GetGraphSnapshot-response-status"></a>
The status of the graph snapshot.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetGraphSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetGraphSnapshot) 

# GetGraphSummary


Gets a graph summary for a property graph.

## Request Syntax


```
GET /summary?mode=mode HTTP/1.1
graphIdentifier: graphIdentifier
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_GetGraphSummary_RequestSyntax) **   <a name="neptunegraph-GetGraphSummary-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [mode](#API_GetGraphSummary_RequestSyntax) **   <a name="neptunegraph-GetGraphSummary-request-uri-mode"></a>
The summary mode can take one of two values: `basic` (the default), and `detailed`.  
Valid Values: `BASIC | DETAILED` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "graphSummary": { 
      "edgeLabels": [ "string" ],
      "edgeProperties": [ 
         { 
            "string" : number 
         }
      ],
      "edgeStructures": [ 
         { 
            "count": number,
            "edgeProperties": [ "string" ]
         }
      ],
      "nodeLabels": [ "string" ],
      "nodeProperties": [ 
         { 
            "string" : number 
         }
      ],
      "nodeStructures": [ 
         { 
            "count": number,
            "distinctOutgoingEdgeLabels": [ "string" ],
            "nodeProperties": [ "string" ]
         }
      ],
      "numEdgeLabels": number,
      "numEdgeProperties": number,
      "numEdges": number,
      "numNodeLabels": number,
      "numNodeProperties": number,
      "numNodes": number,
      "totalEdgePropertyValues": number,
      "totalNodePropertyValues": number
   },
   "lastStatisticsComputationTime": "string",
   "version": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [graphSummary](#API_GetGraphSummary_ResponseSyntax) **   <a name="neptunegraph-GetGraphSummary-response-graphSummary"></a>
The graph summary.  
Type: [GraphDataSummary](API_GraphDataSummary.md) object

 ** [lastStatisticsComputationTime](#API_GetGraphSummary_ResponseSyntax) **   <a name="neptunegraph-GetGraphSummary-response-lastStatisticsComputationTime"></a>
The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.  
Type: Timestamp

 ** [version](#API_GetGraphSummary_ResponseSyntax) **   <a name="neptunegraph-GetGraphSummary-response-version"></a>
Display the version of this tool.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Raised in case of an authentication or authorization failure.    
 ** message **   
A message describing the problem.
HTTP Status Code: 403

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetGraphSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetGraphSummary) 

# GetImportTask


Retrieves a specified import task.

## Request Syntax


```
GET /importtasks/taskIdentifier HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [taskIdentifier](#API_GetImportTask_RequestSyntax) **   <a name="neptunegraph-GetImportTask-request-uri-taskIdentifier"></a>
The unique identifier of the import task.  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "attemptNumber": number,
   "format": "string",
   "graphId": "string",
   "importOptions": { ... },
   "importTaskDetails": { 
      "dictionaryEntryCount": number,
      "errorCount": number,
      "errorDetails": "string",
      "progressPercentage": number,
      "startTime": number,
      "statementCount": number,
      "status": "string",
      "timeElapsedSeconds": number
   },
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attemptNumber](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-attemptNumber"></a>
The number of the current attempts to execute the import task.  
Type: Integer

 ** [format](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-format"></a>
Specifies the format of S3 data to be imported. Valid values are `CSV`, which identifies the [Gremlin CSV format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) or `OPENCYPHER`, which identies the [openCypher load format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html).  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES` 

 ** [graphId](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-graphId"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [importOptions](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-importOptions"></a>
Contains options for controlling the import process. For example, if the `failOnError` key is set to `false`, the import skips problem data and attempts to continue (whereas if set to `true`, the default, or if omitted, the import operation halts immediately when an error is encountered.  
Type: [ImportOptions](API_ImportOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [importTaskDetails](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-importTaskDetails"></a>
Contains details about the specified import task.  
Type: [ImportTaskDetails](API_ImportTaskDetails.md) object

 ** [parquetType](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [source](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-source"></a>
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  
Type: String

 ** [status](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-status"></a>
The status of the import task:  
+  **INITIALIZING**   –   The necessary resources needed to create the graph are being prepared.
+  **ANALYZING\$1DATA**   –   The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
+  **RE\$1PROVISIONING**   –   The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
+  **IMPORTING**   –   The data is being loaded.
+  **ERROR\$1ENCOUNTERED**   –   An error has been encountered while trying to create the graph and import the data.
+  **ERROR\$1ENCOUNTERED\$1ROLLING\$1BACK**   –   Because of the error that was encountered, the graph is being rolled back and all its resources released.
+  **SUCCEEDED**   –   Graph creation and data loading succeeded.
+  **FAILED**   –   Graph creation or data loading failed. When the status is `FAILED`, you can use `get-graphs` to get more information about the state of the graph.
+  **CANCELLING**   –   Because you cancelled the import task, cancellation is in progress.
+  **CANCELLED**   –   You have successfully cancelled the import task.
Type: String  
Valid Values: `INITIALIZING | EXPORTING | ANALYZING_DATA | IMPORTING | REPROVISIONING | ROLLING_BACK | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [statusReason](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-statusReason"></a>
The reason that the import task has this status value.  
Type: String

 ** [taskId](#API_GetImportTask_ResponseSyntax) **   <a name="neptunegraph-GetImportTask-response-taskId"></a>
The unique identifier of the import task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetImportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetImportTask) 

# GetPrivateGraphEndpoint


Retrieves information about a specified private endpoint.

## Request Syntax


```
GET /graphs/graphIdentifier/endpoints/vpcId HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_GetPrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [vpcId](#API_GetPrivateGraphEndpoint_RequestSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-request-uri-vpcId"></a>
The ID of the VPC where the private endpoint is located.  
Pattern: `vpc-[a-z0-9]+`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string",
   "subnetIds": [ "string" ],
   "vpcEndpointId": "string",
   "vpcId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_GetPrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-response-status"></a>
The current status of the private endpoint.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED` 

 ** [subnetIds](#API_GetPrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-response-subnetIds"></a>
The subnet IDs involved.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Pattern: `subnet-[a-z0-9]+` 

 ** [vpcEndpointId](#API_GetPrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-response-vpcEndpointId"></a>
The ID of the private endpoint.  
Type: String  
Pattern: `vpce-[0-9a-f]{17}` 

 ** [vpcId](#API_GetPrivateGraphEndpoint_ResponseSyntax) **   <a name="neptunegraph-GetPrivateGraphEndpoint-response-vpcId"></a>
The ID of the VPC where the private endpoint is located.  
Type: String  
Pattern: `vpc-[a-z0-9]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetPrivateGraphEndpoint) 

# GetQuery


Retrieves the status of a specified query.

**Note**  
 When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the `neptune-graph:GetQueryStatus` IAM action attached. 

## Request Syntax


```
GET /queries/queryId HTTP/1.1
graphIdentifier: graphIdentifier
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_GetQuery_RequestSyntax) **   <a name="neptunegraph-GetQuery-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [queryId](#API_GetQuery_RequestSyntax) **   <a name="neptunegraph-GetQuery-request-uri-queryId"></a>
The ID of the query in question.  
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "elapsed": number,
   "id": "string",
   "queryString": "string",
   "state": "string",
   "waited": number
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [elapsed](#API_GetQuery_ResponseSyntax) **   <a name="neptunegraph-GetQuery-response-elapsed"></a>
The number of milliseconds the query has been running.  
Type: Integer

 ** [id](#API_GetQuery_ResponseSyntax) **   <a name="neptunegraph-GetQuery-response-id"></a>
The ID of the query in question.  
Type: String

 ** [queryString](#API_GetQuery_ResponseSyntax) **   <a name="neptunegraph-GetQuery-response-queryString"></a>
The query in question.  
Type: String

 ** [state](#API_GetQuery_ResponseSyntax) **   <a name="neptunegraph-GetQuery-response-state"></a>
State of the query.  
Type: String  
Valid Values: `RUNNING | WAITING | CANCELLING` 

 ** [waited](#API_GetQuery_ResponseSyntax) **   <a name="neptunegraph-GetQuery-response-waited"></a>
Indicates how long the query waited, in milliseconds.  
Type: Integer

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Raised in case of an authentication or authorization failure.    
 ** message **   
A message describing the problem.
HTTP Status Code: 403

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/GetQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GetQuery) 

# ListExportTasks


Retrieves a list of export tasks.

## Request Syntax


```
GET /exporttasks?graphIdentifier=graphIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ListExportTasks_RequestSyntax) **   <a name="neptunegraph-ListExportTasks-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}` 

 ** [maxResults](#API_ListExportTasks_RequestSyntax) **   <a name="neptunegraph-ListExportTasks-request-uri-maxResults"></a>
The maximum number of export tasks to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListExportTasks_RequestSyntax) **   <a name="neptunegraph-ListExportTasks-request-uri-nextToken"></a>
Pagination token used to paginate input.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "tasks": [ 
      { 
         "destination": "string",
         "format": "string",
         "graphId": "string",
         "kmsKeyIdentifier": "string",
         "parquetType": "string",
         "roleArn": "string",
         "status": "string",
         "statusReason": "string",
         "taskId": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListExportTasks_ResponseSyntax) **   <a name="neptunegraph-ListExportTasks-response-nextToken"></a>
Pagination token used to paginate output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [tasks](#API_ListExportTasks_ResponseSyntax) **   <a name="neptunegraph-ListExportTasks-response-tasks"></a>
The requested list of export tasks.  
Type: Array of [ExportTaskSummary](API_ExportTaskSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListExportTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListExportTasks) 

# ListGraphs


Lists available Neptune Analytics graphs.

## Request Syntax


```
GET /graphs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [maxResults](#API_ListGraphs_RequestSyntax) **   <a name="neptunegraph-ListGraphs-request-uri-maxResults"></a>
The total number of records to return in the command's output.  
If the total number of records available is more than the value specified, `nextToken` is provided in the command's output. To resume pagination, provide the `nextToken` output value in the `nextToken` argument of a subsequent command. Do not use the `nextToken` response element directly outside of the Amazon CLI.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListGraphs_RequestSyntax) **   <a name="neptunegraph-ListGraphs-request-uri-nextToken"></a>
Pagination token used to paginate output.  
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "graphs": [ 
      { 
         "arn": "string",
         "deletionProtection": boolean,
         "endpoint": "string",
         "id": "string",
         "kmsKeyIdentifier": "string",
         "name": "string",
         "provisionedMemory": number,
         "publicConnectivity": boolean,
         "replicaCount": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [graphs](#API_ListGraphs_ResponseSyntax) **   <a name="neptunegraph-ListGraphs-response-graphs"></a>
A list of the graphs.  
Type: Array of [GraphSummary](API_GraphSummary.md) objects

 ** [nextToken](#API_ListGraphs_ResponseSyntax) **   <a name="neptunegraph-ListGraphs-response-nextToken"></a>
Pagination token used to paginate output.  
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListGraphs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListGraphs) 

# ListGraphSnapshots


Lists available snapshots of a specified Neptune Analytics graph.

## Request Syntax


```
GET /snapshots?graphIdentifier=graphIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ListGraphSnapshots_RequestSyntax) **   <a name="neptunegraph-ListGraphSnapshots-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}` 

 ** [maxResults](#API_ListGraphSnapshots_RequestSyntax) **   <a name="neptunegraph-ListGraphSnapshots-request-uri-maxResults"></a>
The total number of records to return in the command's output.  
If the total number of records available is more than the value specified, `nextToken` is provided in the command's output. To resume pagination, provide the `nextToken` output value in the `nextToken` argument of a subsequent command. Do not use the `nextToken` response element directly outside of the Amazon CLI.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListGraphSnapshots_RequestSyntax) **   <a name="neptunegraph-ListGraphSnapshots-request-uri-nextToken"></a>
Pagination token used to paginate output.  
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "graphSnapshots": [ 
      { 
         "arn": "string",
         "id": "string",
         "kmsKeyIdentifier": "string",
         "name": "string",
         "snapshotCreateTime": number,
         "sourceGraphId": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [graphSnapshots](#API_ListGraphSnapshots_ResponseSyntax) **   <a name="neptunegraph-ListGraphSnapshots-response-graphSnapshots"></a>
The requested list of snapshots.  
Type: Array of [GraphSnapshotSummary](API_GraphSnapshotSummary.md) objects

 ** [nextToken](#API_ListGraphSnapshots_ResponseSyntax) **   <a name="neptunegraph-ListGraphSnapshots-response-nextToken"></a>
Pagination token used to paginate output.  
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListGraphSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListGraphSnapshots) 

# ListImportTasks


Lists import tasks.

## Request Syntax


```
GET /importtasks?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [maxResults](#API_ListImportTasks_RequestSyntax) **   <a name="neptunegraph-ListImportTasks-request-uri-maxResults"></a>
The total number of records to return in the command's output.  
If the total number of records available is more than the value specified, `nextToken` is provided in the command's output. To resume pagination, provide the `nextToken` output value in the `nextToken` argument of a subsequent command. Do not use the `nextToken` response element directly outside of the Amazon CLI.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListImportTasks_RequestSyntax) **   <a name="neptunegraph-ListImportTasks-request-uri-nextToken"></a>
Pagination token used to paginate output.  
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "tasks": [ 
      { 
         "format": "string",
         "graphId": "string",
         "parquetType": "string",
         "roleArn": "string",
         "source": "string",
         "status": "string",
         "taskId": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListImportTasks_ResponseSyntax) **   <a name="neptunegraph-ListImportTasks-response-nextToken"></a>
Pagination token used to paginate output.  
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [tasks](#API_ListImportTasks_ResponseSyntax) **   <a name="neptunegraph-ListImportTasks-response-tasks"></a>
The requested list of import tasks.  
Type: Array of [ImportTaskSummary](API_ImportTaskSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListImportTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListImportTasks) 

# ListPrivateGraphEndpoints


Lists private endpoints for a specified Neptune Analytics graph.

## Request Syntax


```
GET /graphs/graphIdentifier/endpoints/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ListPrivateGraphEndpoints_RequestSyntax) **   <a name="neptunegraph-ListPrivateGraphEndpoints-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [maxResults](#API_ListPrivateGraphEndpoints_RequestSyntax) **   <a name="neptunegraph-ListPrivateGraphEndpoints-request-uri-maxResults"></a>
The total number of records to return in the command's output.  
If the total number of records available is more than the value specified, `nextToken` is provided in the command's output. To resume pagination, provide the `nextToken` output value in the `nextToken` argument of a subsequent command. Do not use the `nextToken` response element directly outside of the Amazon CLI.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListPrivateGraphEndpoints_RequestSyntax) **   <a name="neptunegraph-ListPrivateGraphEndpoints-request-uri-nextToken"></a>
Pagination token used to paginate output.  
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "privateGraphEndpoints": [ 
      { 
         "status": "string",
         "subnetIds": [ "string" ],
         "vpcEndpointId": "string",
         "vpcId": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListPrivateGraphEndpoints_ResponseSyntax) **   <a name="neptunegraph-ListPrivateGraphEndpoints-response-nextToken"></a>
Pagination token used to paginate output.  
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [privateGraphEndpoints](#API_ListPrivateGraphEndpoints_ResponseSyntax) **   <a name="neptunegraph-ListPrivateGraphEndpoints-response-privateGraphEndpoints"></a>
A list of private endpoints for the specified Neptune Analytics graph.  
Type: Array of [PrivateGraphEndpointSummary](API_PrivateGraphEndpointSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListPrivateGraphEndpoints) 

# ListQueries


Lists active openCypher queries.

## Request Syntax


```
GET /queries?maxResults=maxResults&state=state HTTP/1.1
graphIdentifier: graphIdentifier
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ListQueries_RequestSyntax) **   <a name="neptunegraph-ListQueries-request-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [maxResults](#API_ListQueries_RequestSyntax) **   <a name="neptunegraph-ListQueries-request-uri-maxResults"></a>
The maximum number of results to be fetched by the API.  
Required: Yes

 ** [state](#API_ListQueries_RequestSyntax) **   <a name="neptunegraph-ListQueries-request-uri-state"></a>
Filtered list of queries based on state.  
Valid Values: `ALL | RUNNING | WAITING | CANCELLING` 

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "queries": [ 
      { 
         "elapsed": number,
         "id": "string",
         "queryString": "string",
         "state": "string",
         "waited": number
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [queries](#API_ListQueries_ResponseSyntax) **   <a name="neptunegraph-ListQueries-response-queries"></a>
A list of current openCypher queries.  
Type: Array of [QuerySummary](API_QuerySummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Raised in case of an authentication or authorization failure.    
 ** message **   
A message describing the problem.
HTTP Status Code: 403

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListQueries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListQueries) 

# ListTagsForResource


Lists tags associated with a specified resource.

## Request Syntax


```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="neptunegraph-ListTagsForResource-request-uri-resourceArn"></a>
The ARN of the resource.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="neptunegraph-ListTagsForResource-response-tags"></a>
The list of metadata tags associated with the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ListTagsForResource) 

# ResetGraph


Empties the data from a specified Neptune Analytics graph.

## Request Syntax


```
PUT /graphs/graphIdentifier HTTP/1.1
Content-type: application/json

{
   "skipSnapshot": boolean
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_ResetGraph_RequestSyntax) **   <a name="neptunegraph-ResetGraph-request-uri-graphIdentifier"></a>
ID of the graph to reset.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [skipSnapshot](#API_ResetGraph_RequestSyntax) **   <a name="neptunegraph-ResetGraph-request-skipSnapshot"></a>
Determines whether a final graph snapshot is created before the graph data is deleted. If set to `true`, no graph snapshot is created. If set to `false`, a graph snapshot is created before the data is deleted.  
Type: Boolean  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if any.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_ResetGraph_ResponseSyntax) **   <a name="neptunegraph-ResetGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/ResetGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ResetGraph) 

# RestoreGraphFromSnapshot


Restores a graph from a snapshot.

## Request Syntax


```
POST /snapshots/snapshotIdentifier/restore HTTP/1.1
Content-type: application/json

{
   "deletionProtection": boolean,
   "graphName": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [snapshotIdentifier](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-uri-snapshotIdentifier"></a>
The ID of the snapshot in question.  
Pattern: `gs-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [deletionProtection](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-deletionProtection"></a>
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.  
Type: Boolean  
Required: No

 ** [graphName](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-graphName"></a>
A name for the new Neptune Analytics graph to be created from the snapshot.  
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. Only lowercase letters are allowed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*`   
Required: Yes

 ** [provisionedMemory](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-provisionedMemory"></a>
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.  
Min = 16  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.  
Required: No

 ** [publicConnectivity](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-publicConnectivity"></a>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (`true` to enable, or `false` to disable).  
Type: Boolean  
Required: No

 ** [replicaCount](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-replicaCount"></a>
The number of replicas in other AZs. Min =0, Max = 2, Default =1  
 Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. 
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.  
Required: No

 ** [tags](#API_RestoreGraphFromSnapshot_RequestSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-request-tags"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if any.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_RestoreGraphFromSnapshot_ResponseSyntax) **   <a name="neptunegraph-RestoreGraphFromSnapshot-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
A service quota was exceeded.    
 ** quotaCode **   
Service quota code of the resource for which quota was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded quota.  
 ** resourceType **   
The type of the resource that exceeded quota. Ex: Graph, Snapshot  
 ** serviceCode **   
The service code that exceeded quota.
HTTP Status Code: 402

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/RestoreGraphFromSnapshot) 

# StartExportTask


Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be `AVAILABLE`.

## Request Syntax


```
POST /exporttasks HTTP/1.1
Content-type: application/json

{
   "destination": "string",
   "exportFilter": { 
      "edgeFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      },
      "vertexFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      }
   },
   "format": "string",
   "graphIdentifier": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [destination](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-destination"></a>
The Amazon S3 URI where data will be exported to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [exportFilter](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-exportFilter"></a>
The export filter of the export task.  
Type: [ExportFilter](API_ExportFilter.md) object  
Required: No

 ** [format](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-format"></a>
The format of the export task.  
Type: String  
Valid Values: `PARQUET | CSV`   
Required: Yes

 ** [graphIdentifier](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-graphIdentifier"></a>
The source graph identifier of the export task.  
Type: String  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** [kmsKeyIdentifier](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-kmsKeyIdentifier"></a>
The KMS key identifier of the export task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`   
Required: Yes

 ** [parquetType](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-parquetType"></a>
The parquet type of the export task.  
Type: String  
Valid Values: `COLUMNAR`   
Required: No

 ** [roleArn](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-roleArn"></a>
The ARN of the IAM role that will allow data to be exported to the destination.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+`   
Required: Yes

 ** [tags](#API_StartExportTask_RequestSyntax) **   <a name="neptunegraph-StartExportTask-request-tags"></a>
Tags to be applied to the export task.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "destination": "string",
   "exportFilter": { 
      "edgeFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      },
      "vertexFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      }
   },
   "format": "string",
   "graphId": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [destination](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-destination"></a>
The Amazon S3 URI of the export task where data will be exported to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [exportFilter](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-exportFilter"></a>
The export filter of the export task.  
Type: [ExportFilter](API_ExportFilter.md) object

 ** [format](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-format"></a>
The format of the export task.  
Type: String  
Valid Values: `PARQUET | CSV` 

 ** [graphId](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-graphId"></a>
The source graph identifier of the export task.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-kmsKeyIdentifier"></a>
The KMS key identifier of the export task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [parquetType](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-parquetType"></a>
The parquet type of the export task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-roleArn"></a>
The ARN of the IAM role that will allow data to be exported to the destination.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [status](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-status"></a>
The current status of the export task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [statusReason](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-statusReason"></a>
The reason that the export task has this status value.  
Type: String

 ** [taskId](#API_StartExportTask_ResponseSyntax) **   <a name="neptunegraph-StartExportTask-response-taskId"></a>
The unique identifier of the export task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/StartExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/StartExportTask) 

# StartGraph


Starts the specific graph.

## Request Syntax


```
POST /graphs/graphIdentifier/start HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_StartGraph_RequestSyntax) **   <a name="neptunegraph-StartGraph-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if it was created from a snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_StartGraph_ResponseSyntax) **   <a name="neptunegraph-StartGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/StartGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/StartGraph) 

# StartImportTask


Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.

## Request Syntax


```
POST /graphs/graphIdentifier/importtasks HTTP/1.1
Content-type: application/json

{
   "blankNodeHandling": "string",
   "failOnError": boolean,
   "format": "string",
   "importOptions": { ... },
   "parquetType": "string",
   "roleArn": "string",
   "source": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [blankNodeHandling](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-blankNodeHandling"></a>
The method to handle blank nodes in the dataset. Currently, only `convertToIri` is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is `ntriples`. For more information, see [Handling RDF values](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling).  
Type: String  
Valid Values: `convertToIri`   
Required: No

 ** [failOnError](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-failOnError"></a>
If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.  
Type: Boolean  
Required: No

 ** [format](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-format"></a>
Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES`   
Required: No

 ** [importOptions](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-importOptions"></a>
Options for how to perform an import.  
Type: [ImportOptions](API_ImportOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [parquetType](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR`   
Required: No

 ** [roleArn](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+`   
Required: Yes

 ** [source](#API_StartImportTask_RequestSyntax) **   <a name="neptunegraph-StartImportTask-request-source"></a>
A URL identifying 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.  
Type: String  
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "format": "string",
   "graphId": "string",
   "importOptions": { ... },
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "taskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [format](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-format"></a>
Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.  
Type: String  
Valid Values: `CSV | OPEN_CYPHER | PARQUET | NTRIPLES` 

 ** [graphId](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-graphId"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [importOptions](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-importOptions"></a>
Options for how to perform an import.  
Type: [ImportOptions](API_ImportOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [parquetType](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR` 

 ** [roleArn](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-roleArn"></a>
The ARN of the IAM role that will allow access to the data that is to be imported.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+` 

 ** [source](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-source"></a>
A URL identifying 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.  
Type: String

 ** [status](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-status"></a>
The status of the import task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | ANALYZING_DATA | IMPORTING | REPROVISIONING | ROLLING_BACK | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED` 

 ** [taskId](#API_StartImportTask_ResponseSyntax) **   <a name="neptunegraph-StartImportTask-response-taskId"></a>
The unique identifier of the import task.  
Type: String  
Pattern: `t-[a-z0-9]{10}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/StartImportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/StartImportTask) 

# StopGraph


Stops the specific graph.

## Request Syntax


```
POST /graphs/graphIdentifier/stop HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_StopGraph_RequestSyntax) **   <a name="neptunegraph-StopGraph-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-publicConnectivity"></a>
If true, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if it was created from a snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_StopGraph_ResponseSyntax) **   <a name="neptunegraph-StopGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/StopGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/StopGraph) 

# TagResource


Adds tags to the specified resource.

## Request Syntax


```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="neptunegraph-TagResource-request-uri-resourceArn"></a>
ARN of the resource for which tags need to be added.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="neptunegraph-TagResource-request-tags"></a>
The tags to be assigned to the Neptune Analytics resource.  
The tags are metadata that are specified as a list of key-value pairs:  
 **Key** (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 `aws:` and can only contain the set of Unicode characters specified by this Java regular expression: `"^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$")`.  
 **Value** (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 `aws:` and can only contain the set of Unicode characters specified by this Java regular expression: `"^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$")`.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/TagResource) 

# UntagResource


Removes the specified tags from the specified resource.

## Request Syntax


```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="neptunegraph-UntagResource-request-uri-resourceArn"></a>
ARN of the resource whose tag needs to be removed.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="neptunegraph-UntagResource-request-uri-tagKeys"></a>
Tag keys for the tags to be removed.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 200
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/UntagResource) 

# UpdateGraph


Updates the configuration of a specified Neptune Analytics graph

## Request Syntax


```
PATCH /graphs/graphIdentifier HTTP/1.1
Content-type: application/json

{
   "deletionProtection": boolean,
   "provisionedMemory": number,
   "publicConnectivity": boolean
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [graphIdentifier](#API_UpdateGraph_RequestSyntax) **   <a name="neptunegraph-UpdateGraph-request-uri-graphIdentifier"></a>
The unique identifier of the Neptune Analytics graph.  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [deletionProtection](#API_UpdateGraph_RequestSyntax) **   <a name="neptunegraph-UpdateGraph-request-deletionProtection"></a>
A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.  
Type: Boolean  
Required: No

 ** [provisionedMemory](#API_UpdateGraph_RequestSyntax) **   <a name="neptunegraph-UpdateGraph-request-provisionedMemory"></a>
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.  
Min = 16  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.  
Required: No

 ** [publicConnectivity](#API_UpdateGraph_RequestSyntax) **   <a name="neptunegraph-UpdateGraph-request-publicConnectivity"></a>
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (`true` to enable, or `false` to disable.  
Type: Boolean  
Required: No

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-arn"></a>
The ARN associated with the graph.  
Type: String

 ** [buildNumber](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-buildNumber"></a>
The build number of the graph.  
Type: String

 ** [createTime](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-createTime"></a>
The time at which the graph was created.  
Type: Timestamp

 ** [deletionProtection](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean

 ** [endpoint](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-endpoint"></a>
The graph endpoint.  
Type: String

 ** [id](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}` 

 ** [kmsKeyIdentifier](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-name"></a>
The name of the graph.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `(?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*` 

 ** [provisionedMemory](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-provisionedMemory"></a>
The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.  
Type: Integer  
Valid Range: Minimum value of 16. Maximum value of 24576.

 ** [publicConnectivity](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean

 ** [replicaCount](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

 ** [sourceSnapshotId](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-sourceSnapshotId"></a>
The ID of the snapshot from which the graph was created, if any.  
Type: String  
Pattern: `gs-[a-z0-9]{10}` 

 ** [status](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED` 

 ** [statusReason](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-statusReason"></a>
The reason that the graph has this status.  
Type: String

 ** [vectorSearchConfiguration](#API_UpdateGraph_ResponseSyntax) **   <a name="neptunegraph-UpdateGraph-response-vectorSearchConfiguration"></a>
Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535  
Type: [VectorSearchConfiguration](API_VectorSearchConfiguration.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Raised when a conflict is encountered.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason for the conflict exception.
HTTP Status Code: 409

 ** InternalServerException **   
A failure occurred on the server.    
 ** message **   
A message describing the problem.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A specified resource could not be located.    
 ** message **   
A message describing the problem.
HTTP Status Code: 404

 ** ThrottlingException **   
The exception was interrupted by throttling.    
 ** message **   
A message describing the problem.
HTTP Status Code: 429

 ** ValidationException **   
A resource could not be validated.    
 ** message **   
A message describing the problem.  
 ** reason **   
The reason that the resource could not be validated.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-graph-2023-11-29/UpdateGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/UpdateGraph)