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.
neptune(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- neptune(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_role_to_db_cluster | Associates an Identity and Access Management (IAM) role with an Neptune DB cluster |
| add_source_identifier_to_subscription | Adds a source identifier to an existing event notification subscription |
| add_tags_to_resource | Adds metadata tags to an Amazon Neptune resource |
| apply_pending_maintenance_action | Applies a pending maintenance action to a resource (for example, to a DB instance) |
| copy_db_cluster_parameter_group | Copies the specified DB cluster parameter group |
| copy_db_cluster_snapshot | Copies a snapshot of a DB cluster |
| copy_db_parameter_group | Copies the specified DB parameter group |
| create_db_cluster | Creates a new Amazon Neptune DB cluster |
| create_db_cluster_endpoint | Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster |
| create_db_cluster_parameter_group | Creates a new DB cluster parameter group |
| create_db_cluster_snapshot | Creates a snapshot of a DB cluster |
| create_db_instance | Creates a new DB instance |
| create_db_parameter_group | Creates a new DB parameter group |
| create_db_subnet_group | Creates a new DB subnet group |
| create_event_subscription | Creates an event notification subscription |
| create_global_cluster | Creates a Neptune global database spread across multiple Amazon Regions |
| delete_db_cluster | The DeleteDBCluster action deletes a previously provisioned DB cluster |
| delete_db_cluster_endpoint | Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster |
| delete_db_cluster_parameter_group | Deletes a specified DB cluster parameter group |
| delete_db_cluster_snapshot | Deletes a DB cluster snapshot |
| delete_db_instance | The DeleteDBInstance action deletes a previously provisioned DB instance |
| delete_db_parameter_group | Deletes a specified DBParameterGroup |
| delete_db_subnet_group | Deletes a DB subnet group |
| delete_event_subscription | Deletes an event notification subscription |
| delete_global_cluster | Deletes a global database |
| describe_db_cluster_endpoints | Returns information about endpoints for an Amazon Neptune DB cluster |
| describe_db_cluster_parameter_groups | Returns a list of DBClusterParameterGroup descriptions |
| describe_db_cluster_parameters | Returns the detailed parameter list for a particular DB cluster parameter group |
| describe_db_clusters | Returns information about provisioned DB clusters, and supports pagination |
| describe_db_cluster_snapshot_attributes | Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot |
| describe_db_cluster_snapshots | Returns information about DB cluster snapshots |
| describe_db_engine_versions | Returns a list of the available DB engines |
| describe_db_instances | Returns information about provisioned instances, and supports pagination |
| describe_db_parameter_groups | Returns a list of DBParameterGroup descriptions |
| describe_db_parameters | Returns the detailed parameter list for a particular DB parameter group |
| describe_db_subnet_groups | Returns a list of DBSubnetGroup descriptions |
| describe_engine_default_cluster_parameters | Returns the default engine and system parameter information for the cluster database engine |
| describe_engine_default_parameters | Returns the default engine and system parameter information for the specified database engine |
| describe_event_categories | Displays a list of categories for all event source types, or, if specified, for a specified source type |
| describe_events | Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days |
| describe_event_subscriptions | Lists all the subscription descriptions for a customer account |
| describe_global_clusters | Returns information about Neptune global database clusters |
| describe_orderable_db_instance_options | Returns a list of orderable DB instance options for the specified engine |
| describe_pending_maintenance_actions | Returns a list of resources (for example, DB instances) that have at least one pending maintenance action |
| describe_valid_db_instance_modifications | You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance |
| failover_db_cluster | Forces a failover for a DB cluster |
| failover_global_cluster | Initiates the failover process for a Neptune global database |
| list_tags_for_resource | Lists all tags on an Amazon Neptune resource |
| modify_db_cluster | Modify a setting for a DB cluster |
| modify_db_cluster_endpoint | Modifies the properties of an endpoint in an Amazon Neptune DB cluster |
| modify_db_cluster_parameter_group | Modifies the parameters of a DB cluster parameter group |
| modify_db_cluster_snapshot_attribute | Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot |
| modify_db_instance | Modifies settings for a DB instance |
| modify_db_parameter_group | Modifies the parameters of a DB parameter group |
| modify_db_subnet_group | Modifies an existing DB subnet group |
| modify_event_subscription | Modifies an existing event notification subscription |
| modify_global_cluster | Modify a setting for an Amazon Neptune global cluster |
| promote_read_replica_db_cluster | Not supported |
| reboot_db_instance | You might need to reboot your DB instance, usually for maintenance reasons |
| remove_from_global_cluster | Detaches a Neptune DB cluster from a Neptune global database |
| remove_role_from_db_cluster | Disassociates an Identity and Access Management (IAM) role from a DB cluster |
| remove_source_identifier_from_subscription | Removes a source identifier from an existing event notification subscription |
| remove_tags_from_resource | Removes metadata tags from an Amazon Neptune resource |
| reset_db_cluster_parameter_group | Modifies the parameters of a DB cluster parameter group to the default value |
| reset_db_parameter_group | Modifies the parameters of a DB parameter group to the engine/system default value |
| restore_db_cluster_from_snapshot | Creates a new DB cluster from a DB snapshot or DB cluster snapshot |
| restore_db_cluster_to_point_in_time | Restores a DB cluster to an arbitrary point in time |
| start_db_cluster | Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API |
| stop_db_cluster | Stops an Amazon Neptune DB cluster |
if (FALSE) {
svc <- neptune()
svc$add_role_to_db_cluster(
Foo = 123
)
}
Run the code above in your browser using DataLab