# Data Types


The Amazon Neptune Graph API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [EdgeStructure](API_EdgeStructure.md) 
+  [ExportFilter](API_ExportFilter.md) 
+  [ExportFilterElement](API_ExportFilterElement.md) 
+  [ExportFilterPropertyAttributes](API_ExportFilterPropertyAttributes.md) 
+  [ExportTaskDetails](API_ExportTaskDetails.md) 
+  [ExportTaskSummary](API_ExportTaskSummary.md) 
+  [GraphDataSummary](API_GraphDataSummary.md) 
+  [GraphSnapshotSummary](API_GraphSnapshotSummary.md) 
+  [GraphSummary](API_GraphSummary.md) 
+  [ImportOptions](API_ImportOptions.md) 
+  [ImportTaskDetails](API_ImportTaskDetails.md) 
+  [ImportTaskSummary](API_ImportTaskSummary.md) 
+  [NeptuneImportOptions](API_NeptuneImportOptions.md) 
+  [NodeStructure](API_NodeStructure.md) 
+  [PrivateGraphEndpointSummary](API_PrivateGraphEndpointSummary.md) 
+  [QuerySummary](API_QuerySummary.md) 
+  [VectorSearchConfiguration](API_VectorSearchConfiguration.md) 

# EdgeStructure


Contains information about an edge in a Neptune Analytics graph.

## Contents


 ** count **   <a name="neptunegraph-Type-EdgeStructure-count"></a>
The number of instances of the edge in the graph.  
Type: Long  
Required: No

 ** edgeProperties **   <a name="neptunegraph-Type-EdgeStructure-edgeProperties"></a>
A list of the properties associated with the edge.  
Type: Array of strings  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/EdgeStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/EdgeStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/EdgeStructure) 

# ExportFilter


This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, then no data will be exported.

## Contents


 ** edgeFilter **   <a name="neptunegraph-Type-ExportFilter-edgeFilter"></a>
Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.  
Type: String to [ExportFilterElement](API_ExportFilterElement.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** vertexFilter **   <a name="neptunegraph-Type-ExportFilter-vertexFilter"></a>
Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.  
Type: String to [ExportFilterElement](API_ExportFilterElement.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExportFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExportFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExportFilter) 

# ExportFilterElement


Specifies whihc properties of that label should be included in the export.

## Contents


 ** properties **   <a name="neptunegraph-Type-ExportFilterElement-properties"></a>
Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"), and the value is an object.  
Type: String to [ExportFilterPropertyAttributes](API_ExportFilterPropertyAttributes.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[a-zA-Z0-9_]+`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExportFilterElement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExportFilterElement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExportFilterElement) 

# ExportFilterPropertyAttributes


A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

## Contents


 ** multiValueHandling **   <a name="neptunegraph-Type-ExportFilterPropertyAttributes-multiValueHandling"></a>
Specifies how to handle properties that have multiple values. Can be either `TO_LIST` to export all values as a list, or `PICK_FIRST` to export the first value encountered. If not specified, the default value is `PICK_FIRST`.  
Type: String  
Valid Values: `TO_LIST | PICK_FIRST`   
Required: No

 ** outputType **   <a name="neptunegraph-Type-ExportFilterPropertyAttributes-outputType"></a>
Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float"). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.  
Type: String  
Pattern: `(Any|Byte|Short|Int|Long|Float|Double|String|Bool|Boolean|Float\[\]|Double\[\])`   
Required: No

 ** sourcePropertyName **   <a name="neptunegraph-Type-ExportFilterPropertyAttributes-sourcePropertyName"></a>
The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExportFilterPropertyAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExportFilterPropertyAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExportFilterPropertyAttributes) 

# ExportTaskDetails


Contains details about the specified export task.

## Contents


 ** progressPercentage **   <a name="neptunegraph-Type-ExportTaskDetails-progressPercentage"></a>
The number of progress percentage of the export task.  
Type: Integer  
Required: Yes

 ** startTime **   <a name="neptunegraph-Type-ExportTaskDetails-startTime"></a>
The start time of the export task.  
Type: Timestamp  
Required: Yes

 ** timeElapsedSeconds **   <a name="neptunegraph-Type-ExportTaskDetails-timeElapsedSeconds"></a>
The time elapsed, in seconds, since the start time of the export task.  
Type: Long  
Required: Yes

 ** numEdgesWritten **   <a name="neptunegraph-Type-ExportTaskDetails-numEdgesWritten"></a>
The number of exported edges.  
Type: Long  
Required: No

 ** numVerticesWritten **   <a name="neptunegraph-Type-ExportTaskDetails-numVerticesWritten"></a>
The number of exported vertices.  
Type: Long  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExportTaskDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExportTaskDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExportTaskDetails) 

# ExportTaskSummary


Provides details about an export task.

## Contents


 ** destination **   <a name="neptunegraph-Type-ExportTaskSummary-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.  
Required: Yes

 ** format **   <a name="neptunegraph-Type-ExportTaskSummary-format"></a>
The format of the export task.  
Type: String  
Valid Values: `PARQUET | CSV`   
Required: Yes

 ** graphId **   <a name="neptunegraph-Type-ExportTaskSummary-graphId"></a>
The source graph identifier of the export task.  
Type: String  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** kmsKeyIdentifier **   <a name="neptunegraph-Type-ExportTaskSummary-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

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

 ** status **   <a name="neptunegraph-Type-ExportTaskSummary-status"></a>
The current status of the export task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED`   
Required: Yes

 ** taskId **   <a name="neptunegraph-Type-ExportTaskSummary-taskId"></a>
The unique identifier of the export task.  
Type: String  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

 ** parquetType **   <a name="neptunegraph-Type-ExportTaskSummary-parquetType"></a>
The parquet type of the export task.  
Type: String  
Valid Values: `COLUMNAR`   
Required: No

 ** statusReason **   <a name="neptunegraph-Type-ExportTaskSummary-statusReason"></a>
The reason that the export task has this status value.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ExportTaskSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ExportTaskSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ExportTaskSummary) 

# GraphDataSummary


Summary information about the graph.

## Contents


 ** edgeLabels **   <a name="neptunegraph-Type-GraphDataSummary-edgeLabels"></a>
A list of the edge labels in the graph.  
Type: Array of strings  
Required: No

 ** edgeProperties **   <a name="neptunegraph-Type-GraphDataSummary-edgeProperties"></a>
A list of the distinct edge properties in the graph, along with the count of edges where each property is used.  
Type: Array of string to long maps  
Required: No

 ** edgeStructures **   <a name="neptunegraph-Type-GraphDataSummary-edgeStructures"></a>
This field is only present when the requested mode is DETAILED. It contains a list of edge structures.  
Type: Array of [EdgeStructure](API_EdgeStructure.md) objects  
Required: No

 ** nodeLabels **   <a name="neptunegraph-Type-GraphDataSummary-nodeLabels"></a>
A list of distinct node labels in the graph.  
Type: Array of strings  
Required: No

 ** nodeProperties **   <a name="neptunegraph-Type-GraphDataSummary-nodeProperties"></a>
A list of the distinct node properties in the graph, along with the count of nodes where each property is used.  
Type: Array of string to long maps  
Required: No

 ** nodeStructures **   <a name="neptunegraph-Type-GraphDataSummary-nodeStructures"></a>
This field is only present when the requested mode is DETAILED. It contains a list of node structures.  
Type: Array of [NodeStructure](API_NodeStructure.md) objects  
Required: No

 ** numEdgeLabels **   <a name="neptunegraph-Type-GraphDataSummary-numEdgeLabels"></a>
The number of unique edge labels in the graph.  
Type: Long  
Required: No

 ** numEdgeProperties **   <a name="neptunegraph-Type-GraphDataSummary-numEdgeProperties"></a>
The number of edge properties in the graph.  
Type: Long  
Required: No

 ** numEdges **   <a name="neptunegraph-Type-GraphDataSummary-numEdges"></a>
The number of edges in the graph.  
Type: Long  
Required: No

 ** numNodeLabels **   <a name="neptunegraph-Type-GraphDataSummary-numNodeLabels"></a>
The number of distinct node labels in the graph.  
Type: Long  
Required: No

 ** numNodeProperties **   <a name="neptunegraph-Type-GraphDataSummary-numNodeProperties"></a>
The number of distinct node properties in the graph.  
Type: Long  
Required: No

 ** numNodes **   <a name="neptunegraph-Type-GraphDataSummary-numNodes"></a>
The number of nodes in the graph.  
Type: Long  
Required: No

 ** totalEdgePropertyValues **   <a name="neptunegraph-Type-GraphDataSummary-totalEdgePropertyValues"></a>
The total number of usages of all edge properties.  
Type: Long  
Required: No

 ** totalNodePropertyValues **   <a name="neptunegraph-Type-GraphDataSummary-totalNodePropertyValues"></a>
The total number of usages of all node properties.  
Type: Long  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GraphDataSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GraphDataSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GraphDataSummary) 

# GraphSnapshotSummary


Details about a graph snapshot.

## Contents


 ** arn **   <a name="neptunegraph-Type-GraphSnapshotSummary-arn"></a>
The ARN of the graph snapshot.  
Type: String  
Required: Yes

 ** id **   <a name="neptunegraph-Type-GraphSnapshotSummary-id"></a>
The unique identifier of the graph snapshot.  
Type: String  
Pattern: `gs-[a-z0-9]{10}`   
Required: Yes

 ** name **   <a name="neptunegraph-Type-GraphSnapshotSummary-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]+)*`   
Required: Yes

 ** kmsKeyIdentifier **   <a name="neptunegraph-Type-GraphSnapshotSummary-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}`   
Required: No

 ** snapshotCreateTime **   <a name="neptunegraph-Type-GraphSnapshotSummary-snapshotCreateTime"></a>
The time when the snapshot was created.  
Type: Timestamp  
Required: No

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

 ** status **   <a name="neptunegraph-Type-GraphSnapshotSummary-status"></a>
The status of the graph snapshot.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GraphSnapshotSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GraphSnapshotSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GraphSnapshotSummary) 

# GraphSummary


Summary details about a graph.

## Contents


 ** arn **   <a name="neptunegraph-Type-GraphSummary-arn"></a>
The ARN associated with the graph.  
Type: String  
Required: Yes

 ** id **   <a name="neptunegraph-Type-GraphSummary-id"></a>
The unique identifier of the graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}`   
Required: Yes

 ** name **   <a name="neptunegraph-Type-GraphSummary-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]+)*`   
Required: Yes

 ** deletionProtection **   <a name="neptunegraph-Type-GraphSummary-deletionProtection"></a>
If `true`, deletion protection is enabled for the graph.  
Type: Boolean  
Required: No

 ** endpoint **   <a name="neptunegraph-Type-GraphSummary-endpoint"></a>
The graph endpoint.  
Type: String  
Required: No

 ** kmsKeyIdentifier **   <a name="neptunegraph-Type-GraphSummary-kmsKeyIdentifier"></a>
The ID of the KMS key used to encrypt and decrypt graph data.  
Type: String  
Required: No

 ** provisionedMemory **   <a name="neptunegraph-Type-GraphSummary-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.  
Required: No

 ** publicConnectivity **   <a name="neptunegraph-Type-GraphSummary-publicConnectivity"></a>
If `true`, the graph has a public endpoint, otherwise not.  
Type: Boolean  
Required: No

 ** replicaCount **   <a name="neptunegraph-Type-GraphSummary-replicaCount"></a>
The number of replicas for the graph.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.  
Required: No

 ** status **   <a name="neptunegraph-Type-GraphSummary-status"></a>
The status of the graph.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING | STARTING | STOPPING | STOPPED`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/GraphSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/GraphSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/GraphSummary) 

# ImportOptions


Options for how to perform an import.

## Contents


**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** neptune **   <a name="neptunegraph-Type-ImportOptions-neptune"></a>
Options for importing data from a Neptune database.  
Type: [NeptuneImportOptions](API_NeptuneImportOptions.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ImportOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ImportOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ImportOptions) 

# ImportTaskDetails


Contains details about an import task.

## Contents


 ** dictionaryEntryCount **   <a name="neptunegraph-Type-ImportTaskDetails-dictionaryEntryCount"></a>
The number of dictionary entries in the import task.  
Type: Long  
Required: Yes

 ** errorCount **   <a name="neptunegraph-Type-ImportTaskDetails-errorCount"></a>
The number of errors encountered so far.  
Type: Integer  
Required: Yes

 ** progressPercentage **   <a name="neptunegraph-Type-ImportTaskDetails-progressPercentage"></a>
The percentage progress so far.  
Type: Integer  
Required: Yes

 ** startTime **   <a name="neptunegraph-Type-ImportTaskDetails-startTime"></a>
Time at which the import task started.  
Type: Timestamp  
Required: Yes

 ** statementCount **   <a name="neptunegraph-Type-ImportTaskDetails-statementCount"></a>
The number of statements in the import task.  
Type: Long  
Required: Yes

 ** status **   <a name="neptunegraph-Type-ImportTaskDetails-status"></a>
Status of the import task.  
Type: String  
Required: Yes

 ** timeElapsedSeconds **   <a name="neptunegraph-Type-ImportTaskDetails-timeElapsedSeconds"></a>
Seconds elapsed since the import task started.  
Type: Long  
Required: Yes

 ** errorDetails **   <a name="neptunegraph-Type-ImportTaskDetails-errorDetails"></a>
Details about the errors that have been encountered.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ImportTaskDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ImportTaskDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ImportTaskDetails) 

# ImportTaskSummary


Details about an import task.

## Contents


 ** roleArn **   <a name="neptunegraph-Type-ImportTaskSummary-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 **   <a name="neptunegraph-Type-ImportTaskSummary-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

 ** status **   <a name="neptunegraph-Type-ImportTaskSummary-status"></a>
Status of the import task.  
Type: String  
Valid Values: `INITIALIZING | EXPORTING | ANALYZING_DATA | IMPORTING | REPROVISIONING | ROLLING_BACK | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED`   
Required: Yes

 ** taskId **   <a name="neptunegraph-Type-ImportTaskSummary-taskId"></a>
The unique identifier of the import task.  
Type: String  
Pattern: `t-[a-z0-9]{10}`   
Required: Yes

 ** format **   <a name="neptunegraph-Type-ImportTaskSummary-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`   
Required: No

 ** graphId **   <a name="neptunegraph-Type-ImportTaskSummary-graphId"></a>
The unique identifier of the Neptune Analytics graph.  
Type: String  
Pattern: `g-[a-z0-9]{10}`   
Required: No

 ** parquetType **   <a name="neptunegraph-Type-ImportTaskSummary-parquetType"></a>
The parquet type of the import task.  
Type: String  
Valid Values: `COLUMNAR`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/ImportTaskSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/ImportTaskSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/ImportTaskSummary) 

# NeptuneImportOptions


Options for how to import Neptune data.

## Contents


 ** s3ExportKmsKeyId **   <a name="neptunegraph-Type-NeptuneImportOptions-s3ExportKmsKeyId"></a>
The KMS key to use to encrypt data in the S3 bucket where the graph data is exported  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** s3ExportPath **   <a name="neptunegraph-Type-NeptuneImportOptions-s3ExportPath"></a>
The path to an S3 bucket from which to import data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** preserveDefaultVertexLabels **   <a name="neptunegraph-Type-NeptuneImportOptions-preserveDefaultVertexLabels"></a>
Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting *preserveDefaultVertexLabels* to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.  
Type: Boolean  
Required: No

 ** preserveEdgeIds **   <a name="neptunegraph-Type-NeptuneImportOptions-preserveEdgeIds"></a>
Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if *preserveEdgeIds* is set to true, and ids are stored as properties on the relationships with the property name *neptuneEdgeId*.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/NeptuneImportOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/NeptuneImportOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/NeptuneImportOptions) 

# NodeStructure


Information about a node.

## Contents


 ** count **   <a name="neptunegraph-Type-NodeStructure-count"></a>
The number of instances of this node.  
Type: Long  
Required: No

 ** distinctOutgoingEdgeLabels **   <a name="neptunegraph-Type-NodeStructure-distinctOutgoingEdgeLabels"></a>
The outgoing edge labels associated with this node.  
Type: Array of strings  
Required: No

 ** nodeProperties **   <a name="neptunegraph-Type-NodeStructure-nodeProperties"></a>
Properties associated with this node.  
Type: Array of strings  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/NodeStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/NodeStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/NodeStructure) 

# PrivateGraphEndpointSummary


Details about a private graph endpoint.

## Contents


 ** status **   <a name="neptunegraph-Type-PrivateGraphEndpointSummary-status"></a>
The status of the private graph endpoint.  
Type: String  
Valid Values: `CREATING | AVAILABLE | DELETING | FAILED`   
Required: Yes

 ** subnetIds **   <a name="neptunegraph-Type-PrivateGraphEndpointSummary-subnetIds"></a>
The subnet IDs associated with the private graph endpoint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Pattern: `subnet-[a-z0-9]+`   
Required: Yes

 ** vpcId **   <a name="neptunegraph-Type-PrivateGraphEndpointSummary-vpcId"></a>
The ID of the VPC in which the private graph endpoint is located.  
Type: String  
Pattern: `vpc-[a-z0-9]+`   
Required: Yes

 ** vpcEndpointId **   <a name="neptunegraph-Type-PrivateGraphEndpointSummary-vpcEndpointId"></a>
The ID of the VPC endpoint.  
Type: String  
Pattern: `vpce-[0-9a-f]{17}`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/PrivateGraphEndpointSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/PrivateGraphEndpointSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/PrivateGraphEndpointSummary) 

# QuerySummary


Details of the query listed.

## Contents


 ** elapsed **   <a name="neptunegraph-Type-QuerySummary-elapsed"></a>
The running time of the query, in milliseconds.  
Type: Integer  
Required: No

 ** id **   <a name="neptunegraph-Type-QuerySummary-id"></a>
A string representation of the id of the query.  
Type: String  
Required: No

 ** queryString **   <a name="neptunegraph-Type-QuerySummary-queryString"></a>
The actual query text. The `queryString` may be truncated if the actual query string is too long.  
Type: String  
Required: No

 ** state **   <a name="neptunegraph-Type-QuerySummary-state"></a>
State of the query.  
Type: String  
Valid Values: `RUNNING | WAITING | CANCELLING`   
Required: No

 ** waited **   <a name="neptunegraph-Type-QuerySummary-waited"></a>
The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.  
Type: Integer  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/QuerySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/QuerySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/QuerySummary) 

# VectorSearchConfiguration


Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535

## Contents


 ** dimension **   <a name="neptunegraph-Type-VectorSearchConfiguration-dimension"></a>
The number of dimensions.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65536.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-graph-2023-11-29/VectorSearchConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-graph-2023-11-29/VectorSearchConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-graph-2023-11-29/VectorSearchConfiguration)