SDK for PHP 3.x

Client: Aws\NeptuneGraph\NeptuneGraphClient
Service ID: neptune-graph
Version: 2023-11-29

This page describes the parameters and results for the operations of the Amazon Neptune Graph (2023-11-29), and shows how to use the Aws\NeptuneGraph\NeptuneGraphClient object to call the described operations. This documentation is specific to the 2023-11-29 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelImportTask ( array $params = [] )
Deletes the specified import task.
CancelQuery ( array $params = [] )
Cancels a specified query.
CreateGraph ( array $params = [] )
Creates a new Neptune Analytics graph.
CreateGraphSnapshot ( array $params = [] )
Creates a snapshot of the specific graph.
CreateGraphUsingImportTask ( array $params = [] )
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.
CreatePrivateGraphEndpoint ( array $params = [] )
Create a private graph endpoint to allow private access from to the graph from within a VPC.
DeleteGraph ( array $params = [] )
Deletes the specified graph.
DeleteGraphSnapshot ( array $params = [] )
Deletes the specifed graph snapshot.
DeletePrivateGraphEndpoint ( array $params = [] )
Deletes a private graph endpoint.
ExecuteQuery ( array $params = [] )
Execute an openCypher query.
GetGraph ( array $params = [] )
Gets information about a specified graph.
GetGraphSnapshot ( array $params = [] )
Retrieves a specified graph snapshot.
GetGraphSummary ( array $params = [] )
Gets a graph summary for a property graph.
GetImportTask ( array $params = [] )
Retrieves a specified import task.
GetPrivateGraphEndpoint ( array $params = [] )
Retrieves information about a specified private endpoint.
GetQuery ( array $params = [] )
Retrieves the status of a specified query.
ListGraphSnapshots ( array $params = [] )
Lists available snapshots of a specified Neptune Analytics graph.
ListGraphs ( array $params = [] )
Lists available Neptune Analytics graphs.
ListImportTasks ( array $params = [] )
Lists import tasks.
ListPrivateGraphEndpoints ( array $params = [] )
Lists private endpoints for a specified Neptune Analytics graph.
ListQueries ( array $params = [] )
Lists active openCypher queries.
ListTagsForResource ( array $params = [] )
Lists tags associated with a specified resource.
ResetGraph ( array $params = [] )
Empties the data from a specified Neptune Analytics graph.
RestoreGraphFromSnapshot ( array $params = [] )
Restores a graph from a snapshot.
StartImportTask ( array $params = [] )
Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3).
TagResource ( array $params = [] )
Adds tags to the specified resource.
UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
UpdateGraph ( array $params = [] )
Updates the configuration of a specified Neptune Analytics graph

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListGraphSnapshots
ListGraphs
ListImportTasks
ListPrivateGraphEndpoints

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
GraphAvailable GetGraph 60 480
GraphDeleted GetGraph 60 60
GraphSnapshotAvailable GetGraphSnapshot 60 120
GraphSnapshotDeleted GetGraphSnapshot 60 60
ImportTaskCancelled GetImportTask 60 60
ImportTaskSuccessful GetImportTask 60 480
PrivateGraphEndpointAvailable GetPrivateGraphEndpoint 10 180
PrivateGraphEndpointDeleted GetPrivateGraphEndpoint 10 180

Operations

CancelImportTask

$result = $client->cancelImportTask([/* ... */]);
$promise = $client->cancelImportTaskAsync([/* ... */]);

Deletes the specified import task.

Parameter Syntax

$result = $client->cancelImportTask([
    'taskIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
taskIdentifier
Required: Yes
Type: string

The unique identifier of the import task.

Result Syntax

[
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphId' => '<string>',
    'roleArn' => '<string>',
    'source' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
    'taskId' => '<string>',
]

Result Details

Members
format
Type: string

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

graphId
Type: string

The unique identifier of the Neptune Analytics graph.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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.

status
Required: Yes
Type: string

Current status of the task. Status is CANCELLING when the import task is cancelled.

taskId
Required: Yes
Type: string

The unique identifier of the import task.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

CancelQuery

$result = $client->cancelQuery([/* ... */]);
$promise = $client->cancelQueryAsync([/* ... */]);

Cancels a specified query.

Parameter Syntax

$result = $client->cancelQuery([
    'graphIdentifier' => '<string>', // REQUIRED
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

queryId
Required: Yes
Type: string

The unique identifier of the query to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

AccessDeniedException:

Raised in case of an authentication or authorization failure.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

CreateGraph

$result = $client->createGraph([/* ... */]);
$promise = $client->createGraphAsync([/* ... */]);

Creates a new Neptune Analytics graph.

Parameter Syntax

$result = $client->createGraph([
    'deletionProtection' => true || false,
    'graphName' => '<string>', // REQUIRED
    'kmsKeyIdentifier' => '<string>',
    'provisionedMemory' => <integer>, // REQUIRED
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'tags' => ['<string>', ...],
    'vectorSearchConfiguration' => [
        'dimension' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Members
deletionProtection
Type: boolean

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).

graphName
Required: Yes
Type: string

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.

kmsKeyIdentifier
Type: string

Specifies a KMS key to use to encrypt data in the new graph.

provisionedMemory
Required: Yes
Type: int

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128

publicConnectivity
Type: boolean

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.

replicaCount
Type: int

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the graph.

buildNumber
Type: string

The build number of the graph software.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the graph was created.

deletionProtection
Type: boolean

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The ID of the graph.

kmsKeyIdentifier
Type: string

Specifies the KMS key used to encrypt data in the new graph.

name
Required: Yes
Type: string

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.

provisionedMemory
Type: int

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 128

publicConnectivity
Type: boolean

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.

replicaCount
Type: int

The number of replicas in other AZs.

Default: If not specified, the default value is 1.

sourceSnapshotId
Type: string

The ID of the source graph.

status
Type: string

The current status of the graph.

statusReason
Type: string

The reason the status was given.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

Errors

ServiceQuotaExceededException:

A service quota was exceeded.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

CreateGraphSnapshot

$result = $client->createGraphSnapshot([/* ... */]);
$promise = $client->createGraphSnapshotAsync([/* ... */]);

Creates a snapshot of the specific graph.

Parameter Syntax

$result = $client->createGraphSnapshot([
    'graphIdentifier' => '<string>', // REQUIRED
    'snapshotName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

snapshotName
Required: Yes
Type: string

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'snapshotCreateTime' => <DateTime>,
    'sourceGraphId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the snapshot created.

id
Required: Yes
Type: string

The ID of the snapshot created.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the snapshot created.

snapshotCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The snapshot creation time

sourceGraphId
Type: string

The Id of the Neptune Analytics graph from which the snapshot is created.

status
Type: string

The current state of the snapshot.

Errors

ServiceQuotaExceededException:

A service quota was exceeded.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

CreateGraphUsingImportTask

$result = $client->createGraphUsingImportTask([/* ... */]);
$promise = $client->createGraphUsingImportTaskAsync([/* ... */]);

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 or the openCypher load format.

Parameter Syntax

$result = $client->createGraphUsingImportTask([
    'blankNodeHandling' => 'convertToIri',
    'deletionProtection' => true || false,
    'failOnError' => true || false,
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphName' => '<string>', // REQUIRED
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>', // REQUIRED
            's3ExportPath' => '<string>', // REQUIRED
        ],
    ],
    'kmsKeyIdentifier' => '<string>',
    'maxProvisionedMemory' => <integer>,
    'minProvisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'roleArn' => '<string>', // REQUIRED
    'source' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'vectorSearchConfiguration' => [
        'dimension' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Members
blankNodeHandling
Type: string

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.

deletionProtection
Type: boolean

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).

failOnError
Type: boolean

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.

format
Type: string

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPEN_CYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.

graphName
Required: Yes
Type: string

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.

importOptions
Type: ImportOptions structure

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.

kmsKeyIdentifier
Type: string

Specifies a KMS key to use to encrypt data imported into the new graph.

maxProvisionedMemory
Type: int

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 max of the min-provisioned-memory and max-provisioned memory is used to create the graph. If neither value is specified 128 m-NCUs are used.

minProvisionedMemory
Type: int

The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128

publicConnectivity
Type: boolean

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).

replicaCount
Type: int

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.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Result Syntax

[
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphId' => '<string>',
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>',
            's3ExportPath' => '<string>',
        ],
    ],
    'roleArn' => '<string>',
    'source' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
    'taskId' => '<string>',
]

Result Details

Members
format
Type: string

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPENCYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.

graphId
Type: string

The unique identifier of the Neptune Analytics graph.

importOptions
Type: ImportOptions structure

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.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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.

status
Required: Yes
Type: string

The status of the import task.

taskId
Required: Yes
Type: string

The unique identifier of the import task.

Errors

ServiceQuotaExceededException:

A service quota was exceeded.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

CreatePrivateGraphEndpoint

$result = $client->createPrivateGraphEndpoint([/* ... */]);
$promise = $client->createPrivateGraphEndpointAsync([/* ... */]);

Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.

VPC endpoint charges apply.

Parameter Syntax

$result = $client->createPrivateGraphEndpoint([
    'graphIdentifier' => '<string>', // REQUIRED
    'subnetIds' => ['<string>', ...],
    'vpcId' => '<string>',
    'vpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

subnetIds
Type: Array of strings

Subnets in which private graph endpoint ENIs are created.

vpcId
Type: string

The VPC in which the private graph endpoint needs to be created.

vpcSecurityGroupIds
Type: Array of strings

Security groups to be attached to the private graph endpoint..

Result Syntax

[
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
    'subnetIds' => ['<string>', ...],
    'vpcEndpointId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: string

Status of the private graph endpoint.

subnetIds
Required: Yes
Type: Array of strings

Subnets in which the private graph endpoint ENIs are created.

vpcEndpointId
Type: string

Endpoint ID of the prviate grpah endpoint.

vpcId
Required: Yes
Type: string

VPC in which the private graph endpoint is created.

Errors

ServiceQuotaExceededException:

A service quota was exceeded.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

DeleteGraph

$result = $client->deleteGraph([/* ... */]);
$promise = $client->deleteGraphAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteGraph([
    'graphIdentifier' => '<string>', // REQUIRED
    'skipSnapshot' => true || false, // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

skipSnapshot
Required: Yes
Type: boolean

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.

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

buildNumber
Type: string

The build number associated with the graph.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the graph was created.

deletionProtection
Type: boolean

If true, deletion protection was enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

sourceSnapshotId
Type: string

The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.

status
Type: string

The status of the graph.

statusReason
Type: string

The reason for the status of the graph.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

DeleteGraphSnapshot

$result = $client->deleteGraphSnapshot([/* ... */]);
$promise = $client->deleteGraphSnapshotAsync([/* ... */]);

Deletes the specifed graph snapshot.

Parameter Syntax

$result = $client->deleteGraphSnapshot([
    'snapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
snapshotIdentifier
Required: Yes
Type: string

ID of the graph snapshot to be deleted.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'snapshotCreateTime' => <DateTime>,
    'sourceGraphId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the graph snapshot.

id
Required: Yes
Type: string

The unique identifier of the graph snapshot.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt the snapshot.

name
Required: Yes
Type: string

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.

snapshotCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the snapshot was created.

sourceGraphId
Type: string

The graph identifier for the graph from which the snapshot was created.

status
Type: string

The status of the graph snapshot.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

DeletePrivateGraphEndpoint

$result = $client->deletePrivateGraphEndpoint([/* ... */]);
$promise = $client->deletePrivateGraphEndpointAsync([/* ... */]);

Deletes a private graph endpoint.

Parameter Syntax

$result = $client->deletePrivateGraphEndpoint([
    'graphIdentifier' => '<string>', // REQUIRED
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

vpcId
Required: Yes
Type: string

The ID of the VPC where the private endpoint is located.

Result Syntax

[
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
    'subnetIds' => ['<string>', ...],
    'vpcEndpointId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: string

The status of the delete operation.

subnetIds
Required: Yes
Type: Array of strings

The subnet IDs involved.

vpcEndpointId
Type: string

The ID of the VPC endpoint that was deleted.

vpcId
Required: Yes
Type: string

The ID of the VPC where the private endpoint was deleted.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ExecuteQuery

$result = $client->executeQuery([/* ... */]);
$promise = $client->executeQueryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->executeQuery([
    'explainMode' => 'STATIC|DETAILS',
    'graphIdentifier' => '<string>', // REQUIRED
    'language' => 'OPEN_CYPHER', // REQUIRED
    'parameters' => [
        '<String>' => [
        ],
        // ...
    ],
    'planCache' => 'ENABLED|DISABLED|AUTO',
    'queryString' => '<string>', // REQUIRED
    'queryTimeoutMilliseconds' => <integer>,
]);

Parameter Details

Members
explainMode
Type: string

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.

graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

language
Required: Yes
Type: string

The query language the query is written in. Currently only openCypher is supported.

parameters
Type: Associative array of custom strings keys (String) to document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documentss

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

planCache
Type: string

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.

queryString
Required: Yes
Type: string

The query string to be executed.

queryTimeoutMilliseconds
Type: int

Specifies the query timeout duration, in milliseconds. (optional)

Result Syntax

[
    'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members
payload
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The query results.

Errors

UnprocessableException:

Request cannot be processed due to known reasons. Eg. partition full.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

AccessDeniedException:

Raised in case of an authentication or authorization failure.

InternalServerException:

A failure occurred on the server.

GetGraph

$result = $client->getGraph([/* ... */]);
$promise = $client->getGraphAsync([/* ... */]);

Gets information about a specified graph.

Parameter Syntax

$result = $client->getGraph([
    'graphIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

buildNumber
Type: string

The build number of the graph.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the graph was created.

deletionProtection
Type: boolean

If true, deletion protection is enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

sourceSnapshotId
Type: string

The ID of the snapshot from which the graph was created, if it was created from a snapshot.

status
Type: string

The status of the graph.

statusReason
Type: string

The reason that the graph has this status.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

GetGraphSnapshot

$result = $client->getGraphSnapshot([/* ... */]);
$promise = $client->getGraphSnapshotAsync([/* ... */]);

Retrieves a specified graph snapshot.

Parameter Syntax

$result = $client->getGraphSnapshot([
    'snapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
snapshotIdentifier
Required: Yes
Type: string

The ID of the snapshot to retrieve.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'snapshotCreateTime' => <DateTime>,
    'sourceGraphId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the graph snapshot.

id
Required: Yes
Type: string

The unique identifier of the graph snapshot.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt the snapshot.

name
Required: Yes
Type: string

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.

snapshotCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the snapshot was created.

sourceGraphId
Type: string

The graph identifier for the graph for which a snapshot is to be created.

status
Type: string

The status of the graph snapshot.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

GetGraphSummary

$result = $client->getGraphSummary([/* ... */]);
$promise = $client->getGraphSummaryAsync([/* ... */]);

Gets a graph summary for a property graph.

Parameter Syntax

$result = $client->getGraphSummary([
    'graphIdentifier' => '<string>', // REQUIRED
    'mode' => 'BASIC|DETAILED',
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

mode
Type: string

The summary mode can take one of two values: basic (the default), and detailed.

Result Syntax

[
    'graphSummary' => [
        'edgeLabels' => ['<string>', ...],
        'edgeProperties' => [
            [<integer>, ...],
            // ...
        ],
        'edgeStructures' => [
            [
                'count' => <integer>,
                'edgeProperties' => ['<string>', ...],
            ],
            // ...
        ],
        'nodeLabels' => ['<string>', ...],
        'nodeProperties' => [
            [<integer>, ...],
            // ...
        ],
        'nodeStructures' => [
            [
                'count' => <integer>,
                'distinctOutgoingEdgeLabels' => ['<string>', ...],
                'nodeProperties' => ['<string>', ...],
            ],
            // ...
        ],
        'numEdgeLabels' => <integer>,
        'numEdgeProperties' => <integer>,
        'numEdges' => <integer>,
        'numNodeLabels' => <integer>,
        'numNodeProperties' => <integer>,
        'numNodes' => <integer>,
        'totalEdgePropertyValues' => <integer>,
        'totalNodePropertyValues' => <integer>,
    ],
    'lastStatisticsComputationTime' => <DateTime>,
    'version' => '<string>',
]

Result Details

Members
graphSummary
Type: GraphDataSummary structure

The graph summary.

lastStatisticsComputationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.

version
Type: string

Display the version of this tool.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

AccessDeniedException:

Raised in case of an authentication or authorization failure.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

GetImportTask

$result = $client->getImportTask([/* ... */]);
$promise = $client->getImportTaskAsync([/* ... */]);

Retrieves a specified import task.

Parameter Syntax

$result = $client->getImportTask([
    'taskIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
taskIdentifier
Required: Yes
Type: string

The unique identifier of the import task.

Result Syntax

[
    'attemptNumber' => <integer>,
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphId' => '<string>',
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>',
            's3ExportPath' => '<string>',
        ],
    ],
    'importTaskDetails' => [
        'dictionaryEntryCount' => <integer>,
        'errorCount' => <integer>,
        'errorDetails' => '<string>',
        'progressPercentage' => <integer>,
        'startTime' => <DateTime>,
        'statementCount' => <integer>,
        'status' => '<string>',
        'timeElapsedSeconds' => <integer>,
    ],
    'roleArn' => '<string>',
    'source' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
    'statusReason' => '<string>',
    'taskId' => '<string>',
]

Result Details

Members
attemptNumber
Type: int

The number of the current attempt to execute the import task.

format
Type: string

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

graphId
Type: string

The unique identifier of the Neptune Analytics graph.

importOptions
Type: ImportOptions structure

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.

importTaskDetails
Type: ImportTaskDetails structure

Contains details about the specified import task.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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

status
Required: Yes
Type: string

The status of the import task:

  • INITIALIZING   –   The necessary resources needed to create the graph are being prepared.

  • ANALYZING_DATA   –   The data is being analyzed to determine the optimal infrastructure configuration for the new graph.

  • RE_PROVISIONING   –   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_ENCOUNTERED   –   An error has been encountered while trying to create the graph and import the data.

  • ERROR_ENCOUNTERED_ROLLING_BACK   –   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.

statusReason
Type: string

The reason that the import task has this status value.

taskId
Required: Yes
Type: string

The unique identifier of the import task.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

GetPrivateGraphEndpoint

$result = $client->getPrivateGraphEndpoint([/* ... */]);
$promise = $client->getPrivateGraphEndpointAsync([/* ... */]);

Retrieves information about a specified private endpoint.

Parameter Syntax

$result = $client->getPrivateGraphEndpoint([
    'graphIdentifier' => '<string>', // REQUIRED
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

vpcId
Required: Yes
Type: string

The ID of the VPC where the private endpoint is located.

Result Syntax

[
    'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
    'subnetIds' => ['<string>', ...],
    'vpcEndpointId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
status
Required: Yes
Type: string

The current status of the private endpoint.

subnetIds
Required: Yes
Type: Array of strings

The subnet IDs involved.

vpcEndpointId
Type: string

The ID of the private endpoint.

vpcId
Required: Yes
Type: string

The ID of the VPC where the private endpoint is located.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

GetQuery

$result = $client->getQuery([/* ... */]);
$promise = $client->getQueryAsync([/* ... */]);

Retrieves the status of a specified query.

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.

Parameter Syntax

$result = $client->getQuery([
    'graphIdentifier' => '<string>', // REQUIRED
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

queryId
Required: Yes
Type: string

The ID of the query in question.

Result Syntax

[
    'elapsed' => <integer>,
    'id' => '<string>',
    'queryString' => '<string>',
    'state' => 'RUNNING|WAITING|CANCELLING',
    'waited' => <integer>,
]

Result Details

Members
elapsed
Type: int

The number of milliseconds the query has been running.

id
Type: string

The ID of the query in question.

queryString
Type: string

The query in question.

state
Type: string

State of the query.

waited
Type: int

Indicates how long the query waited, in milliseconds.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

AccessDeniedException:

Raised in case of an authentication or authorization failure.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ListGraphSnapshots

$result = $client->listGraphSnapshots([/* ... */]);
$promise = $client->listGraphSnapshotsAsync([/* ... */]);

Lists available snapshots of a specified Neptune Analytics graph.

Parameter Syntax

$result = $client->listGraphSnapshots([
    'graphIdentifier' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
graphIdentifier
Type: string

The unique identifier of the Neptune Analytics graph.

maxResults
Type: int

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.

nextToken
Type: string

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.

Result Syntax

[
    'graphSnapshots' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'kmsKeyIdentifier' => '<string>',
            'name' => '<string>',
            'snapshotCreateTime' => <DateTime>,
            'sourceGraphId' => '<string>',
            'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
graphSnapshots
Required: Yes
Type: Array of GraphSnapshotSummary structures

The requested list of snapshots.

nextToken
Type: string

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.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ListGraphs

$result = $client->listGraphs([/* ... */]);
$promise = $client->listGraphsAsync([/* ... */]);

Lists available Neptune Analytics graphs.

Parameter Syntax

$result = $client->listGraphs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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.

nextToken
Type: string

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.

Result Syntax

[
    'graphs' => [
        [
            'arn' => '<string>',
            'deletionProtection' => true || false,
            'endpoint' => '<string>',
            'id' => '<string>',
            'kmsKeyIdentifier' => '<string>',
            'name' => '<string>',
            'provisionedMemory' => <integer>,
            'publicConnectivity' => true || false,
            'replicaCount' => <integer>,
            'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
graphs
Required: Yes
Type: Array of GraphSummary structures

A list of the graphs.

nextToken
Type: string

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.

Errors

ThrottlingException:

The exception was interrupted by throttling.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ListImportTasks

$result = $client->listImportTasks([/* ... */]);
$promise = $client->listImportTasksAsync([/* ... */]);

Lists import tasks.

Parameter Syntax

$result = $client->listImportTasks([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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.

nextToken
Type: string

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.

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
            'graphId' => '<string>',
            'roleArn' => '<string>',
            'source' => '<string>',
            'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
            'taskId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

tasks
Required: Yes
Type: Array of ImportTaskSummary structures

The requested list of import tasks.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ListPrivateGraphEndpoints

$result = $client->listPrivateGraphEndpoints([/* ... */]);
$promise = $client->listPrivateGraphEndpointsAsync([/* ... */]);

Lists private endpoints for a specified Neptune Analytics graph.

Parameter Syntax

$result = $client->listPrivateGraphEndpoints([
    'graphIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

maxResults
Type: int

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.

nextToken
Type: string

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.

Result Syntax

[
    'nextToken' => '<string>',
    'privateGraphEndpoints' => [
        [
            'status' => 'CREATING|AVAILABLE|DELETING|FAILED',
            'subnetIds' => ['<string>', ...],
            'vpcEndpointId' => '<string>',
            'vpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

privateGraphEndpoints
Required: Yes
Type: Array of PrivateGraphEndpointSummary structures

A list of private endpoints for the specified Neptune Analytics graph.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ListQueries

$result = $client->listQueries([/* ... */]);
$promise = $client->listQueriesAsync([/* ... */]);

Lists active openCypher queries.

Parameter Syntax

$result = $client->listQueries([
    'graphIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>, // REQUIRED
    'state' => 'ALL|RUNNING|WAITING|CANCELLING',
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

maxResults
Required: Yes
Type: int

The maximum number of results to be fetched by the API.

state
Type: string

Filtered list of queries based on state.

Result Syntax

[
    'queries' => [
        [
            'elapsed' => <integer>,
            'id' => '<string>',
            'queryString' => '<string>',
            'state' => 'RUNNING|WAITING|CANCELLING',
            'waited' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
queries
Required: Yes
Type: Array of QuerySummary structures

A list of current openCypher queries.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

AccessDeniedException:

Raised in case of an authentication or authorization failure.

InternalServerException:

A failure occurred on the server.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags associated with a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of metadata tags associated with the resource.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

ResetGraph

$result = $client->resetGraph([/* ... */]);
$promise = $client->resetGraphAsync([/* ... */]);

Empties the data from a specified Neptune Analytics graph.

Parameter Syntax

$result = $client->resetGraph([
    'graphIdentifier' => '<string>', // REQUIRED
    'skipSnapshot' => true || false, // REQUIRED
]);

Parameter Details

Members
graphIdentifier
Required: Yes
Type: string

ID of the graph to reset.

skipSnapshot
Required: Yes
Type: boolean

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.

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

buildNumber
Type: string

The build number of the graph.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the graph was created.

deletionProtection
Type: boolean

If true, deletion protection is enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

sourceSnapshotId
Type: string

The ID of the snapshot from which the graph was created, if any.

status
Type: string

The status of the graph.

statusReason
Type: string

The reason that the graph has this status.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

RestoreGraphFromSnapshot

$result = $client->restoreGraphFromSnapshot([/* ... */]);
$promise = $client->restoreGraphFromSnapshotAsync([/* ... */]);

Restores a graph from a snapshot.

Parameter Syntax

$result = $client->restoreGraphFromSnapshot([
    'deletionProtection' => true || false,
    'graphName' => '<string>', // REQUIRED
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'snapshotIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
deletionProtection
Type: boolean

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

graphName
Required: Yes
Type: string

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.

provisionedMemory
Type: int

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 128

publicConnectivity
Type: boolean

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).

replicaCount
Type: int

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.

snapshotIdentifier
Required: Yes
Type: string

The ID of the snapshot in question.

tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

buildNumber
Type: string

The build number of the graph.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the graph was created.

deletionProtection
Type: boolean

If true, deletion protection is enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

sourceSnapshotId
Type: string

The ID of the snapshot from which the graph was created, if any.

status
Type: string

The status of the graph.

statusReason
Type: string

The reason that the graph has this status.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Errors

ServiceQuotaExceededException:

A service quota was exceeded.

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

StartImportTask

$result = $client->startImportTask([/* ... */]);
$promise = $client->startImportTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startImportTask([
    'blankNodeHandling' => 'convertToIri',
    'failOnError' => true || false,
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphIdentifier' => '<string>', // REQUIRED
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>', // REQUIRED
            's3ExportPath' => '<string>', // REQUIRED
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'source' => '<string>', // REQUIRED
]);

Parameter Details

Members
blankNodeHandling
Type: string

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.

failOnError
Type: boolean

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.

format
Type: string

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.

graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

importOptions
Type: ImportOptions structure

Options for how to perform an import.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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.

Result Syntax

[
    'format' => 'CSV|OPEN_CYPHER|NTRIPLES',
    'graphId' => '<string>',
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>',
            's3ExportPath' => '<string>',
        ],
    ],
    'roleArn' => '<string>',
    'source' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
    'taskId' => '<string>',
]

Result Details

Members
format
Type: string

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.

graphId
Type: string

The unique identifier of the Neptune Analytics graph.

importOptions
Type: ImportOptions structure

Options for how to perform an import.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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.

status
Required: Yes
Type: string

The status of the import task.

taskId
Required: Yes
Type: string

The unique identifier of the import task.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

ARN of the resource for which tags need to be added.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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}_.:/=+\-]*)$").

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

ARN of the resource whose tag needs to be removed.

tagKeys
Required: Yes
Type: Array of strings

Tag keys for the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

UpdateGraph

$result = $client->updateGraph([/* ... */]);
$promise = $client->updateGraphAsync([/* ... */]);

Updates the configuration of a specified Neptune Analytics graph

Parameter Syntax

$result = $client->updateGraph([
    'deletionProtection' => true || false,
    'graphIdentifier' => '<string>', // REQUIRED
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
]);

Parameter Details

Members
deletionProtection
Type: boolean

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

graphIdentifier
Required: Yes
Type: string

The unique identifier of the Neptune Analytics graph.

provisionedMemory
Type: int

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 128

publicConnectivity
Type: boolean

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.

Result Syntax

[
    'arn' => '<string>',
    'buildNumber' => '<string>',
    'createTime' => <DateTime>,
    'deletionProtection' => true || false,
    'endpoint' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'provisionedMemory' => <integer>,
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'sourceSnapshotId' => '<string>',
    'status' => 'CREATING|AVAILABLE|DELETING|RESETTING|UPDATING|SNAPSHOTTING|FAILED|IMPORTING',
    'statusReason' => '<string>',
    'vectorSearchConfiguration' => [
        'dimension' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

buildNumber
Type: string

The build number of the graph.

createTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the graph was created.

deletionProtection
Type: boolean

If true, deletion protection is enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

sourceSnapshotId
Type: string

The ID of the snapshot from which the graph was created, if any.

status
Type: string

The status of the graph.

statusReason
Type: string

The reason that the graph has this status.

vectorSearchConfiguration
Type: VectorSearchConfiguration structure

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

Errors

ThrottlingException:

The exception was interrupted by throttling.

ValidationException:

A resource could not be validated.

ConflictException:

Raised when a conflict is encountered.

InternalServerException:

A failure occurred on the server.

ResourceNotFoundException:

A specified resource could not be located.

Shapes

AccessDeniedException

Description

Raised in case of an authentication or authorization failure.

Members
message
Required: Yes
Type: string

A message describing the problem.

ConflictException

Description

Raised when a conflict is encountered.

Members
message
Required: Yes
Type: string

A message describing the problem.

reason
Type: string

The reason for the conflict exception.

Document

Members

EdgeStructure

Description

Contains information about an edge in a Neptune Analytics graph.

Members
count
Type: long (int|float)

The number of instances of the edge in the graph.

edgeProperties
Type: Array of strings

A list of the properties associated with the edge.

GraphDataSummary

Description

Summary information about the graph.

Members
edgeLabels
Type: Array of strings

A list of the edge labels in the graph.

edgeProperties
Type: Array of maps

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

edgeStructures
Type: Array of EdgeStructure structures

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

nodeLabels
Type: Array of strings

A list of distinct node labels in the graph.

nodeProperties
Type: Array of maps

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

nodeStructures
Type: Array of NodeStructure structures

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

numEdgeLabels
Type: long (int|float)

The number of unique edge labels in the graph.

numEdgeProperties
Type: long (int|float)

The number of edge properties in the graph.

numEdges
Type: long (int|float)

The number of edges in the graph.

numNodeLabels
Type: long (int|float)

The number of distinct node labels in the graph.

numNodeProperties
Type: long (int|float)

The number of distinct node properties in the graph.

numNodes
Type: long (int|float)

The number of nodes in the graph.

totalEdgePropertyValues
Type: long (int|float)

The total number of usages of all edge properties.

totalNodePropertyValues
Type: long (int|float)

The total number of usages of all node properties.

GraphSnapshotSummary

Description

Details about a graph snapshot.

Members
arn
Required: Yes
Type: string

The ARN of the graph snapshot.

id
Required: Yes
Type: string

The unique identifier of the graph snapshot.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt the snapshot.

name
Required: Yes
Type: string

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.

snapshotCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the snapshot was created.

sourceGraphId
Type: string

The graph identifier for the graph for which a snapshot is to be created.

status
Type: string

The status of the graph snapshot.

GraphSummary

Description

Summary details about a graph.

Members
arn
Required: Yes
Type: string

The ARN associated with the graph.

deletionProtection
Type: boolean

If true, deletion protection is enabled for the graph.

endpoint
Type: string

The graph endpoint.

id
Required: Yes
Type: string

The unique identifier of the graph.

kmsKeyIdentifier
Type: string

The ID of the KMS key used to encrypt and decrypt graph data.

name
Required: Yes
Type: string

The name of the graph.

provisionedMemory
Type: int

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

publicConnectivity
Type: boolean

If true, the graph has a public endpoint, otherwise not.

replicaCount
Type: int

The number of replicas for the graph.

status
Type: string

The status of the graph.

ImportOptions

Description

Options for how to perform an import.

Members
neptune
Type: NeptuneImportOptions structure

Options for importing data from a Neptune database.

ImportTaskDetails

Description

Contains details about an import task.

Members
dictionaryEntryCount
Required: Yes
Type: long (int|float)

The number of dictionary entries in the import task.

errorCount
Required: Yes
Type: int

The number of errors encountered so far.

errorDetails
Type: string

Details about the errors that have been encountered.

progressPercentage
Required: Yes
Type: int

The percentage progress so far.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which the import task started.

statementCount
Required: Yes
Type: long (int|float)

The number of statements in the import task.

status
Required: Yes
Type: string

Status of the import task.

timeElapsedSeconds
Required: Yes
Type: long (int|float)

Seconds elapsed since the import task started.

ImportTaskSummary

Description

Details about an import task.

Members
format
Type: string

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

graphId
Type: string

The unique identifier of the Neptune Analytics graph.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that will allow access to the data that is to be imported.

source
Required: Yes
Type: string

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

status
Required: Yes
Type: string

Status of the import task.

taskId
Required: Yes
Type: string

The unique identifier of the import task.

InternalServerException

Description

A failure occurred on the server.

Members
message
Required: Yes
Type: string

A message describing the problem.

NeptuneImportOptions

Description

Options for how to import Neptune data.

Members
preserveDefaultVertexLabels
Type: boolean

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.

preserveEdgeIds
Type: boolean

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.

s3ExportKmsKeyId
Required: Yes
Type: string

The KMS key to use to encrypt data in the S3 bucket where the graph data is exported

s3ExportPath
Required: Yes
Type: string

The path to an S3 bucket from which to import data.

NodeStructure

Description

Information about a node.

Members
count
Type: long (int|float)

The number of instances of this node.

distinctOutgoingEdgeLabels
Type: Array of strings

The outgoing edge labels associated with this node.

nodeProperties
Type: Array of strings

Properties associated with this node.

PrivateGraphEndpointSummary

Description

Details about a private graph endpoint.

Members
status
Required: Yes
Type: string

The status of the private graph endpoint.

subnetIds
Required: Yes
Type: Array of strings

The subnet IDs associated with the private graph endpoint.

vpcEndpointId
Type: string

The ID of the VPC endpoint.

vpcId
Required: Yes
Type: string

The ID of the VPC in which the private graph endpoint is located.

QuerySummary

Description

Details of the query listed.

Members
elapsed
Type: int

The running time of the query, in milliseconds.

id
Type: string

A string representation of the id of the query.

queryString
Type: string

The actual query text. The queryString may be truncated if the actual query string is too long.

state
Type: string

State of the query.

waited
Type: int

The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.

ResourceNotFoundException

Description

A specified resource could not be located.

Members
message
Required: Yes
Type: string

A message describing the problem.

ServiceQuotaExceededException

Description

A service quota was exceeded.

Members
message
Required: Yes
Type: string
quotaCode
Type: string

Service quota code of the resource for which quota was exceeded.

resourceId
Type: string

The identifier of the resource that exceeded quota.

resourceType
Type: string

The type of the resource that exceeded quota. Ex: Graph, Snapshot

serviceCode
Type: string

The service code that exceeded quota.

ThrottlingException

Description

The exception was interrupted by throttling.

Members
message
Required: Yes
Type: string

A message describing the problem.

UnprocessableException

Description

Request cannot be processed due to known reasons. Eg. partition full.

Members
message
Required: Yes
Type: string
reason
Required: Yes
Type: string

The reason for the unprocessable exception.

ValidationException

Description

A resource could not be validated.

Members
message
Required: Yes
Type: string

A message describing the problem.

reason
Type: string

The reason that the resource could not be validated.

VectorSearchConfiguration

Description

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

Members
dimension
Required: Yes
Type: int

The number of dimensions.