CancelExportTask

$result = $client->cancelExportTask([/* ... */]);
$promise = $client->cancelExportTaskAsync([/* ... */]);

Cancel the specified export task.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'destination' => '<string>',
    'format' => 'PARQUET|CSV',
    'graphId' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|SUCCEEDED|FAILED|CANCELLING|CANCELLED|DELETED',
    'statusReason' => '<string>',
    'taskId' => '<string>',
]

Result Details

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.

CancelImportTask

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

Deletes the specified import task.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

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

Result Details

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|PARQUET|NTRIPLES',
    'graphName' => '<string>', // REQUIRED
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>', // REQUIRED
            's3ExportPath' => '<string>', // REQUIRED
        ],
    ],
    'kmsKeyIdentifier' => '<string>',
    'maxProvisionedMemory' => <integer>,
    'minProvisionedMemory' => <integer>,
    'parquetType' => 'COLUMNAR',
    'publicConnectivity' => true || false,
    'replicaCount' => <integer>,
    'roleArn' => '<string>', // REQUIRED
    'source' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'vectorSearchConfiguration' => [
        'dimension' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

GetExportTask

$result = $client->getExportTask([/* ... */]);
$promise = $client->getExportTaskAsync([/* ... */]);

Retrieves a specified export task.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'destination' => '<string>',
    'exportFilter' => [
        'edgeFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'vertexFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'exportTaskDetails' => [
        'numEdgesWritten' => <integer>,
        'numVerticesWritten' => <integer>,
        'progressPercentage' => <integer>,
        'startTime' => <DateTime>,
        'timeElapsedSeconds' => <integer>,
    ],
    'format' => 'PARQUET|CSV',
    'graphId' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|SUCCEEDED|FAILED|CANCELLING|CANCELLED|DELETED',
    'statusReason' => '<string>',
    'taskId' => '<string>',
]

Result Details

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.

GetGraph

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

Gets information about a specified graph.

Parameter Syntax

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

Parameter Details

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[
    'attemptNumber' => <integer>,
    'format' => 'CSV|OPEN_CYPHER|PARQUET|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>,
    ],
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>',
    'source' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|ANALYZING_DATA|IMPORTING|REPROVISIONING|ROLLING_BACK|SUCCEEDED|FAILED|CANCELLING|CANCELLED|DELETED',
    'statusReason' => '<string>',
    'taskId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

ListExportTasks

$result = $client->listExportTasks([/* ... */]);
$promise = $client->listExportTasksAsync([/* ... */]);

Retrieves a list of export tasks.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'destination' => '<string>',
            'format' => 'PARQUET|CSV',
            'graphId' => '<string>',
            'kmsKeyIdentifier' => '<string>',
            'parquetType' => 'COLUMNAR',
            'roleArn' => '<string>',
            'status' => 'INITIALIZING|EXPORTING|SUCCEEDED|FAILED|CANCELLING|CANCELLED|DELETED',
            'statusReason' => '<string>',
            'taskId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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.

StartExportTask

$result = $client->startExportTask([/* ... */]);
$promise = $client->startExportTaskAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startExportTask([
    'destination' => '<string>', // REQUIRED
    'exportFilter' => [
        'edgeFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'vertexFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'format' => 'PARQUET|CSV', // REQUIRED
    'graphIdentifier' => '<string>', // REQUIRED
    'kmsKeyIdentifier' => '<string>', // REQUIRED
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'destination' => '<string>',
    'exportFilter' => [
        'edgeFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'vertexFilter' => [
            '<ExportFilterLabel>' => [
                'properties' => [
                    '<ExportFilterOutputPropertyName>' => [
                        'multiValueHandling' => 'TO_LIST|PICK_FIRST',
                        'outputType' => '<string>',
                        'sourcePropertyName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'format' => 'PARQUET|CSV',
    'graphId' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>',
    'status' => 'INITIALIZING|EXPORTING|SUCCEEDED|FAILED|CANCELLING|CANCELLED|DELETED',
    'statusReason' => '<string>',
    'taskId' => '<string>',
]

Result Details

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.

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|PARQUET|NTRIPLES',
    'graphIdentifier' => '<string>', // REQUIRED
    'importOptions' => [
        'neptune' => [
            'preserveDefaultVertexLabels' => true || false,
            'preserveEdgeIds' => true || false,
            's3ExportKmsKeyId' => '<string>', // REQUIRED
            's3ExportPath' => '<string>', // REQUIRED
        ],
    ],
    'parquetType' => 'COLUMNAR',
    'roleArn' => '<string>', // REQUIRED
    'source' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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.