logo
Expand description

Amazon Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

If you’re using the service, you’re probably looking for NeptuneClient and Neptune.

Structs

Specifies an Availability Zone.

Specifies a character set.

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs.

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters action.

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.

Contains information about an instance that is part of a DB cluster.

Not supported by Neptune.

Contains the details of an Amazon Neptune DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.

Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

This data type is used as a response element in the action DescribeDBEngineVersions.

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

Provides a list of status information for a DB instance.

Contains the details of an Amazon Neptune DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

The status of the DB parameter group.

This data type is used as a response element in the following actions:

Specifies membership in a designated DB security group.

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

An Active Directory Domain membership record associated with a DB instance.

A range of double values.

Specifies a connection endpoint.

For the data structure that represents Amazon Neptune DB cluster endpoints, see DBClusterEndpoint.

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

This data type is used as a response element in the DescribeEvents action.

Contains the results of a successful invocation of the DescribeEventCategories action.

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

This type is not currently supported.

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

A client for the Amazon Neptune API.

Not supported by Neptune.

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

Specifies a parameter.

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

Provides information about a pending maintenance action for a resource.

This data type is used as a response element in the ModifyDBInstance action.

A range of integer values.

Describes the pending maintenance actions for a resource.

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups action.

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

A time zone associated with a DBInstance.

The version of the database engine that a DB instance can be upgraded to.

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

Information about valid modifications that you can make to your DB instance.

Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

This data type is used as a response element for queries on VPC security group membership.

Enums

Errors returned by AddRoleToDBCluster

Errors returned by AddSourceIdentifierToSubscription

Errors returned by AddTagsToResource

Errors returned by ApplyPendingMaintenanceAction

Errors returned by CopyDBClusterParameterGroup

Errors returned by CopyDBClusterSnapshot

Errors returned by CopyDBParameterGroup

Errors returned by CreateDBClusterEndpoint

Errors returned by CreateDBCluster

Errors returned by CreateDBClusterParameterGroup

Errors returned by CreateDBClusterSnapshot

Errors returned by CreateDBInstance

Errors returned by CreateDBParameterGroup

Errors returned by CreateDBSubnetGroup

Errors returned by CreateEventSubscription

Errors returned by DeleteDBClusterEndpoint

Errors returned by DeleteDBCluster

Errors returned by DeleteDBClusterParameterGroup

Errors returned by DeleteDBClusterSnapshot

Errors returned by DeleteDBInstance

Errors returned by DeleteDBParameterGroup

Errors returned by DeleteDBSubnetGroup

Errors returned by DeleteEventSubscription

Errors returned by DescribeDBClusterEndpoints

Errors returned by DescribeDBClusterParameterGroups

Errors returned by DescribeDBClusterParameters

Errors returned by DescribeDBClusterSnapshotAttributes

Errors returned by DescribeDBClusterSnapshots

Errors returned by DescribeDBClusters

Errors returned by DescribeDBEngineVersions

Errors returned by DescribeDBInstances

Errors returned by DescribeDBParameterGroups

Errors returned by DescribeDBParameters

Errors returned by DescribeDBSubnetGroups

Errors returned by DescribeEngineDefaultClusterParameters

Errors returned by DescribeEngineDefaultParameters

Errors returned by DescribeEventCategories

Errors returned by DescribeEventSubscriptions

Errors returned by DescribeEvents

Errors returned by DescribeOrderableDBInstanceOptions

Errors returned by DescribePendingMaintenanceActions

Errors returned by DescribeValidDBInstanceModifications

Errors returned by FailoverDBCluster

Errors returned by ListTagsForResource

Errors returned by ModifyDBClusterEndpoint

Errors returned by ModifyDBCluster

Errors returned by ModifyDBClusterParameterGroup

Errors returned by ModifyDBClusterSnapshotAttribute

Errors returned by ModifyDBInstance

Errors returned by ModifyDBParameterGroup

Errors returned by ModifyDBSubnetGroup

Errors returned by ModifyEventSubscription

Errors returned by PromoteReadReplicaDBCluster

Errors returned by RebootDBInstance

Errors returned by RemoveRoleFromDBCluster

Errors returned by RemoveSourceIdentifierFromSubscription

Errors returned by RemoveTagsFromResource

Errors returned by ResetDBClusterParameterGroup

Errors returned by ResetDBParameterGroup

Errors returned by RestoreDBClusterFromSnapshot

Errors returned by RestoreDBClusterToPointInTime

Errors returned by StartDBCluster

Errors returned by StopDBCluster

Traits

Trait representing the capabilities of the Amazon Neptune API. Amazon Neptune clients implement this trait.