Amazon Neptune - User Guide

1 Amazon NeptuneUser GuideAPI Version 2017-11-29 Amazon Neptune user GuideAmazon Neptune : user GuideCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon 's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon . All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Neptune user GuideTable of ContentsWhat is Neptune ?

2 1 Amazon Neptune Features .. 2 Performance and Scalability .. 2 High Availability and Durability .. 2 Support for Open Graph APIs .. 2 Enhanced Data Security .. 2 Fully Managed Service .. 2 What is a Graph Database?.. 3 Graph Database Uses.. 4 Graph Queries and Traversals .. 7 Quick Start .. 10 Prerequisites .. 10 Launch the Amazon Neptune CloudFormation Stack .. 11 Accessing the Neptune Graph .. 12 Gremlin .. 12 RDF / SPARQL .. 16 Getting Started .. 18 Setting Up .. 18 Neptune VPC Requirements .. 18 Creating a Security Group to Provide Access to the Neptune DB Instance in the VPC.

3 20 Launching a DB Cluster.. 21 Launch a Neptune DB Cluster Using the Console.. 21 Creating a Neptune Replica Using the Console .. 23 Accessing a Graph .. 25 Finding the Endpoint.. 25 Launching an EC2 Instance .. 26 Gremlin .. 27 Neptune Gremlin Implementation Differences .. 28 Gremlin Console .. 36 HTTP REST .. 37 Java .. 38 Python .. 44 Gremlin HTTP and WebSocket API .. 46 Next Steps .. 46 SPARQL .. 46 RDF4J Console.. 47 HTTP REST .. 48 Java .. 49 RDF4J Workbench .. 52 SPARQL HTTP API .. 53 Query Status and Cancellation .. 54 Next Steps.

4 57 Cluster Status.. 57 Loading Data into Neptune .. 58 Prerequisites: IAM and Amazon S3 .. 59 Creating an IAM Role to Access Amazon S3 .. 59 Adding the IAM Role to a Cluster .. 60 Creating the Amazon S3 VPC Endpoint .. 60 Load Data Formats .. 61 Gremlin Load Data Format .. 62 RDF Load Data Formats .. 66 Example: Loading Data.. 66 API Version 2017-11-29iiiAmazon Neptune user GuidePrerequisites .. 66 Neptune Loader API Reference .. 69 Loader Command.. 69 Loader Get Status.. 73 Loader Cancel Job .. 80DB Instance Lifecycle .. 82 Backing Up and Restoring.

5 83 Working with Backups .. 83 Creating a Snapshot .. 86 Restoring from a DB Snapshot .. 87 Sharing a Snapshot.. 88DB Parameter Groups .. 93 Editing a DB Parameter Group .. 93 Creating a DB Parameter Group .. 94 Modifying a DB Instance .. 95 Impact of Apply Immediately .. 95 Common Settings and Downtime Notes .. 95 Renaming a DB Instance .. 98 Renaming a DB Instance Using the Console .. 98 Rebooting a DB Instance .. 99 Rebooting a DB Instance Using the Console .. 99 Deleting a DB Instance .. 100 Deleting a DB Instance with No Final Snapshot.

6 100 Deleting a DB Instance with a Final Snapshot .. 100 Encrypting Neptune Resources .. 103 Enabling Encryption .. 103 Monitoring Neptune with CloudWatch .. 104 Viewing CloudWatch Data (Console) .. 104 Viewing CloudWatch Data (AWS CLI) .. 104 Viewing CloudWatch Data (API) .. 105 Neptune Metrics.. 105 Neptune Dimensions.. 107 Logging Neptune API Calls with AWS CloudTrail .. 109 Neptune Information in CloudTrail .. 109 Understanding Neptune Log File Entries.. 110 Tagging Neptune Resources .. 112 Overview.. 112 Copying Tags .. 113 AWS Management Console.

7 113 CLI.. 114 API.. 114 Working with ARNs .. 115 Constructing an ARN.. 116 Getting an Existing ARN.. 117 Audit Logs with Neptune .. 119 Enabling Audit Logs.. 119 Viewing Audit Logs.. 119 Audit Log Details.. 119 IAM Authentication.. 121 Enabling IAM Authentication.. 121 AWS Management Console .. 121 Creating and Using an IAM Policy for IAM Database Access .. 122 Attaching an IAM Policy to an IAM user .. 124 IAM Policy Limitations .. 125 Connecting and Signing with AWS Signature Version 4 .. 125 Gremlin Console .. 126 Gremlin Java .. 128 API Version 2017-11-29ivAmazon Neptune user GuideSPARQL Java (RDF4J and Jena).

8 129 Connect to Neptune Using Python with Version 4 Signing (Example) .. 130 Prerequisites on EC2 .. 136 Manage Access .. 138 Authentication.. 138 Permissions Required to Use the Amazon Neptune Console .. 139 AWS Managed (Predefined) Policies for Amazon Neptune .. 139 Using Service-Linked Roles .. 140 Service-Linked Role Permissions for Neptune .. 140 Creating a Service-Linked Role for Neptune .. 141 Editing a Service-Linked Role for Neptune .. 141 Deleting a Service-Linked Role for Neptune .. 142 Neptune Limits.. 144 Neptune Service Errors .. 146 Error Format.

9 146 Error Messages and Codes .. 146 Engine Releases .. 149 Amazon Neptune Updates: 2018-06-22 (Version ) .. 149 Improvements .. 149 Amazon Neptune Updates: 2018-07-24 (Version ) .. 150 Improvements .. 149 Document History .. 151 Resource Management API Reference .. 152 Actions .. 152 AddRoleToDBCluster .. 154 AddSourceIdentifierToSubscription .. 156 AddTagsToResource .. 158 ApplyPendingMaintenanceAction .. 160 CopyDBClusterParameterGroup .. 162 CopyDBClusterSnapshot .. 164 CopyDBParameterGroup .. 168 CreateDBCluster .. 170 CreateDBClusterParameterGroup.

10 177 CreateDBClusterSnapshot .. 179 CreateDBInstance .. 181 CreateDBParameterGroup .. 191 CreateDBSubnetGroup .. 193 CreateEventSubscription .. 195 DeleteDBCluster .. 198 DeleteDBClusterParameterGroup .. 200 DeleteDBClusterSnapshot .. 202 DeleteDBInstance .. 204 DeleteDBParameterGroup .. 207 DeleteDBSubnetGroup .. 209 DeleteEventSubscription .. 211 DescribeDBClusterParameterGroups .. 212 DescribeDBClusterParameters .. 214 DescribeDBClusters .. 216 DescribeDBClusterSnapshotAttributes .. 218 DescribeDBClusterSnapshots .. 220 DescribeDBEngineVersions .. 223 DescribeDBInstances.