

# Amazon Neptune Management API Reference
<a name="api"></a>

This chapter documents the Neptune API operations that you can use to manage and maintain your Neptune DB cluster.

Neptune operates on clusters of database servers that are connected in a replication topology. Thus, managing Neptune often involves deploying changes to multiple servers and making sure that all Neptune replicas are keeping up with the primary server.

Because Neptune transparently scales the underlying storage as your data grows, managing Neptune requires relatively little management of disk storage. Likewise, because Neptune automatically performs continuous backups, a Neptune cluster does not require extensive planning or downtime for performing backups. 

**Contents**
+ [Neptune DB Clusters API](api-clusters.md)
  + [CreateDBCluster (action)](api-clusters.md#CreateDBCluster)
  + [DeleteDBCluster (action)](api-clusters.md#DeleteDBCluster)
  + [ModifyDBCluster (action)](api-clusters.md#ModifyDBCluster)
  + [StartDBCluster (action)](api-clusters.md#StartDBCluster)
  + [StopDBCluster (action)](api-clusters.md#StopDBCluster)
  + [AddRoleToDBCluster (action)](api-clusters.md#AddRoleToDBCluster)
  + [RemoveRoleFromDBCluster (action)](api-clusters.md#RemoveRoleFromDBCluster)
  + [FailoverDBCluster (action)](api-clusters.md#FailoverDBCluster)
  + [PromoteReadReplicaDBCluster (action)](api-clusters.md#PromoteReadReplicaDBCluster)
  + [DescribeDBClusters (action)](api-clusters.md#DescribeDBClusters)
  + [*Structures:*](api-clusters.md#api-clusters-structures-spacer)
  + [DBCluster (structure)](api-clusters.md#DBCluster)
  + [DBClusterMember (structure)](api-clusters.md#DBClusterMember)
  + [DBClusterRole (structure)](api-clusters.md#DBClusterRole)
  + [CloudwatchLogsExportConfiguration (structure)](api-clusters.md#CloudwatchLogsExportConfiguration)
  + [PendingCloudwatchLogsExports (structure)](api-clusters.md#PendingCloudwatchLogsExports)
  + [ClusterPendingModifiedValues (structure)](api-clusters.md#ClusterPendingModifiedValues)
+ [Neptune Global Database API](api-global-dbs.md)
  + [CreateGlobalCluster (action)](api-global-dbs.md#CreateGlobalCluster)
  + [DeleteGlobalCluster (action)](api-global-dbs.md#DeleteGlobalCluster)
  + [ModifyGlobalCluster (action)](api-global-dbs.md#ModifyGlobalCluster)
  + [DescribeGlobalClusters (action)](api-global-dbs.md#DescribeGlobalClusters)
  + [FailoverGlobalCluster (action)](api-global-dbs.md#FailoverGlobalCluster)
  + [RemoveFromGlobalCluster (action)](api-global-dbs.md#RemoveFromGlobalCluster)
  + [*Structures:*](api-global-dbs.md#api-global-dbs-structures-spacer)
  + [GlobalCluster (structure)](api-global-dbs.md#GlobalCluster)
  + [GlobalClusterMember (structure)](api-global-dbs.md#GlobalClusterMember)
+ [Neptune Instances API](api-instances.md)
  + [CreateDBInstance (action)](api-instances.md#CreateDBInstance)
  + [DeleteDBInstance (action)](api-instances.md#DeleteDBInstance)
  + [ModifyDBInstance (action)](api-instances.md#ModifyDBInstance)
  + [RebootDBInstance (action)](api-instances.md#RebootDBInstance)
  + [DescribeDBInstances (action)](api-instances.md#DescribeDBInstances)
  + [DescribeOrderableDBInstanceOptions (action)](api-instances.md#DescribeOrderableDBInstanceOptions)
  + [DescribeValidDBInstanceModifications (action)](api-instances.md#DescribeValidDBInstanceModifications)
  + [*Structures:*](api-instances.md#api-instances-structures-spacer)
  + [DBInstance (structure)](api-instances.md#DBInstance)
  + [DBInstanceStatusInfo (structure)](api-instances.md#DBInstanceStatusInfo)
  + [OrderableDBInstanceOption (structure)](api-instances.md#OrderableDBInstanceOption)
  + [PendingModifiedValues (structure)](api-instances.md#PendingModifiedValues)
  + [ValidStorageOptions (structure)](api-instances.md#ValidStorageOptions)
  + [ValidDBInstanceModificationsMessage (structure)](api-instances.md#ValidDBInstanceModificationsMessage)
+ [Neptune Parameters API](api-parameters.md)
  + [CopyDBParameterGroup (action)](api-parameters.md#CopyDBParameterGroup)
  + [CopyDBClusterParameterGroup (action)](api-parameters.md#CopyDBClusterParameterGroup)
  + [CreateDBParameterGroup (action)](api-parameters.md#CreateDBParameterGroup)
  + [CreateDBClusterParameterGroup (action)](api-parameters.md#CreateDBClusterParameterGroup)
  + [DeleteDBParameterGroup (action)](api-parameters.md#DeleteDBParameterGroup)
  + [DeleteDBClusterParameterGroup (action)](api-parameters.md#DeleteDBClusterParameterGroup)
  + [ModifyDBParameterGroup (action)](api-parameters.md#ModifyDBParameterGroup)
  + [ModifyDBClusterParameterGroup (action)](api-parameters.md#ModifyDBClusterParameterGroup)
  + [ResetDBParameterGroup (action)](api-parameters.md#ResetDBParameterGroup)
  + [ResetDBClusterParameterGroup (action)](api-parameters.md#ResetDBClusterParameterGroup)
  + [DescribeDBParameters (action)](api-parameters.md#DescribeDBParameters)
  + [DescribeDBParameterGroups (action)](api-parameters.md#DescribeDBParameterGroups)
  + [DescribeDBClusterParameters (action)](api-parameters.md#DescribeDBClusterParameters)
  + [DescribeDBClusterParameterGroups (action)](api-parameters.md#DescribeDBClusterParameterGroups)
  + [DescribeEngineDefaultParameters (action)](api-parameters.md#DescribeEngineDefaultParameters)
  + [DescribeEngineDefaultClusterParameters (action)](api-parameters.md#DescribeEngineDefaultClusterParameters)
  + [*Structures:*](api-parameters.md#api-parameters-structures-spacer)
  + [Parameter (structure)](api-parameters.md#Parameter)
  + [DBParameterGroup (structure)](api-parameters.md#DBParameterGroup)
  + [DBClusterParameterGroup (structure)](api-parameters.md#DBClusterParameterGroup)
  + [DBParameterGroupStatus (structure)](api-parameters.md#DBParameterGroupStatus)
+ [Neptune Subnet API](api-subnets.md)
  + [CreateDBSubnetGroup (action)](api-subnets.md#CreateDBSubnetGroup)
  + [DeleteDBSubnetGroup (action)](api-subnets.md#DeleteDBSubnetGroup)
  + [ModifyDBSubnetGroup (action)](api-subnets.md#ModifyDBSubnetGroup)
  + [DescribeDBSubnetGroups (action)](api-subnets.md#DescribeDBSubnetGroups)
  + [*Structures:*](api-subnets.md#api-subnets-structures-spacer)
  + [Subnet (structure)](api-subnets.md#Subnet)
  + [DBSubnetGroup (structure)](api-subnets.md#DBSubnetGroup)
+ [Neptune Snapshots API](api-snapshots.md)
  + [CreateDBClusterSnapshot (action)](api-snapshots.md#CreateDBClusterSnapshot)
  + [DeleteDBClusterSnapshot (action)](api-snapshots.md#DeleteDBClusterSnapshot)
  + [CopyDBClusterSnapshot (action)](api-snapshots.md#CopyDBClusterSnapshot)
  + [ModifyDBClusterSnapshotAttribute (action)](api-snapshots.md#ModifyDBClusterSnapshotAttribute)
  + [RestoreDBClusterFromSnapshot (action)](api-snapshots.md#RestoreDBClusterFromSnapshot)
  + [RestoreDBClusterToPointInTime (action)](api-snapshots.md#RestoreDBClusterToPointInTime)
  + [DescribeDBClusterSnapshots (action)](api-snapshots.md#DescribeDBClusterSnapshots)
  + [DescribeDBClusterSnapshotAttributes (action)](api-snapshots.md#DescribeDBClusterSnapshotAttributes)
  + [*Structures:*](api-snapshots.md#api-snapshots-structures-spacer)
  + [DBClusterSnapshot (structure)](api-snapshots.md#DBClusterSnapshot)
  + [DBClusterSnapshotAttribute (structure)](api-snapshots.md#DBClusterSnapshotAttribute)
  + [DBClusterSnapshotAttributesResult (structure)](api-snapshots.md#DBClusterSnapshotAttributesResult)
+ [Neptune Events API](api-events.md)
  + [CreateEventSubscription (action)](api-events.md#CreateEventSubscription)
  + [DeleteEventSubscription (action)](api-events.md#DeleteEventSubscription)
  + [ModifyEventSubscription (action)](api-events.md#ModifyEventSubscription)
  + [DescribeEventSubscriptions (action)](api-events.md#DescribeEventSubscriptions)
  + [AddSourceIdentifierToSubscription (action)](api-events.md#AddSourceIdentifierToSubscription)
  + [RemoveSourceIdentifierFromSubscription (action)](api-events.md#RemoveSourceIdentifierFromSubscription)
  + [DescribeEvents (action)](api-events.md#DescribeEvents)
  + [DescribeEventCategories (action)](api-events.md#DescribeEventCategories)
  + [*Structures:*](api-events.md#api-events-structures-spacer)
  + [Event (structure)](api-events.md#Event)
  + [EventCategoriesMap (structure)](api-events.md#EventCategoriesMap)
  + [EventSubscription (structure)](api-events.md#EventSubscription)
+ [Other Neptune APIs](api-other-apis.md)
  + [AddTagsToResource (action)](api-other-apis.md#AddTagsToResource)
  + [ListTagsForResource (action)](api-other-apis.md#ListTagsForResource)
  + [RemoveTagsFromResource (action)](api-other-apis.md#RemoveTagsFromResource)
  + [ApplyPendingMaintenanceAction (action)](api-other-apis.md#ApplyPendingMaintenanceAction)
  + [DescribePendingMaintenanceActions (action)](api-other-apis.md#DescribePendingMaintenanceActions)
  + [DescribeDBEngineVersions (action)](api-other-apis.md#DescribeDBEngineVersions)
  + [*Structures:*](api-other-apis.md#api-other-apis-structures-spacer)
  + [DBEngineVersion (structure)](api-other-apis.md#DBEngineVersion)
  + [EngineDefaults (structure)](api-other-apis.md#EngineDefaults)
  + [PendingMaintenanceAction (structure)](api-other-apis.md#PendingMaintenanceAction)
  + [ResourcePendingMaintenanceActions (structure)](api-other-apis.md#ResourcePendingMaintenanceActions)
  + [UpgradeTarget (structure)](api-other-apis.md#UpgradeTarget)
  + [Tag (structure)](api-other-apis.md#Tag)
+ [Common Neptune Datatypes](api-datatypes.md)
  + [AvailabilityZone (structure)](api-datatypes.md#AvailabilityZone)
  + [DBSecurityGroupMembership (structure)](api-datatypes.md#DBSecurityGroupMembership)
  + [DomainMembership (structure)](api-datatypes.md#DomainMembership)
  + [DoubleRange (structure)](api-datatypes.md#DoubleRange)
  + [Endpoint (structure)](api-datatypes.md#Endpoint)
  + [Filter (structure)](api-datatypes.md#Filter)
  + [Range (structure)](api-datatypes.md#Range)
  + [ServerlessV2ScalingConfiguration (structure)](api-datatypes.md#ServerlessV2ScalingConfiguration)
  + [ServerlessV2ScalingConfigurationInfo (structure)](api-datatypes.md#ServerlessV2ScalingConfigurationInfo)
  + [Timezone (structure)](api-datatypes.md#Timezone)
  + [VpcSecurityGroupMembership (structure)](api-datatypes.md#VpcSecurityGroupMembership)
+ [Neptune Exceptions Specific to Individual APIs](api-faults.md)
  + [AuthorizationAlreadyExistsFault (structure)](api-faults.md#AuthorizationAlreadyExistsFault)
  + [AuthorizationNotFoundFault (structure)](api-faults.md#AuthorizationNotFoundFault)
  + [AuthorizationQuotaExceededFault (structure)](api-faults.md#AuthorizationQuotaExceededFault)
  + [CertificateNotFoundFault (structure)](api-faults.md#CertificateNotFoundFault)
  + [DBClusterAlreadyExistsFault (structure)](api-faults.md#DBClusterAlreadyExistsFault)
  + [DBClusterNotFoundFault (structure)](api-faults.md#DBClusterNotFoundFault)
  + [DBClusterParameterGroupNotFoundFault (structure)](api-faults.md#DBClusterParameterGroupNotFoundFault)
  + [DBClusterQuotaExceededFault (structure)](api-faults.md#DBClusterQuotaExceededFault)
  + [DBClusterRoleAlreadyExistsFault (structure)](api-faults.md#DBClusterRoleAlreadyExistsFault)
  + [DBClusterRoleNotFoundFault (structure)](api-faults.md#DBClusterRoleNotFoundFault)
  + [DBClusterRoleQuotaExceededFault (structure)](api-faults.md#DBClusterRoleQuotaExceededFault)
  + [DBClusterSnapshotAlreadyExistsFault (structure)](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
  + [DBClusterSnapshotNotFoundFault (structure)](api-faults.md#DBClusterSnapshotNotFoundFault)
  + [DBInstanceAlreadyExistsFault (structure)](api-faults.md#DBInstanceAlreadyExistsFault)
  + [DBInstanceNotFoundFault (structure)](api-faults.md#DBInstanceNotFoundFault)
  + [DBLogFileNotFoundFault (structure)](api-faults.md#DBLogFileNotFoundFault)
  + [DBParameterGroupAlreadyExistsFault (structure)](api-faults.md#DBParameterGroupAlreadyExistsFault)
  + [DBParameterGroupNotFoundFault (structure)](api-faults.md#DBParameterGroupNotFoundFault)
  + [DBParameterGroupQuotaExceededFault (structure)](api-faults.md#DBParameterGroupQuotaExceededFault)
  + [DBSecurityGroupAlreadyExistsFault (structure)](api-faults.md#DBSecurityGroupAlreadyExistsFault)
  + [DBSecurityGroupNotFoundFault (structure)](api-faults.md#DBSecurityGroupNotFoundFault)
  + [DBSecurityGroupNotSupportedFault (structure)](api-faults.md#DBSecurityGroupNotSupportedFault)
  + [DBSecurityGroupQuotaExceededFault (structure)](api-faults.md#DBSecurityGroupQuotaExceededFault)
  + [DBSnapshotAlreadyExistsFault (structure)](api-faults.md#DBSnapshotAlreadyExistsFault)
  + [DBSnapshotNotFoundFault (structure)](api-faults.md#DBSnapshotNotFoundFault)
  + [DBSubnetGroupAlreadyExistsFault (structure)](api-faults.md#DBSubnetGroupAlreadyExistsFault)
  + [DBSubnetGroupDoesNotCoverEnoughAZs (structure)](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
  + [DBSubnetGroupNotAllowedFault (structure)](api-faults.md#DBSubnetGroupNotAllowedFault)
  + [DBSubnetGroupNotFoundFault (structure)](api-faults.md#DBSubnetGroupNotFoundFault)
  + [DBSubnetGroupQuotaExceededFault (structure)](api-faults.md#DBSubnetGroupQuotaExceededFault)
  + [DBSubnetQuotaExceededFault (structure)](api-faults.md#DBSubnetQuotaExceededFault)
  + [DBUpgradeDependencyFailureFault (structure)](api-faults.md#DBUpgradeDependencyFailureFault)
  + [DomainNotFoundFault (structure)](api-faults.md#DomainNotFoundFault)
  + [EventSubscriptionQuotaExceededFault (structure)](api-faults.md#EventSubscriptionQuotaExceededFault)
  + [GlobalClusterAlreadyExistsFault (structure)](api-faults.md#GlobalClusterAlreadyExistsFault)
  + [GlobalClusterNotFoundFault (structure)](api-faults.md#GlobalClusterNotFoundFault)
  + [GlobalClusterQuotaExceededFault (structure)](api-faults.md#GlobalClusterQuotaExceededFault)
  + [InstanceQuotaExceededFault (structure)](api-faults.md#InstanceQuotaExceededFault)
  + [InsufficientDBClusterCapacityFault (structure)](api-faults.md#InsufficientDBClusterCapacityFault)
  + [InsufficientDBInstanceCapacityFault (structure)](api-faults.md#InsufficientDBInstanceCapacityFault)
  + [InsufficientStorageClusterCapacityFault (structure)](api-faults.md#InsufficientStorageClusterCapacityFault)
  + [InvalidDBClusterEndpointStateFault (structure)](api-faults.md#InvalidDBClusterEndpointStateFault)
  + [InvalidDBClusterSnapshotStateFault (structure)](api-faults.md#InvalidDBClusterSnapshotStateFault)
  + [InvalidDBClusterStateFault (structure)](api-faults.md#InvalidDBClusterStateFault)
  + [InvalidDBInstanceStateFault (structure)](api-faults.md#InvalidDBInstanceStateFault)
  + [InvalidDBParameterGroupStateFault (structure)](api-faults.md#InvalidDBParameterGroupStateFault)
  + [InvalidDBSecurityGroupStateFault (structure)](api-faults.md#InvalidDBSecurityGroupStateFault)
  + [InvalidDBSnapshotStateFault (structure)](api-faults.md#InvalidDBSnapshotStateFault)
  + [InvalidDBSubnetGroupFault (structure)](api-faults.md#InvalidDBSubnetGroupFault)
  + [InvalidDBSubnetGroupStateFault (structure)](api-faults.md#InvalidDBSubnetGroupStateFault)
  + [InvalidDBSubnetStateFault (structure)](api-faults.md#InvalidDBSubnetStateFault)
  + [InvalidEventSubscriptionStateFault (structure)](api-faults.md#InvalidEventSubscriptionStateFault)
  + [InvalidGlobalClusterStateFault (structure)](api-faults.md#InvalidGlobalClusterStateFault)
  + [InvalidOptionGroupStateFault (structure)](api-faults.md#InvalidOptionGroupStateFault)
  + [InvalidRestoreFault (structure)](api-faults.md#InvalidRestoreFault)
  + [InvalidSubnet (structure)](api-faults.md#InvalidSubnet)
  + [InvalidVPCNetworkStateFault (structure)](api-faults.md#InvalidVPCNetworkStateFault)
  + [KMSKeyNotAccessibleFault (structure)](api-faults.md#KMSKeyNotAccessibleFault)
  + [OptionGroupNotFoundFault (structure)](api-faults.md#OptionGroupNotFoundFault)
  + [PointInTimeRestoreNotEnabledFault (structure)](api-faults.md#PointInTimeRestoreNotEnabledFault)
  + [ProvisionedIopsNotAvailableInAZFault (structure)](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
  + [ResourceNotFoundFault (structure)](api-faults.md#ResourceNotFoundFault)
  + [SNSInvalidTopicFault (structure)](api-faults.md#SNSInvalidTopicFault)
  + [SNSNoAuthorizationFault (structure)](api-faults.md#SNSNoAuthorizationFault)
  + [SNSTopicArnNotFoundFault (structure)](api-faults.md#SNSTopicArnNotFoundFault)
  + [SharedSnapshotQuotaExceededFault (structure)](api-faults.md#SharedSnapshotQuotaExceededFault)
  + [SnapshotQuotaExceededFault (structure)](api-faults.md#SnapshotQuotaExceededFault)
  + [SourceNotFoundFault (structure)](api-faults.md#SourceNotFoundFault)
  + [StorageQuotaExceededFault (structure)](api-faults.md#StorageQuotaExceededFault)
  + [StorageTypeNotSupportedFault (structure)](api-faults.md#StorageTypeNotSupportedFault)
  + [SubnetAlreadyInUse (structure)](api-faults.md#SubnetAlreadyInUse)
  + [SubscriptionAlreadyExistFault (structure)](api-faults.md#SubscriptionAlreadyExistFault)
  + [SubscriptionCategoryNotFoundFault (structure)](api-faults.md#SubscriptionCategoryNotFoundFault)
  + [SubscriptionNotFoundFault (structure)](api-faults.md#SubscriptionNotFoundFault)