AWS SDK for PHP 3.x

Client: Aws\Neptunedata\NeptunedataClient

Service ID: neptunedata

Version: 2023-08-01

This page describes the parameters and results for the operations of the Amazon NeptuneData (2023-08-01), and shows how to use the Aws\Neptunedata\NeptunedataClient object to call the described operations. This documentation is specific to the 2023-08-01 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 */).

CancelGremlinQuery ( array $params = [] ): Cancels a Gremlin query.
CancelLoaderJob ( array $params = [] ): Cancels a specified load job.
CancelMLDataProcessingJob ( array $params = [] ): Cancels a Neptune ML data processing job.
CancelMLModelTrainingJob ( array $params = [] ): Cancels a Neptune ML model training job.
CancelMLModelTransformJob ( array $params = [] ): Cancels a specified model transform job.
CancelOpenCypherQuery ( array $params = [] ): Cancels a specified openCypher query.
CreateMLEndpoint ( array $params = [] ): Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.
DeleteMLEndpoint ( array $params = [] ): Cancels the creation of a Neptune ML inference endpoint.
DeletePropertygraphStatistics ( array $params = [] ): Deletes statistics for Gremlin and openCypher (property graph) data.
DeleteSparqlStatistics ( array $params = [] ): Deletes SPARQL statistics When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.
ExecuteFastReset ( array $params = [] ): The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
ExecuteGremlinExplainQuery ( array $params = [] ): Executes a Gremlin Explain query.
ExecuteGremlinProfileQuery ( array $params = [] ): Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output.
ExecuteGremlinQuery ( array $params = [] ): This commands executes a Gremlin query.
ExecuteOpenCypherExplainQuery ( array $params = [] ): Executes an openCypher explain request.
ExecuteOpenCypherQuery ( array $params = [] ): Executes an openCypher query.
GetEngineStatus ( array $params = [] ): Retrieves the status of the graph database on the host.
GetGremlinQueryStatus ( array $params = [] ): Gets the status of a specified Gremlin query.
GetLoaderJobStatus ( array $params = [] ): Gets status information about a specified load job.
GetMLDataProcessingJob ( array $params = [] ): Retrieves information about a specified data processing job.
GetMLEndpoint ( array $params = [] ): Retrieves details about an inference endpoint.
GetMLModelTrainingJob ( array $params = [] ): Retrieves information about a Neptune ML model training job.
GetMLModelTransformJob ( array $params = [] ): Gets information about a specified model transform job.
GetOpenCypherQueryStatus ( array $params = [] ): Retrieves the status of a specified openCypher query.
GetPropertygraphStatistics ( array $params = [] ): Gets property graph statistics (Gremlin and openCypher).
GetPropertygraphStream ( array $params = [] ): Gets a stream for a property graph.
GetPropertygraphSummary ( array $params = [] ): Gets a graph summary for a property graph.
GetRDFGraphSummary ( array $params = [] ): Gets a graph summary for an RDF graph.
GetSparqlStatistics ( array $params = [] ): Gets RDF statistics (SPARQL).
GetSparqlStream ( array $params = [] ): Gets a stream for an RDF graph.
ListGremlinQueries ( array $params = [] ): Lists active Gremlin queries.
ListLoaderJobs ( array $params = [] ): Retrieves a list of the loadIds for all active loader jobs.
ListMLDataProcessingJobs ( array $params = [] ): Returns a list of Neptune ML data processing jobs.
ListMLEndpoints ( array $params = [] ): Lists existing inference endpoints.
ListMLModelTrainingJobs ( array $params = [] ): Lists Neptune ML model-training jobs.
ListMLModelTransformJobs ( array $params = [] ): Returns a list of model transform job IDs.
ListOpenCypherQueries ( array $params = [] ): Lists active openCypher queries.
ManagePropertygraphStatistics ( array $params = [] ): Manages the generation and use of property graph statistics.
ManageSparqlStatistics ( array $params = [] ): Manages the generation and use of RDF graph statistics.
StartLoaderJob ( array $params = [] ): Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.
StartMLDataProcessingJob ( array $params = [] ): Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
StartMLModelTrainingJob ( array $params = [] ): Creates a new Neptune ML model training job.
StartMLModelTransformJob ( array $params = [] ): Creates a new model transform job.

Operations

CancelGremlinQuery

$result = $client->cancelGremlinQuery([/* ... */]);
$promise = $client->cancelGremlinQueryAsync([/* ... */]);

Cancels a Gremlin query. See Gremlin query cancellation for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.

Parameter Syntax

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

Parameter Details

Members

queryId

Required: Yes
Type: string

The unique identifier that identifies the query to be canceled.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

The status of the cancelation

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

CancelLoaderJob

$result = $client->cancelLoaderJob([/* ... */]);
$promise = $client->cancelLoaderJobAsync([/* ... */]);

Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information.

Parameter Syntax

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

Parameter Details

Members

loadId

Required: Yes
Type: string

The ID of the load job to be deleted.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

The cancellation status.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
BulkLoadIdNotFoundException:
Raised when a specified bulk-load job ID cannot be found.
ClientTimeoutException:
Raised when a request timed out in the client.
LoadUrlAccessDeniedException:
Raised when access is denied to a specified load URL.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
InternalFailureException:
Raised when the processing of the request failed unexpectedly.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

CancelMLDataProcessingJob

$result = $client->cancelMLDataProcessingJob([/* ... */]);
$promise = $client->cancelMLDataProcessingJobAsync([/* ... */]);

Cancels a Neptune ML data processing job. See The dataprocessing command.

Parameter Syntax

$result = $client->cancelMLDataProcessingJob([
    'clean' => true || false,
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

clean

Type: boolean

If set to TRUE, this flag specifies that all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

id

Required: Yes
Type: string

The unique identifier of the data-processing job.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

The status of the cancellation request.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

CancelMLModelTrainingJob

$result = $client->cancelMLModelTrainingJob([/* ... */]);
$promise = $client->cancelMLModelTrainingJobAsync([/* ... */]);

Cancels a Neptune ML model training job. See Model training using the modeltraining command.

Parameter Syntax

$result = $client->cancelMLModelTrainingJob([
    'clean' => true || false,
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

clean

Type: boolean

If set to TRUE, this flag specifies that all Amazon S3 artifacts should be deleted when the job is stopped. The default is FALSE.

id

Required: Yes
Type: string

The unique identifier of the model-training job to be canceled.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

The status of the cancellation.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

CancelMLModelTransformJob

$result = $client->cancelMLModelTransformJob([/* ... */]);
$promise = $client->cancelMLModelTransformJobAsync([/* ... */]);

Cancels a specified model transform job. See Use a trained model to generate new model artifacts.

Parameter Syntax

$result = $client->cancelMLModelTransformJob([
    'clean' => true || false,
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

clean

Type: boolean

If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

id

Required: Yes
Type: string

The unique ID of the model transform job to be canceled.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

the status of the cancelation.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

CancelOpenCypherQuery

$result = $client->cancelOpenCypherQuery([/* ... */]);
$promise = $client->cancelOpenCypherQueryAsync([/* ... */]);

Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.

Parameter Syntax

$result = $client->cancelOpenCypherQuery([
    'queryId' => '<string>', // REQUIRED
    'silent' => true || false,
]);

Parameter Details

Members

queryId

Required: Yes
Type: string

The unique ID of the openCypher query to cancel.

silent

Type: boolean

If set to TRUE, causes the cancelation of the openCypher query to happen silently.

Result Syntax

[
    'payload' => true || false,
    'status' => '<string>',
]

Result Details

Members

payload

Type: boolean

The cancelation payload for the openCypher query.

status

Type: string

The cancellation status of the openCypher query.

Errors

InvalidNumericDataException:
Raised when invalid numerical data is encountered when servicing a request.
BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

CreateMLEndpoint

$result = $client->createMLEndpoint([/* ... */]);
$promise = $client->createMLEndpointAsync([/* ... */]);

Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference endpoints using the endpoints command.

Parameter Syntax

$result = $client->createMLEndpoint([
    'id' => '<string>',
    'instanceCount' => <integer>,
    'instanceType' => '<string>',
    'mlModelTrainingJobId' => '<string>',
    'mlModelTransformJobId' => '<string>',
    'modelName' => '<string>',
    'neptuneIamRoleArn' => '<string>',
    'update' => true || false,
    'volumeEncryptionKMSKey' => '<string>',
]);

Parameter Details

Members

id

Type: string

A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.

instanceCount

Type: int

The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1

instanceType

Type: string

The type of Neptune ML instance to use for online servicing. The default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.

mlModelTrainingJobId

Type: string

The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

mlModelTransformJobId

Type: string

The job Id of the completed model-transform job. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

modelName

Type: string

Model type for training. By default the Neptune ML model is automatically based on the modelType used in data processing, but you can specify a different model type here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge, transe, distmult, and rotate.

neptuneIamRoleArn

Type: string

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

update

Type: boolean

If set to true, update indicates that this is an update request. The default is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

volumeEncryptionKMSKey

Type: string

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Result Syntax

[
    'arn' => '<string>',
    'creationTimeInMillis' => <integer>,
    'id' => '<string>',
]

Result Details

Members

arn

Type: string

The ARN for the new inference endpoint.

creationTimeInMillis

Type: long (int|float)

The endpoint creation time, in milliseconds.

id

Type: string

The unique ID of the new inference endpoint.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

DeleteMLEndpoint

$result = $client->deleteMLEndpoint([/* ... */]);
$promise = $client->deleteMLEndpointAsync([/* ... */]);

Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.

Parameter Syntax

$result = $client->deleteMLEndpoint([
    'clean' => true || false,
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

clean

Type: boolean

If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

id

Required: Yes
Type: string

The unique identifier of the inference endpoint.

neptuneIamRoleArn

Type: string

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Type: string

The status of the cancellation.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

DeletePropertygraphStatistics

$result = $client->deletePropertygraphStatistics([/* ... */]);
$promise = $client->deletePropertygraphStatisticsAsync([/* ... */]);

Deletes statistics for Gremlin and openCypher (property graph) data.

Parameter Syntax

$result = $client->deletePropertygraphStatistics([
]);

Parameter Details

Members

Result Syntax

[
    'payload' => [
        'active' => true || false,
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
    'statusCode' => <integer>,
]

Result Details

Members

payload

Type: DeleteStatisticsValueMap structure

The deletion payload.

status

Type: string

The cancel status.

statusCode

Type: int

The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

DeleteSparqlStatistics

$result = $client->deleteSparqlStatistics([/* ... */]);
$promise = $client->deleteSparqlStatisticsAsync([/* ... */]);

Deletes SPARQL statistics

Parameter Syntax

$result = $client->deleteSparqlStatistics([
]);

Parameter Details

Members

Result Syntax

[
    'payload' => [
        'active' => true || false,
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
    'statusCode' => <integer>,
]

Result Details

Members

payload

Type: DeleteStatisticsValueMap structure

The deletion payload.

status

Type: string

The cancel status.

statusCode

Type: int

The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteFastReset

$result = $client->executeFastReset([/* ... */]);
$promise = $client->executeFastResetAsync([/* ... */]);

The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.

Neptune fast reset is a two-step process. First you call ExecuteFastReset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon Neptune DB cluster using the fast reset API.

Parameter Syntax

$result = $client->executeFastReset([
    'action' => 'initiateDatabaseReset|performDatabaseReset', // REQUIRED
    'token' => '<string>',
]);

Parameter Details

Members

action

Required: Yes
Type: string

The fast reset action. One of the following values:

initiateDatabaseReset – This action generates a unique token needed to actually perform the fast reset.
performDatabaseReset – This action uses the token generated by the initiateDatabaseReset action to actually perform the fast reset.

token

Type: string

The fast-reset token to initiate the reset.

Result Syntax

[
    'payload' => [
        'token' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Type: FastResetToken structure

The payload is only returned by the initiateDatabaseReset action, and contains the unique token to use with the performDatabaseReset action to make the reset occur.

status

Required: Yes
Type: string

The status is only returned for the performDatabaseReset action, and indicates whether or not the fast reset rquest is accepted.

Errors

InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
ServerShutdownException:
Raised when the server shuts down while processing a request.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MethodNotAllowedException:
Raised when the HTTP method used by a request is not supported by the endpoint being used.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteGremlinExplainQuery

$result = $client->executeGremlinExplainQuery([/* ... */]);
$promise = $client->executeGremlinExplainQueryAsync([/* ... */]);

Executes a Gremlin Explain query.

Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query.

The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, 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:

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

Parameter Syntax

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

Parameter Details

Members

gremlinQuery

Required: Yes
Type: string

The Gremlin explain query string.

Result Syntax

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

Result Details

Members

output

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A text blob containing the Gremlin explain result, as described in Tuning Gremlin queries.

Errors

QueryTooLargeException:
Raised when the body of a query is too large.
BadRequestException:
Raised when a request is submitted that cannot be processed.
QueryLimitExceededException:
Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.
InvalidParameterException:
Raised when a parameter value is not valid.
QueryLimitException:
Raised when the size of a query exceeds the system limit.
ClientTimeoutException:
Raised when a request timed out in the client.
CancelledByUserException:
Raised when a user cancelled a request.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MalformedQueryException:
Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteGremlinProfileQuery

$result = $client->executeGremlinProfileQuery([/* ... */]);
$promise = $client->executeGremlinProfileQueryAsync([/* ... */]);

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.

Parameter Syntax

$result = $client->executeGremlinProfileQuery([
    'chop' => <integer>,
    'gremlinQuery' => '<string>', // REQUIRED
    'indexOps' => true || false,
    'results' => true || false,
    'serializer' => '<string>',
]);

Parameter Details

Members

chop

Type: int

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

gremlinQuery

Required: Yes
Type: string

The Gremlin query string to profile.

indexOps

Type: boolean

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

results

Type: boolean

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

serializer

Type: string

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

Result Syntax

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

Result Details

Members

output

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A text blob containing the Gremlin Profile result. See Gremlin profile API in Neptune for details.

Errors

QueryTooLargeException:
Raised when the body of a query is too large.
BadRequestException:
Raised when a request is submitted that cannot be processed.
QueryLimitExceededException:
Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.
InvalidParameterException:
Raised when a parameter value is not valid.
QueryLimitException:
Raised when the size of a query exceeds the system limit.
ClientTimeoutException:
Raised when a request timed out in the client.
CancelledByUserException:
Raised when a user cancelled a request.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MalformedQueryException:
Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteGremlinQuery

$result = $client->executeGremlinQuery([/* ... */]);
$promise = $client->executeGremlinQueryAsync([/* ... */]);

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions in that cluster, depending on the query:

Parameter Syntax

$result = $client->executeGremlinQuery([
    'gremlinQuery' => '<string>', // REQUIRED
    'serializer' => '<string>',
]);

Parameter Details

Members

gremlinQuery

Required: Yes
Type: string

Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the Tinkerpop client section to determine which Gremlin releases your engine version supports).

serializer

Type: string

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

Result Syntax

[
    'meta' => [
    ],
    'requestId' => '<string>',
    'result' => [
    ],
    'status' => [
        'attributes' => [
        ],
        'code' => <integer>,
        'message' => '<string>',
    ],
]

Result Details

Members

meta

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Metadata about the Gremlin query.

requestId

Type: string

The unique identifier of the Gremlin query.

result

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The Gremlin query output from the server.

status

Type: GremlinQueryStatusAttributes structure

The status of the Gremlin query.

Errors

QueryTooLargeException:
Raised when the body of a query is too large.
BadRequestException:
Raised when a request is submitted that cannot be processed.
QueryLimitExceededException:
Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.
InvalidParameterException:
Raised when a parameter value is not valid.
QueryLimitException:
Raised when the size of a query exceeds the system limit.
ClientTimeoutException:
Raised when a request timed out in the client.
CancelledByUserException:
Raised when a user cancelled a request.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MalformedQueryException:
Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteOpenCypherExplainQuery

$result = $client->executeOpenCypherExplainQuery([/* ... */]);
$promise = $client->executeOpenCypherExplainQueryAsync([/* ... */]);

Executes an openCypher explain request. See The openCypher explain feature for more information.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

Parameter Syntax

$result = $client->executeOpenCypherExplainQuery([
    'explainMode' => 'static|dynamic|details', // REQUIRED
    'openCypherQuery' => '<string>', // REQUIRED
    'parameters' => '<string>',
]);

Parameter Details

Members

explainMode

Required: Yes
Type: string

The openCypher explain mode. Can be one of: static, dynamic, or details.

openCypherQuery

Required: Yes
Type: string

The openCypher query string.

parameters

Type: string

The openCypher query parameters.

Result Syntax

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

Result Details

Members

results

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

A text blob containing the openCypher explain results.

Errors

QueryTooLargeException:
Raised when the body of a query is too large.
InvalidNumericDataException:
Raised when invalid numerical data is encountered when servicing a request.
BadRequestException:
Raised when a request is submitted that cannot be processed.
QueryLimitExceededException:
Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.
InvalidParameterException:
Raised when a parameter value is not valid.
QueryLimitException:
Raised when the size of a query exceeds the system limit.
ClientTimeoutException:
Raised when a request timed out in the client.
CancelledByUserException:
Raised when a user cancelled a request.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MalformedQueryException:
Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ExecuteOpenCypherQuery

$result = $client->executeOpenCypherQuery([/* ... */]);
$promise = $client->executeOpenCypherQueryAsync([/* ... */]);

Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information.

Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs.

The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the openCypher project under an Apache 2 open-source license.

Note that when invoking this operation in a Neptune cluster that has IAM authentication enabled, 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:

Note also that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

Parameter Syntax

$result = $client->executeOpenCypherQuery([
    'openCypherQuery' => '<string>', // REQUIRED
    'parameters' => '<string>',
]);

Parameter Details

Members

openCypherQuery

Required: Yes
Type: string

The openCypher query string to be executed.

parameters

Type: string

The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

Result Syntax

[
    'results' => [
    ],
]

Result Details

Members

results

Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The openCypherquery results.

Errors

QueryTooLargeException:
Raised when the body of a query is too large.
InvalidNumericDataException:
Raised when invalid numerical data is encountered when servicing a request.
BadRequestException:
Raised when a request is submitted that cannot be processed.
QueryLimitExceededException:
Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.
InvalidParameterException:
Raised when a parameter value is not valid.
QueryLimitException:
Raised when the size of a query exceeds the system limit.
ClientTimeoutException:
Raised when a request timed out in the client.
CancelledByUserException:
Raised when a user cancelled a request.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
MalformedQueryException:
Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.
ParsingException:
Raised when a parsing issue is encountered.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

GetEngineStatus

$result = $client->getEngineStatus([/* ... */]);
$promise = $client->getEngineStatusAsync([/* ... */]);

Retrieves the status of the graph database on the host.

Parameter Syntax

$result = $client->getEngineStatus([
]);

Parameter Details

Members

Result Syntax

[
    'dbEngineVersion' => '<string>',
    'dfeQueryEngine' => '<string>',
    'features' => [
        '<String>' => [
        ],
        // ...
    ],
    'gremlin' => [
        'version' => '<string>',
    ],
    'labMode' => ['<string>', ...],
    'opencypher' => [
        'version' => '<string>',
    ],
    'role' => '<string>',
    'rollingBackTrxCount' => <integer>,
    'rollingBackTrxEarliestStartTime' => '<string>',
    'settings' => ['<string>', ...],
    'sparql' => [
        'version' => '<string>',
    ],
    'startTime' => '<string>',
    'status' => '<string>',
]

Result Details

Members

dbEngineVersion

Type: string

Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by Patch-.

dfeQueryEngine

Type: string

Set to enabled if the DFE engine is fully enabled, or to viaQueryHint (the default) if the DFE engine is only used with queries that have the useDFE query hint set to true.

features

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

Contains status information about the features enabled on your DB cluster.

gremlin

Type: QueryLanguageVersion structure

Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.

labMode

Type: Associative array of custom strings keys (String) to strings

Contains Lab Mode settings being used by the engine.

opencypher

Type: QueryLanguageVersion structure

Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.

role

Type: string

Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.

rollingBackTrxCount

Type: int

If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn't appear at all.

rollingBackTrxEarliestStartTime

Type: string

Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn't appear at all.

settings

Type: Associative array of custom strings keys (String) to strings

Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (clusterQueryTimeoutInMs).

sparql

Type: QueryLanguageVersion structure

Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.

startTime

Type: string

Set to the UTC time at which the current server process started.

status

Type: string

Set to healthy if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to recovery.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
InternalFailureException:
Raised when the processing of the request failed unexpectedly.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetGremlinQueryStatus

$result = $client->getGremlinQueryStatus([/* ... */]);
$promise = $client->getGremlinQueryStatusAsync([/* ... */]);

Gets the status of a specified Gremlin query.

Parameter Syntax

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

Parameter Details

Members

queryId

Required: Yes
Type: string

The unique identifier that identifies the Gremlin query.

Result Syntax

[
    'queryEvalStats' => [
        'cancelled' => true || false,
        'elapsed' => <integer>,
        'subqueries' => [
        ],
        'waited' => <integer>,
    ],
    'queryId' => '<string>',
    'queryString' => '<string>',
]

Result Details

Members

queryEvalStats

Type: QueryEvalStats structure

The evaluation status of the Gremlin query.

queryId

Type: string

The ID of the query for which status is being returned.

queryString

Type: string

The Gremlin query string.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

GetLoaderJobStatus

$result = $client->getLoaderJobStatus([/* ... */]);
$promise = $client->getLoaderJobStatusAsync([/* ... */]);

Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job.

See Neptune Loader Get-Status API for more information.

Parameter Syntax

$result = $client->getLoaderJobStatus([
    'details' => true || false,
    'errors' => true || false,
    'errorsPerPage' => <integer>,
    'loadId' => '<string>', // REQUIRED
    'page' => <integer>,
]);

Parameter Details

Members

details

Type: boolean

Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).

errors

Type: boolean

Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE).

The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.

errorsPerPage

Type: int

The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.

loadId

Required: Yes
Type: string

The load ID of the load job to get the status of.

page

Type: int

The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

Result Syntax

[
    'payload' => [
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Status information about the load job, in a layout that could look like this:

status

Required: Yes
Type: string

The HTTP response code for the request.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
BulkLoadIdNotFoundException:
Raised when a specified bulk-load job ID cannot be found.
ClientTimeoutException:
Raised when a request timed out in the client.
LoadUrlAccessDeniedException:
Raised when access is denied to a specified load URL.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
InternalFailureException:
Raised when the processing of the request failed unexpectedly.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

GetMLDataProcessingJob

$result = $client->getMLDataProcessingJob([/* ... */]);
$promise = $client->getMLDataProcessingJobAsync([/* ... */]);

Retrieves information about a specified data processing job. See The dataprocessing command.

Parameter Syntax

$result = $client->getMLDataProcessingJob([
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

id

Required: Yes
Type: string

The unique identifier of the data-processing job to be retrieved.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'id' => '<string>',
    'processingJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

id

Type: string

The unique identifier of this data-processing job.

processingJob

Type: MlResourceDefinition structure

Definition of the data processing job.

status

Type: string

Status of the data processing job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetMLEndpoint

$result = $client->getMLEndpoint([/* ... */]);
$promise = $client->getMLEndpointAsync([/* ... */]);

Retrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command.

Parameter Syntax

$result = $client->getMLEndpoint([
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

id

Required: Yes
Type: string

The unique identifier of the inference endpoint.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'endpoint' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'endpointConfig' => [
        'arn' => '<string>',
        'name' => '<string>',
    ],
    'id' => '<string>',
    'status' => '<string>',
]

Result Details

Members

endpoint

Type: MlResourceDefinition structure

The endpoint definition.

endpointConfig

Type: MlConfigDefinition structure

The endpoint configuration

id

Type: string

The unique identifier of the inference endpoint.

status

Type: string

The status of the inference endpoint.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetMLModelTrainingJob

$result = $client->getMLModelTrainingJob([/* ... */]);
$promise = $client->getMLModelTrainingJobAsync([/* ... */]);

Retrieves information about a Neptune ML model training job. See Model training using the modeltraining command.

Parameter Syntax

$result = $client->getMLModelTrainingJob([
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

id

Required: Yes
Type: string

The unique identifier of the model-training job to retrieve.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'hpoJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'id' => '<string>',
    'mlModels' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'modelTransformJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'processingJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

hpoJob

Type: MlResourceDefinition structure

The HPO job.

id

Type: string

The unique identifier of this model-training job.

mlModels

Type: Array of MlConfigDefinition structures

A list of the configurations of the ML models being used.

modelTransformJob

Type: MlResourceDefinition structure

The model transform job.

processingJob

Type: MlResourceDefinition structure

The data processing job.

status

Type: string

The status of the model training job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetMLModelTransformJob

$result = $client->getMLModelTransformJob([/* ... */]);
$promise = $client->getMLModelTransformJobAsync([/* ... */]);

Gets information about a specified model transform job. See Use a trained model to generate new model artifacts.

Parameter Syntax

$result = $client->getMLModelTransformJob([
    'id' => '<string>', // REQUIRED
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

id

Required: Yes
Type: string

The unique identifier of the model-transform job to be reetrieved.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

[
    'baseProcessingJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'id' => '<string>',
    'models' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'remoteModelTransformJob' => [
        'arn' => '<string>',
        'cloudwatchLogUrl' => '<string>',
        'failureReason' => '<string>',
        'name' => '<string>',
        'outputLocation' => '<string>',
        'status' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

baseProcessingJob

Type: MlResourceDefinition structure

The base data processing job.

id

Type: string

The unique identifier of the model-transform job to be retrieved.

models

Type: Array of MlConfigDefinition structures

A list of the configuration information for the models being used.

remoteModelTransformJob

Type: MlResourceDefinition structure

The remote model transform job.

status

Type: string

The status of the model-transform job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetOpenCypherQueryStatus

$result = $client->getOpenCypherQueryStatus([/* ... */]);
$promise = $client->getOpenCypherQueryStatusAsync([/* ... */]);

Retrieves the status of a specified openCypher query.

Parameter Syntax

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

Parameter Details

Members

queryId

Required: Yes
Type: string

The unique ID of the openCypher query for which to retrieve the query status.

Result Syntax

[
    'queryEvalStats' => [
        'cancelled' => true || false,
        'elapsed' => <integer>,
        'subqueries' => [
        ],
        'waited' => <integer>,
    ],
    'queryId' => '<string>',
    'queryString' => '<string>',
]

Result Details

Members

queryEvalStats

Type: QueryEvalStats structure

The openCypher query evaluation status.

queryId

Type: string

The unique ID of the query for which status is being returned.

queryString

Type: string

The openCypher query string.

Errors

InvalidNumericDataException:
Raised when invalid numerical data is encountered when servicing a request.
BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

GetPropertygraphStatistics

$result = $client->getPropertygraphStatistics([/* ... */]);
$promise = $client->getPropertygraphStatisticsAsync([/* ... */]);

Gets property graph statistics (Gremlin and openCypher).

Parameter Syntax

$result = $client->getPropertygraphStatistics([
]);

Parameter Details

Members

Result Syntax

[
    'payload' => [
        'active' => true || false,
        'autoCompute' => true || false,
        'date' => <DateTime>,
        'note' => '<string>',
        'signatureInfo' => [
            'instanceCount' => <integer>,
            'predicateCount' => <integer>,
            'signatureCount' => <integer>,
        ],
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Required: Yes
Type: Statistics structure

Statistics for property-graph data.

status

Required: Yes
Type: string

The HTTP return code of the request. If the request succeeded, the code is 200. See Common error codes for DFE statistics request for a list of common errors.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

GetPropertygraphStream

$result = $client->getPropertygraphStream([/* ... */]);
$promise = $client->getPropertygraphStreamAsync([/* ... */]);

Gets a stream for a property graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetPropertygraphStream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

Note that you can restrict property-graph queries using the following IAM context keys:

See Condition keys available in Neptune IAM data-access policy statements).

Parameter Syntax

$result = $client->getPropertygraphStream([
    'commitNum' => <integer>,
    'encoding' => 'gzip',
    'iteratorType' => 'AT_SEQUENCE_NUMBER|AFTER_SEQUENCE_NUMBER|TRIM_HORIZON|LATEST',
    'limit' => <integer>,
    'opNum' => <integer>,
]);

Parameter Details

Members

commitNum

Type: long (int|float)

The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

encoding

Type: string

If set to TRUE, Neptune compresses the response using gzip encoding.

iteratorType

Type: string

Can be one of:

AT_SEQUENCE_NUMBER – Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.
AFTER_SEQUENCE_NUMBER – Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.
TRIM_HORIZON – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.
LATEST – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

limit

Type: long (int|float)

Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

The range for limit is 1 to 100,000, with a default of 10.

opNum

Type: long (int|float)

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

Result Syntax

[
    'format' => '<string>',
    'lastEventId' => ['<string>', ...],
    'lastTrxTimestampInMillis' => <integer>,
    'records' => [
        [
            'commitTimestampInMillis' => <integer>,
            'data' => [
                'from' => '<string>',
                'id' => '<string>',
                'key' => '<string>',
                'to' => '<string>',
                'type' => '<string>',
                'value' => [
                ],
            ],
            'eventId' => ['<string>', ...],
            'isLastOp' => true || false,
            'op' => '<string>',
        ],
        // ...
    ],
    'totalRecords' => <integer>,
]

Result Details

Members

format

Required: Yes
Type: string

Serialization format for the change records being returned. Currently, the only supported value is PG_JSON.

lastEventId

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

Sequence identifier of the last change in the stream response.

An event ID is composed of two fields: a commitNum, which identifies a transaction that changed the graph, and an opNum, which identifies a specific operation within that transaction:

lastTrxTimestampInMillis

Required: Yes
Type: long (int|float)

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

records

Required: Yes
Type: Array of PropertygraphRecord structures

An array of serialized change-log stream records included in the response.

totalRecords

Required: Yes
Type: int

The total number of records in the response.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
ExpiredStreamException:
Raised when a request attempts to access an stream that has expired.
InvalidParameterException:
Raised when a parameter value is not valid.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
StreamRecordsNotFoundException:
Raised when stream records requested by a query cannot be found.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ThrottlingException:
Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

GetPropertygraphSummary

$result = $client->getPropertygraphSummary([/* ... */]);
$promise = $client->getPropertygraphSummaryAsync([/* ... */]);

Gets a graph summary for a property graph.

Parameter Syntax

$result = $client->getPropertygraphSummary([
    'mode' => 'basic|detailed',
]);

Parameter Details

Members

mode

Type: string

Mode can take one of two values: BASIC (the default), and DETAILED.

Result Syntax

[
    'payload' => [
        '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>',
    ],
    'statusCode' => <integer>,
]

Result Details

Members

payload

Type: PropertygraphSummaryValueMap structure

Payload containing the property graph summary response.

statusCode

Type: int

The HTTP return code of the request. If the request succeeded, the code is 200.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

GetRDFGraphSummary

$result = $client->getRDFGraphSummary([/* ... */]);
$promise = $client->getRDFGraphSummaryAsync([/* ... */]);

Gets a graph summary for an RDF graph.

Parameter Syntax

$result = $client->getRDFGraphSummary([
    'mode' => 'basic|detailed',
]);

Parameter Details

Members

mode

Type: string

Mode can take one of two values: BASIC (the default), and DETAILED.

Result Syntax

[
    'payload' => [
        'graphSummary' => [
            'classes' => ['<string>', ...],
            'numClasses' => <integer>,
            'numDistinctPredicates' => <integer>,
            'numDistinctSubjects' => <integer>,
            'numQuads' => <integer>,
            'predicates' => [
                [<integer>, ...],
                // ...
            ],
            'subjectStructures' => [
                [
                    'count' => <integer>,
                    'predicates' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'lastStatisticsComputationTime' => <DateTime>,
        'version' => '<string>',
    ],
    'statusCode' => <integer>,
]

Result Details

Members

payload

Type: RDFGraphSummaryValueMap structure

Payload for an RDF graph summary response

statusCode

Type: int

The HTTP return code of the request. If the request succeeded, the code is 200.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

GetSparqlStatistics

$result = $client->getSparqlStatistics([/* ... */]);
$promise = $client->getSparqlStatisticsAsync([/* ... */]);

Gets RDF statistics (SPARQL).

Parameter Syntax

$result = $client->getSparqlStatistics([
]);

Parameter Details

Members

Result Syntax

[
    'payload' => [
        'active' => true || false,
        'autoCompute' => true || false,
        'date' => <DateTime>,
        'note' => '<string>',
        'signatureInfo' => [
            'instanceCount' => <integer>,
            'predicateCount' => <integer>,
            'signatureCount' => <integer>,
        ],
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Required: Yes
Type: Statistics structure

Statistics for RDF data.

status

Required: Yes
Type: string

The HTTP return code of the request. If the request succeeded, the code is 200. See Common error codes for DFE statistics request for a list of common errors.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

GetSparqlStream

$result = $client->getSparqlStream([/* ... */]);
$promise = $client->getSparqlStreamAsync([/* ... */]);

Gets a stream for an RDF graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetSparqlStream lets you collect these change-log entries for an RDF graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).

Parameter Syntax

$result = $client->getSparqlStream([
    'commitNum' => <integer>,
    'encoding' => 'gzip',
    'iteratorType' => 'AT_SEQUENCE_NUMBER|AFTER_SEQUENCE_NUMBER|TRIM_HORIZON|LATEST',
    'limit' => <integer>,
    'opNum' => <integer>,
]);

Parameter Details

Members

commitNum

Type: long (int|float)

encoding

Type: string

If set to TRUE, Neptune compresses the response using gzip encoding.

iteratorType

Type: string

Can be one of:

AT_SEQUENCE_NUMBER – Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.
AFTER_SEQUENCE_NUMBER – Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.
TRIM_HORIZON – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.
LATEST – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

limit

Type: long (int|float)

The range for limit is 1 to 100,000, with a default of 10.

opNum

Type: long (int|float)

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

Result Syntax

[
    'format' => '<string>',
    'lastEventId' => ['<string>', ...],
    'lastTrxTimestampInMillis' => <integer>,
    'records' => [
        [
            'commitTimestampInMillis' => <integer>,
            'data' => [
                'stmt' => '<string>',
            ],
            'eventId' => ['<string>', ...],
            'isLastOp' => true || false,
            'op' => '<string>',
        ],
        // ...
    ],
    'totalRecords' => <integer>,
]

Result Details

Members

format

Required: Yes
Type: string

Serialization format for the change records being returned. Currently, the only supported value is NQUADS.

lastEventId

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

Sequence identifier of the last change in the stream response.

An event ID is composed of two fields: a commitNum, which identifies a transaction that changed the graph, and an opNum, which identifies a specific operation within that transaction:

lastTrxTimestampInMillis

Required: Yes
Type: long (int|float)

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

records

Required: Yes
Type: Array of SparqlRecord structures

An array of serialized change-log stream records included in the response.

totalRecords

Required: Yes
Type: int

The total number of records in the response.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
ExpiredStreamException:
Raised when a request attempts to access an stream that has expired.
InvalidParameterException:
Raised when a parameter value is not valid.
MemoryLimitExceededException:
Raised when a request fails because of insufficient memory resources. The request can be retried.
StreamRecordsNotFoundException:
Raised when stream records requested by a query cannot be found.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ThrottlingException:
Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListGremlinQueries

$result = $client->listGremlinQueries([/* ... */]);
$promise = $client->listGremlinQueriesAsync([/* ... */]);

Lists active Gremlin queries. See Gremlin query status API for details about the output.

Parameter Syntax

$result = $client->listGremlinQueries([
    'includeWaiting' => true || false,
]);

Parameter Details

Members

includeWaiting

Type: boolean

If set to TRUE, the list returned includes waiting queries. The default is FALSE;

Result Syntax

[
    'acceptedQueryCount' => <integer>,
    'queries' => [
        [
            'queryEvalStats' => [
                'cancelled' => true || false,
                'elapsed' => <integer>,
                'subqueries' => [
                ],
                'waited' => <integer>,
            ],
            'queryId' => '<string>',
            'queryString' => '<string>',
        ],
        // ...
    ],
    'runningQueryCount' => <integer>,
]

Result Details

Members

acceptedQueryCount

Type: int

The number of queries that have been accepted but not yet completed, including queries in the queue.

queries

Type: Array of GremlinQueryStatus structures

A list of the current queries.

runningQueryCount

Type: int

The number of Gremlin queries currently running.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ListLoaderJobs

$result = $client->listLoaderJobs([/* ... */]);
$promise = $client->listLoaderJobsAsync([/* ... */]);

Retrieves a list of the loadIds for all active loader jobs.

Parameter Syntax

$result = $client->listLoaderJobs([
    'includeQueuedLoads' => true || false,
    'limit' => <integer>,
]);

Parameter Details

Members

includeQueuedLoads

Type: boolean

An optional parameter that can be used to exclude the load IDs of queued load requests when requesting a list of load IDs by setting the parameter to FALSE. The default value is TRUE.

limit

Type: int

The number of load IDs to list. Must be a positive integer greater than zero and not more than 100 (which is the default).

Result Syntax

[
    'payload' => [
        'loadIds' => ['<string>', ...],
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Required: Yes
Type: LoaderIdResult structure

The requested list of job IDs.

status

Required: Yes
Type: string

Returns the status of the job list request.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
BulkLoadIdNotFoundException:
Raised when a specified bulk-load job ID cannot be found.
InternalFailureException:
Raised when the processing of the request failed unexpectedly.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
LoadUrlAccessDeniedException:
Raised when access is denied to a specified load URL.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListMLDataProcessingJobs

$result = $client->listMLDataProcessingJobs([/* ... */]);
$promise = $client->listMLDataProcessingJobsAsync([/* ... */]);

Returns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command.

Parameter Syntax

$result = $client->listMLDataProcessingJobs([
    'maxItems' => <integer>,
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

maxItems

Type: int

The maximum number of items to return (from 1 to 1024; the default is 10).

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

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

Result Details

Members

ids

Type: Array of strings

A page listing data processing job IDs.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListMLEndpoints

$result = $client->listMLEndpoints([/* ... */]);
$promise = $client->listMLEndpointsAsync([/* ... */]);

Lists existing inference endpoints. See Managing inference endpoints using the endpoints command.

Parameter Syntax

$result = $client->listMLEndpoints([
    'maxItems' => <integer>,
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

maxItems

Type: int

The maximum number of items to return (from 1 to 1024; the default is 10.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

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

Result Details

Members

ids

Type: Array of strings

A page from the list of inference endpoint IDs.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListMLModelTrainingJobs

$result = $client->listMLModelTrainingJobs([/* ... */]);
$promise = $client->listMLModelTrainingJobsAsync([/* ... */]);

Lists Neptune ML model-training jobs. See Model training using the modeltraining command.

Parameter Syntax

$result = $client->listMLModelTrainingJobs([
    'maxItems' => <integer>,
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

maxItems

Type: int

The maximum number of items to return (from 1 to 1024; the default is 10).

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

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

Result Details

Members

ids

Type: Array of strings

A page of the list of model training job IDs.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListMLModelTransformJobs

$result = $client->listMLModelTransformJobs([/* ... */]);
$promise = $client->listMLModelTransformJobsAsync([/* ... */]);

Returns a list of model transform job IDs. See Use a trained model to generate new model artifacts.

Parameter Syntax

$result = $client->listMLModelTransformJobs([
    'maxItems' => <integer>,
    'neptuneIamRoleArn' => '<string>',
]);

Parameter Details

Members

maxItems

Type: int

The maximum number of items to return (from 1 to 1024; the default is 10).

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Result Syntax

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

Result Details

Members

ids

Type: Array of strings

A page from the list of model transform IDs.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
BadRequestException:
Raised when a request is submitted that cannot be processed.
MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

ListOpenCypherQueries

$result = $client->listOpenCypherQueries([/* ... */]);
$promise = $client->listOpenCypherQueriesAsync([/* ... */]);

Lists active openCypher queries. See Neptune openCypher status endpoint for more information.

Parameter Syntax

$result = $client->listOpenCypherQueries([
    'includeWaiting' => true || false,
]);

Parameter Details

Members

includeWaiting

Type: boolean

When set to TRUE and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.

Result Syntax

[
    'acceptedQueryCount' => <integer>,
    'queries' => [
        [
            'queryEvalStats' => [
                'cancelled' => true || false,
                'elapsed' => <integer>,
                'subqueries' => [
                ],
                'waited' => <integer>,
            ],
            'queryId' => '<string>',
            'queryString' => '<string>',
        ],
        // ...
    ],
    'runningQueryCount' => <integer>,
]

Result Details

Members

acceptedQueryCount

Type: int

The number of queries that have been accepted but not yet completed, including queries in the queue.

queries

Type: Array of GremlinQueryStatus structures

A list of current openCypher queries.

runningQueryCount

Type: int

The number of currently running openCypher queries.

Errors

InvalidNumericDataException:
Raised when invalid numerical data is encountered when servicing a request.
BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
FailureByQueryException:
Raised when a request fails.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ParsingException:
Raised when a parsing issue is encountered.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
TimeLimitExceededException:
Raised when the an operation exceeds the time limit allowed for it.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
ConcurrentModificationException:
Raised when a request attempts to modify data that is concurrently being modified by another process.
MissingParameterException:
Raised when a required parameter is missing.

ManagePropertygraphStatistics

$result = $client->managePropertygraphStatistics([/* ... */]);
$promise = $client->managePropertygraphStatisticsAsync([/* ... */]);

Manages the generation and use of property graph statistics.

Parameter Syntax

$result = $client->managePropertygraphStatistics([
    'mode' => 'disableAutoCompute|enableAutoCompute|refresh',
]);

Parameter Details

Members

mode

Type: string

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

Result Syntax

[
    'payload' => [
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Type: RefreshStatisticsIdMap structure

This is only returned for refresh mode.

status

Required: Yes
Type: string

The HTTP return code of the request. If the request succeeded, the code is 200.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

ManageSparqlStatistics

$result = $client->manageSparqlStatistics([/* ... */]);
$promise = $client->manageSparqlStatisticsAsync([/* ... */]);

Manages the generation and use of RDF graph statistics.

Parameter Syntax

$result = $client->manageSparqlStatistics([
    'mode' => 'disableAutoCompute|enableAutoCompute|refresh',
]);

Parameter Details

Members

mode

Type: string

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

Result Syntax

[
    'payload' => [
        'statisticsId' => '<string>',
    ],
    'status' => '<string>',
]

Result Details

Members

payload

Type: RefreshStatisticsIdMap structure

This is only returned for refresh mode.

status

Required: Yes
Type: string

The HTTP return code of the request. If the request succeeded, the code is 200.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.
InvalidParameterException:
Raised when a parameter value is not valid.
StatisticsNotAvailableException:
Raised when statistics needed to satisfy a request are not available.
ClientTimeoutException:
Raised when a request timed out in the client.
AccessDeniedException:
Raised in case of an authentication or authorization failure.
IllegalArgumentException:
Raised when an argument in a request is not supported.
TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.
PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException:
Raised when a request attempts to write to a read-only resource.
ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.
InvalidArgumentException:
Raised when an argument in a request has an invalid value.
MissingParameterException:
Raised when a required parameter is missing.

StartLoaderJob

$result = $client->startLoaderJob([/* ... */]);
$promise = $client->startLoaderJobAsync([/* ... */]);

Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data.

Parameter Syntax

$result = $client->startLoaderJob([
    'dependencies' => ['<string>', ...],
    'failOnError' => true || false,
    'format' => 'csv|opencypher|ntriples|nquads|rdfxml|turtle', // REQUIRED
    'iamRoleArn' => '<string>', // REQUIRED
    'mode' => 'RESUME|NEW|AUTO',
    'parallelism' => 'LOW|MEDIUM|HIGH|OVERSUBSCRIBE',
    'parserConfiguration' => ['<string>', ...],
    'queueRequest' => true || false,
    's3BucketRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|ca-central-1|sa-east-1|eu-north-1|eu-west-1|eu-west-2|eu-west-3|eu-central-1|me-south-1|af-south-1|ap-east-1|ap-northeast-1|ap-northeast-2|ap-southeast-1|ap-southeast-2|ap-south-1|cn-north-1|cn-northwest-1|us-gov-west-1|us-gov-east-1', // REQUIRED
    'source' => '<string>', // REQUIRED
    'updateSingleCardinalityProperties' => true || false,
    'userProvidedEdgeIds' => true || false,
]);

Parameter Details

Members

dependencies

Type: Array of strings

This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.

Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.

For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:

Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
Submit load-job-C with the load-ids of the two jobs in its dependencies field:

Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.

You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.

failOnError

Type: boolean

failOnError – A flag to toggle a complete stop on an error.

Allowed values: "TRUE", "FALSE".

Default value: "TRUE".

When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.

When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.

format

Required: Yes
Type: string

The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.

Allowed values

csv for the Gremlin CSV data format.
opencypher for the openCypher CSV data format.
ntriples for the N-Triples RDF data format.
nquads for the N-Quads RDF data format.
rdfxml for the RDF\XML RDF data format.
turtle for the Turtle RDF data format.

iamRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.

mode

Type: string

The load job mode.

Allowed values: RESUME, NEW, AUTO.

Default value: AUTO.

RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.

The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.

NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.

AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.

If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.

parallelism

Type: string

The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.

Allowed values:

LOW – The number of threads used is the number of available vCPUs divided by 8.

MEDIUM – The number of threads used is the number of available vCPUs divided by 2.

HIGH – The number of threads used is the same as the number of available vCPUs.

OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.

This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.

Default value: HIGH

The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.

parserConfiguration

Type: Associative array of custom strings keys (String) to strings

parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:

namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).

The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.

baseUri – The base URI for RDF/XML and Turtle formats.

The default is https://aws.amazon.com/neptune/default.

allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.

If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.

queueRequest

Type: boolean

This is an optional flag parameter that indicates whether the load request can be queued up or not.

You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).

If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.

Allowed values: "TRUE", "FALSE".

Default value: "FALSE".

s3BucketRegion

Required: Yes

Type: string

The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.

source

Required: Yes

Type: string

The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.

The URI can be in any of the following formats.

s3://(bucket_name)/(object-key-name)

https://s3.amazonaws.com/(bucket_name)/(object-key-name)

https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)

The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.

The specified folder or folders can contain multiple vertex files and multiple edge files.

updateSingleCardinalityProperties

Type: boolean

updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.

Allowed values: "TRUE", "FALSE".

Default value: "FALSE".

By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.

When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.

userProvidedEdgeIds

Type: boolean

This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).

When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.

When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.

It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.

Result Syntax

[ 'payload' => ['<string>', ...], 'status' => '<string>', ]

Result Details

Members

payload

Required: Yes

Type: Associative array of custom strings keys (String) to strings

Contains a loadId name-value pair that provides an identifier for the load operation.

status

Required: Yes

Type: string

The HTTP return code indicating the status of the load job.

Errors

BadRequestException:
Raised when a request is submitted that cannot be processed.

InvalidParameterException:
Raised when a parameter value is not valid.

BulkLoadIdNotFoundException:
Raised when a specified bulk-load job ID cannot be found.

ClientTimeoutException:
Raised when a request timed out in the client.

LoadUrlAccessDeniedException:
Raised when access is denied to a specified load URL.

IllegalArgumentException:
Raised when an argument in a request is not supported.

TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.

InternalFailureException:
Raised when the processing of the request failed unexpectedly.

S3Exception:
Raised when there is a problem accessing Amazon S3.

PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.

ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.

InvalidArgumentException:
Raised when an argument in a request has an invalid value.

MissingParameterException:
Raised when a required parameter is missing.

StartMLDataProcessingJob

$result = $client->startMLDataProcessingJob([/* ... */]); $promise = $client->startMLDataProcessingJobAsync([/* ... */]);

Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.

Parameter Syntax

$result = $client->startMLDataProcessingJob([ 'configFileName' => '<string>', 'id' => '<string>', 'inputDataS3Location' => '<string>', // REQUIRED 'modelType' => '<string>', 'neptuneIamRoleArn' => '<string>', 'previousDataProcessingJobId' => '<string>', 'processedDataS3Location' => '<string>', // REQUIRED 'processingInstanceType' => '<string>', 'processingInstanceVolumeSizeInGB' => <integer>, 'processingTimeOutInSeconds' => <integer>, 's3OutputEncryptionKMSKey' => '<string>', 'sagemakerIamRoleArn' => '<string>', 'securityGroupIds' => ['<string>', ...], 'subnets' => ['<string>', ...], 'volumeEncryptionKMSKey' => '<string>', ]);

Parameter Details

Members

configFileName

Type: string

A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.

id

Type: string

A unique identifier for the new job. The default is an autogenerated UUID.

inputDataS3Location

Required: Yes

Type: string

The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.

modelType

Type: string

One of the two model types that Neptune ML currently supports: heterogeneous graph models (heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.

neptuneIamRoleArn

Type: string

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.

previousDataProcessingJobId

Type: string

The job ID of a completed data processing job run on an earlier version of the data.

processedDataS3Location

Required: Yes

Type: string

The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.

processingInstanceType

Type: string

The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.

processingInstanceVolumeSizeInGB

Type: int

The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.

processingTimeOutInSeconds

Type: int

Timeout in seconds for the data processing job. The default is 86,400 (1 day).

s3OutputEncryptionKMSKey

Type: string

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

sagemakerIamRoleArn

Type: string

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

securityGroupIds

Type: Array of strings

The VPC security group IDs. The default is None.

subnets

Type: Array of strings

The IDs of the subnets in the Neptune VPC. The default is None.

volumeEncryptionKMSKey

Type: string

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Result Syntax

[ 'arn' => '<string>', 'creationTimeInMillis' => <integer>, 'id' => '<string>', ]

Result Details

Members

arn

Type: string

The ARN of the data processing job.

creationTimeInMillis

Type: long (int|float)

The time it took to create the new processing job, in milliseconds.

id

Type: string

The unique ID of the new data processing job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.

BadRequestException:
Raised when a request is submitted that cannot be processed.

MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.

InvalidParameterException:
Raised when a parameter value is not valid.

ClientTimeoutException:
Raised when a request timed out in the client.

PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.

ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.

InvalidArgumentException:
Raised when an argument in a request has an invalid value.

MissingParameterException:
Raised when a required parameter is missing.

IllegalArgumentException:
Raised when an argument in a request is not supported.

TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

StartMLModelTrainingJob

$result = $client->startMLModelTrainingJob([/* ... */]); $promise = $client->startMLModelTrainingJobAsync([/* ... */]);

Creates a new Neptune ML model training job. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.

Parameter Syntax

$result = $client->startMLModelTrainingJob([ 'baseProcessingInstanceType' => '<string>', 'customModelTrainingParameters' => [ 'sourceS3DirectoryPath' => '<string>', // REQUIRED 'trainingEntryPointScript' => '<string>', 'transformEntryPointScript' => '<string>', ], 'dataProcessingJobId' => '<string>', // REQUIRED 'enableManagedSpotTraining' => true || false, 'id' => '<string>', 'maxHPONumberOfTrainingJobs' => <integer>, 'maxHPOParallelTrainingJobs' => <integer>, 'neptuneIamRoleArn' => '<string>', 'previousModelTrainingJobId' => '<string>', 's3OutputEncryptionKMSKey' => '<string>', 'sagemakerIamRoleArn' => '<string>', 'securityGroupIds' => ['<string>', ...], 'subnets' => ['<string>', ...], 'trainModelS3Location' => '<string>', // REQUIRED 'trainingInstanceType' => '<string>', 'trainingInstanceVolumeSizeInGB' => <integer>, 'trainingTimeOutInSeconds' => <integer>, 'volumeEncryptionKMSKey' => '<string>', ]);

Parameter Details

Members

baseProcessingInstanceType

Type: string

The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.

customModelTrainingParameters

Type: CustomModelTrainingParameters structure

The configuration for custom model training. This is a JSON object.

dataProcessingJobId

Required: Yes

Type: string

The job ID of the completed data-processing job that has created the data that the training will work with.

enableManagedSpotTraining

Type: boolean

Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is False.

id

Type: string

A unique identifier for the new job. The default is An autogenerated UUID.

maxHPONumberOfTrainingJobs

Type: int

Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10). In general, the more tuning runs, the better the results.

maxHPOParallelTrainingJobs

Type: int

Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

previousModelTrainingJobId

Type: string

The job ID of a completed model-training job that you want to update incrementally based on updated data.

s3OutputEncryptionKMSKey

Type: string

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

sagemakerIamRoleArn

Type: string

The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.

securityGroupIds

Type: Array of strings

The VPC security group IDs. The default is None.

subnets

Type: Array of strings

The IDs of the subnets in the Neptune VPC. The default is None.

trainModelS3Location

Required: Yes

Type: string

The location in Amazon S3 where the model artifacts are to be stored.

trainingInstanceType

Type: string

The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is ml.p3.2xlarge. Choosing the right instance type for training depends on the task type, graph size, and your budget.

trainingInstanceVolumeSizeInGB

Type: int

The disk volume size of the training instance. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

trainingTimeOutInSeconds

Type: int

Timeout in seconds for the training job. The default is 86,400 (1 day).

volumeEncryptionKMSKey

Type: string

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Result Syntax

[ 'arn' => '<string>', 'creationTimeInMillis' => <integer>, 'id' => '<string>', ]

Result Details

Members

arn

Type: string

The ARN of the new model training job.

creationTimeInMillis

Type: long (int|float)

The model training job creation time, in milliseconds.

id

Type: string

The unique ID of the new model training job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.

BadRequestException:
Raised when a request is submitted that cannot be processed.

MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.

InvalidParameterException:
Raised when a parameter value is not valid.

ClientTimeoutException:
Raised when a request timed out in the client.

PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.

ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.

InvalidArgumentException:
Raised when an argument in a request has an invalid value.

MissingParameterException:
Raised when a required parameter is missing.

IllegalArgumentException:
Raised when an argument in a request is not supported.

TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

StartMLModelTransformJob

$result = $client->startMLModelTransformJob([/* ... */]); $promise = $client->startMLModelTransformJobAsync([/* ... */]);

Creates a new model transform job. See Use a trained model to generate new model artifacts.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTransformJob IAM action in that cluster.

Parameter Syntax

$result = $client->startMLModelTransformJob([ 'baseProcessingInstanceType' => '<string>', 'baseProcessingInstanceVolumeSizeInGB' => <integer>, 'customModelTransformParameters' => [ 'sourceS3DirectoryPath' => '<string>', // REQUIRED 'transformEntryPointScript' => '<string>', ], 'dataProcessingJobId' => '<string>', 'id' => '<string>', 'mlModelTrainingJobId' => '<string>', 'modelTransformOutputS3Location' => '<string>', // REQUIRED 'neptuneIamRoleArn' => '<string>', 's3OutputEncryptionKMSKey' => '<string>', 'sagemakerIamRoleArn' => '<string>', 'securityGroupIds' => ['<string>', ...], 'subnets' => ['<string>', ...], 'trainingJobName' => '<string>', 'volumeEncryptionKMSKey' => '<string>', ]);

Parameter Details

Members

baseProcessingInstanceType

Type: string

The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.

baseProcessingInstanceVolumeSizeInGB

Type: int

The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

customModelTransformParameters

Type: CustomModelTransformParameters structure

Configuration information for a model transform using a custom model. The customModelTransformParameters object contains the following fields, which must have values compatible with the saved model parameters from the training job:

dataProcessingJobId

Type: string

The job ID of a completed data-processing job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

id

Type: string

A unique identifier for the new job. The default is an autogenerated UUID.

mlModelTrainingJobId

Type: string

The job ID of a completed model-training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

modelTransformOutputS3Location

Required: Yes

Type: string

The location in Amazon S3 where the model artifacts are to be stored.

neptuneIamRoleArn

Type: string

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

s3OutputEncryptionKMSKey

Type: string

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

sagemakerIamRoleArn

Type: string

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

securityGroupIds

Type: Array of strings

The VPC security group IDs. The default is None.

subnets

Type: Array of strings

The IDs of the subnets in the Neptune VPC. The default is None.

trainingJobName

Type: string

The name of a completed SageMaker training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

volumeEncryptionKMSKey

Type: string

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Result Syntax

[ 'arn' => '<string>', 'creationTimeInMillis' => <integer>, 'id' => '<string>', ]

Result Details

Members

arn

Type: string

The ARN of the model transform job.

creationTimeInMillis

Type: long (int|float)

The creation time of the model transform job, in milliseconds.

id

Type: string

The unique ID of the new model transform job.

Errors

UnsupportedOperationException:
Raised when a request attempts to initiate an operation that is not supported.

BadRequestException:
Raised when a request is submitted that cannot be processed.

MLResourceNotFoundException:
Raised when a specified machine-learning resource could not be found.

InvalidParameterException:
Raised when a parameter value is not valid.

ClientTimeoutException:
Raised when a request timed out in the client.

PreconditionsFailedException:
Raised when a precondition for processing a request is not satisfied.

ConstraintViolationException:
Raised when a value in a request field did not satisfy required constraints.

InvalidArgumentException:
Raised when an argument in a request has an invalid value.

MissingParameterException:
Raised when a required parameter is missing.

IllegalArgumentException:
Raised when an argument in a request is not supported.

TooManyRequestsException:
Raised when the number of requests being processed exceeds the limit.

Shapes

AccessDeniedException

Description

Raised in case of an authentication or authorization failure.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

BadRequestException

Description

Raised when a request is submitted that cannot be processed.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the bad request.

BulkLoadIdNotFoundException

Description

Raised when a specified bulk-load job ID cannot be found.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The bulk-load job ID that could not be found.

CancelledByUserException

Description

Raised when a user cancelled a request.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

ClientTimeoutException

Description

Raised when a request timed out in the client.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

ConcurrentModificationException

Description

Raised when a request attempts to modify data that is concurrently being modified by another process.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

ConstraintViolationException

Description

Raised when a value in a request field did not satisfy required constraints.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

CustomModelTrainingParameters

Description

Contains custom model training parameters. See Custom models in Neptune ML.

Members

sourceS3DirectoryPath

Required: Yes

Type: string

The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

trainingEntryPointScript

Type: string

The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is training.py.

transformEntryPointScript

Type: string

The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is transform.py.

CustomModelTransformParameters

Description

Contains custom model transform parameters. See Use a trained model to generate new model artifacts.

Members

sourceS3DirectoryPath

Required: Yes

Type: string

The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

transformEntryPointScript

Type: string

The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments. The default is transform.py.

DeleteStatisticsValueMap

Description

The payload for DeleteStatistics.

Members

active

Type: boolean

The current status of the statistics.

statisticsId

Type: string

The ID of the statistics generation run that is currently occurring.

Document

Members

EdgeStructure

Description

An edge structure.

Members

count

Type: long (int|float)

The number of edges that have this specific structure.

edgeProperties

Type: Array of strings

A list of edge properties present in this specific structure.

ExpiredStreamException

Description

Raised when a request attempts to access an stream that has expired.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

FailureByQueryException

Description

Raised when a request fails.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

FastResetToken

Description

A structure containing the fast reset token used to initiate a fast reset.

Members

token

Type: string

A UUID generated by the database in the initiateDatabaseReset action, and then consumed by the performDatabaseReset to reset the database.

GremlinQueryStatus

Description

Captures the status of a Gremlin query (see the Gremlin query status API page).

Members

queryEvalStats

Type: QueryEvalStats structure

The query statistics of the Gremlin query.

queryId

Type: string

The ID of the Gremlin query.

queryString

Type: string

The query string of the Gremlin query.

GremlinQueryStatusAttributes

Description

Contains status components of a Gremlin query.

Members

attributes

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Attributes of the Gremlin query status.

code

Type: int

The HTTP response code returned fro the Gremlin query request..

message

Type: string

The status message.

IllegalArgumentException

Description

Raised when an argument in a request is not supported.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

InternalFailureException

Description

Raised when the processing of the request failed unexpectedly.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

InvalidArgumentException

Description

Raised when an argument in a request has an invalid value.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

InvalidNumericDataException

Description

Raised when invalid numerical data is encountered when servicing a request.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

InvalidParameterException

Description

Raised when a parameter value is not valid.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that includes an invalid parameter.

LoadUrlAccessDeniedException

Description

Raised when access is denied to a specified load URL.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

LoaderIdResult

Description

Contains a list of load IDs.

Members

loadIds

Type: Array of strings

A list of load IDs.

MLResourceNotFoundException

Description

Raised when a specified machine-learning resource could not be found.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

MalformedQueryException

Description

Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the malformed query request.

MemoryLimitExceededException

Description

Raised when a request fails because of insufficient memory resources. The request can be retried.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that failed.

MethodNotAllowedException

Description

Raised when the HTTP method used by a request is not supported by the endpoint being used.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

MissingParameterException

Description

Raised when a required parameter is missing.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in which the parameter is missing.

MlConfigDefinition

Description

Contains a Neptune ML configuration.

Members

arn

Type: string

The ARN for the configuration.

name

Type: string

The configuration name.

MlResourceDefinition

Description

Defines a Neptune ML resource.

Members

arn

Type: string

The resource ARN.

cloudwatchLogUrl

Type: string

The CloudWatch log URL for the resource.

failureReason

Type: string

The failure reason, in case of a failure.

name

Type: string

The resource name.

outputLocation

Type: string

The output location.

status

Type: string

The resource status.

NodeStructure

Description

A node structure.

Members

count

Type: long (int|float)

Number of nodes that have this specific structure.

distinctOutgoingEdgeLabels

Type: Array of strings

A list of distinct outgoing edge labels present in this specific structure.

nodeProperties

Type: Array of strings

A list of the node properties present in this specific structure.

ParsingException

Description

Raised when a parsing issue is encountered.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

PreconditionsFailedException

Description

Raised when a precondition for processing a request is not satisfied.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

PropertygraphData

Description

A Gremlin or openCypher change record.

Members

from

Type: string

If this is an edge (type = e), the ID of the corresponding from vertex or source node.

id

Required: Yes

Type: string

The ID of the Gremlin or openCypher element.

key

Required: Yes

Type: string

The property name. For element labels, this is label.

to

Type: string

If this is an edge (type = e), the ID of the corresponding to vertex or target node.

type

Required: Yes

Type: string

The type of this Gremlin or openCypher element. Must be one of:

v1 - Vertex label for Gremlin, or node label for openCypher.

vp - Vertex properties for Gremlin, or node properties for openCypher.

e - Edge and edge label for Gremlin, or relationship and relationship type for openCypher.

ep - Edge properties for Gremlin, or relationship properties for openCypher.

value

Required: Yes

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:

PropertygraphRecord

Description

Structure of a property graph record.

Members

commitTimestampInMillis

Required: Yes

Type: long (int|float)

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

data

Required: Yes

Type: PropertygraphData structure

The serialized Gremlin or openCypher change record.

eventId

Required: Yes

Type: Associative array of custom strings keys (String) to strings

The sequence identifier of the stream change record.

isLastOp

Type: boolean

Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.

op

Required: Yes

Type: string

The operation that created the change.

PropertygraphSummary

Description

The graph summary API returns a read-only list of node and edge labels and property keys, along with counts of nodes, edges, and properties. See Graph summary response for a property graph (PG).

Members

edgeLabels

Type: Array of strings

A list of the distinct 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 the distinct node labels in the graph.

nodeProperties

Type: Array of maps

The number of distinct node properties in the graph.

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 distinct edge labels in the graph.

numEdgeProperties

Type: long (int|float)

The number of distinct 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)

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

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.

PropertygraphSummaryValueMap

Description

Payload for the property graph summary response.

Members

graphSummary

Type: PropertygraphSummary 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 last computed statistics.

version

Type: string

The version of this graph summary response.

QueryEvalStats

Description

Structure to capture query statistics such as how many queries are running, accepted or waiting and their details.

Members

cancelled

Type: boolean

Set to TRUE if the query was cancelled, or FALSE otherwise.

elapsed

Type: int

The number of milliseconds the query has been running so far.

subqueries

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The number of subqueries in this query.

waited

Type: int

Indicates how long the query waited, in milliseconds.

QueryLanguageVersion

Description

Structure for expressing the query language version.

Members

version

Required: Yes

Type: string

The version of the query language.

QueryLimitExceededException

Description

Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request which exceeded the limit.

QueryLimitException

Description

Raised when the size of a query exceeds the system limit.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that exceeded the limit.

QueryTooLargeException

Description

Raised when the body of a query is too large.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that is too large.

RDFGraphSummary

Description

The RDF graph summary API returns a read-only list of classes and predicate keys, along with counts of quads, subjects, and predicates.

Members

classes

Type: Array of strings

A list of the classes in the graph.

numClasses

Type: long (int|float)

The number of classes in the graph.

numDistinctPredicates

Type: long (int|float)

The number of distinct predicates in the graph.

numDistinctSubjects

Type: long (int|float)

The number of distinct subjects in the graph.

numQuads

Type: long (int|float)

The number of quads in the graph.

predicates

Type: Array of maps

"A list of predicates in the graph, along with the predicate counts.

subjectStructures

Type: Array of SubjectStructure structures

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

RDFGraphSummaryValueMap

Description

Payload for an RDF graph summary response.

Members

graphSummary

Type: RDFGraphSummary structure

The graph summary of an RDF graph. See Graph summary response for an RDF graph.

lastStatisticsComputationTime

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

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

version

Type: string

The version of this graph summary response.

ReadOnlyViolationException

Description

Raised when a request attempts to write to a read-only resource.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in which the parameter is missing.

RefreshStatisticsIdMap

Description

Statistics for REFRESH mode.

Members

statisticsId

Type: string

The ID of the statistics generation run that is currently occurring.

S3Exception

Description

Raised when there is a problem accessing Amazon S3.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

ServerShutdownException

Description

Raised when the server shuts down while processing a request.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

SparqlData

Description

Neptune logs are converted to SPARQL quads in the graph using the Resource Description Framework (RDF) N-QUADS language defined in the W3C RDF 1.1 N-Quads specification

Members

stmt

Required: Yes

Type: string

Holds an N-QUADS statement expressing the changed quad.

SparqlRecord

Description

A serialized SPARQL stream record capturing a change-log entry for the RDF graph.

Members

commitTimestampInMillis

Required: Yes

Type: long (int|float)

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

data

Required: Yes

Type: SparqlData structure

The serialized SPARQL change record. The serialization formats of each record are described in more detail in Serialization Formats in Neptune Streams.

eventId

Required: Yes

Type: Associative array of custom strings keys (String) to strings

The sequence identifier of the stream change record.

isLastOp

Type: boolean

Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.

op

Required: Yes

Type: string

The operation that created the change.

Statistics

Description

Contains statistics information. The DFE engine uses information about the data in your Neptune graph to make effective trade-offs when planning query execution. This information takes the form of statistics that include so-called characteristic sets and predicate statistics that can guide query planning. See Managing statistics for the Neptune DFE to use.

Members

active

Type: boolean

Indicates whether or not DFE statistics generation is enabled at all.

autoCompute

Type: boolean

Indicates whether or not automatic statistics generation is enabled.

date

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

The UTC time at which DFE statistics have most recently been generated.

note

Type: string

A note about problems in the case where statistics are invalid.

signatureInfo

Type: StatisticsSummary structure

A StatisticsSummary structure that contains:

signatureCount - The total number of signatures across all characteristic sets.

instanceCount - The total number of characteristic-set instances.

predicateCount - The total number of unique predicates.

statisticsId

Type: string

Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.

StatisticsNotAvailableException

Description

Raised when statistics needed to satisfy a request are not available.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

StatisticsSummary

Description

Information about the characteristic sets generated in the statistics.

Members

instanceCount

Type: int

The total number of characteristic-set instances.

predicateCount

Type: int

The total number of unique predicates.

signatureCount

Type: int

The total number of signatures across all characteristic sets.

StreamRecordsNotFoundException

Description

Raised when stream records requested by a query cannot be found.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

SubjectStructure

Description

A subject structure.

Members

count

Type: long (int|float)

Number of occurrences of this specific structure.

predicates

Type: Array of strings

A list of predicates present in this specific structure.

ThrottlingException

Description

Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that could not be processed for this reason.

TimeLimitExceededException

Description

Raised when the an operation exceeds the time limit allowed for it.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that could not be processed for this reason.

TooManyRequestsException

Description

Raised when the number of requests being processed exceeds the limit.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request that could not be processed for this reason.

UnsupportedOperationException

Description

Raised when a request attempts to initiate an operation that is not supported.

Members

code

Required: Yes

Type: string

The HTTP status code returned with the exception.

detailedMessage

Required: Yes

Type: string

A detailed message describing the problem.

requestId

Required: Yes

Type: string

The ID of the request in question.

Amazon NeptuneData 2023-08-01

Operation Summary

Operations

CancelGremlinQuery

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelLoaderJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelMLDataProcessingJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelMLModelTrainingJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelMLModelTransformJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelOpenCypherQuery

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMLEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteMLEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeletePropertygraphStatistics

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteSparqlStatistics

Parameter Syntax

Parameter Details

Members

Result Syntax