

*******
Neptune
*******



======
Client
======



.. py:class:: Neptune.Client

  A low-level client representing 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.

  ::

    
    import boto3
    
    client = boto3.client('neptune')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  neptune/client/add_role_to_db_cluster
  neptune/client/add_source_identifier_to_subscription
  neptune/client/add_tags_to_resource
  neptune/client/apply_pending_maintenance_action
  neptune/client/can_paginate
  neptune/client/close
  neptune/client/copy_db_cluster_parameter_group
  neptune/client/copy_db_cluster_snapshot
  neptune/client/copy_db_parameter_group
  neptune/client/create_db_cluster
  neptune/client/create_db_cluster_endpoint
  neptune/client/create_db_cluster_parameter_group
  neptune/client/create_db_cluster_snapshot
  neptune/client/create_db_instance
  neptune/client/create_db_parameter_group
  neptune/client/create_db_subnet_group
  neptune/client/create_event_subscription
  neptune/client/create_global_cluster
  neptune/client/delete_db_cluster
  neptune/client/delete_db_cluster_endpoint
  neptune/client/delete_db_cluster_parameter_group
  neptune/client/delete_db_cluster_snapshot
  neptune/client/delete_db_instance
  neptune/client/delete_db_parameter_group
  neptune/client/delete_db_subnet_group
  neptune/client/delete_event_subscription
  neptune/client/delete_global_cluster
  neptune/client/describe_db_cluster_endpoints
  neptune/client/describe_db_cluster_parameter_groups
  neptune/client/describe_db_cluster_parameters
  neptune/client/describe_db_cluster_snapshot_attributes
  neptune/client/describe_db_cluster_snapshots
  neptune/client/describe_db_clusters
  neptune/client/describe_db_engine_versions
  neptune/client/describe_db_instances
  neptune/client/describe_db_parameter_groups
  neptune/client/describe_db_parameters
  neptune/client/describe_db_subnet_groups
  neptune/client/describe_engine_default_cluster_parameters
  neptune/client/describe_engine_default_parameters
  neptune/client/describe_event_categories
  neptune/client/describe_event_subscriptions
  neptune/client/describe_events
  neptune/client/describe_global_clusters
  neptune/client/describe_orderable_db_instance_options
  neptune/client/describe_pending_maintenance_actions
  neptune/client/describe_valid_db_instance_modifications
  neptune/client/failover_db_cluster
  neptune/client/failover_global_cluster
  neptune/client/get_paginator
  neptune/client/get_waiter
  neptune/client/list_tags_for_resource
  neptune/client/modify_db_cluster
  neptune/client/modify_db_cluster_endpoint
  neptune/client/modify_db_cluster_parameter_group
  neptune/client/modify_db_cluster_snapshot_attribute
  neptune/client/modify_db_instance
  neptune/client/modify_db_parameter_group
  neptune/client/modify_db_subnet_group
  neptune/client/modify_event_subscription
  neptune/client/modify_global_cluster
  neptune/client/promote_read_replica_db_cluster
  neptune/client/reboot_db_instance
  neptune/client/remove_from_global_cluster
  neptune/client/remove_role_from_db_cluster
  neptune/client/remove_source_identifier_from_subscription
  neptune/client/remove_tags_from_resource
  neptune/client/reset_db_cluster_parameter_group
  neptune/client/reset_db_parameter_group
  neptune/client/restore_db_cluster_from_snapshot
  neptune/client/restore_db_cluster_to_point_in_time
  neptune/client/start_db_cluster
  neptune/client/stop_db_cluster
  neptune/client/switchover_global_cluster


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  neptune/paginator/DescribeDBClusterEndpoints
  neptune/paginator/DescribeDBClusterParameterGroups
  neptune/paginator/DescribeDBClusterParameters
  neptune/paginator/DescribeDBClusterSnapshots
  neptune/paginator/DescribeDBClusters
  neptune/paginator/DescribeDBEngineVersions
  neptune/paginator/DescribeDBInstances
  neptune/paginator/DescribeDBParameterGroups
  neptune/paginator/DescribeDBParameters
  neptune/paginator/DescribeDBSubnetGroups
  neptune/paginator/DescribeEngineDefaultParameters
  neptune/paginator/DescribeEventSubscriptions
  neptune/paginator/DescribeEvents
  neptune/paginator/DescribeGlobalClusters
  neptune/paginator/DescribeOrderableDBInstanceOptions
  neptune/paginator/DescribePendingMaintenanceActions


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  neptune/waiter/DBInstanceAvailable
  neptune/waiter/DBInstanceDeleted
