

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Referência da API de gerenciamento do Amazon Neptune
<a name="api"></a>

Este capítulo documenta as APIs do Neptune que você pode usar para gerenciar e manter o cluster de banco de dados do Neptune.

O Neptune opera em clusters de servidores de banco de dados conectados em uma topologia de replicação. Assim, gerenciar o Neptune normalmente envolve implantar alterações em vários servidores e garantir que todas as réplicas do Neptune estejam acompanhando o servidor primário.

Como o Neptune dimensiona o armazenamento subjacente de forma transparente à medida que os dados crescem, gerenciar o Neptune exige relativamente pouco gerenciamento de armazenamento em disco. Da mesma forma, como o Neptune realiza backups contínuos automaticamente, um cluster do Neptune não exige planejamento extensivo nem tempo de inatividade para realizar backups. 

**Contents**
+ [API de clusters de banco de dados do Neptune](api-clusters.md)
  + [CreateDBCluster (ação)](api-clusters.md#CreateDBCluster)
  + [DeleteDBCluster (ação)](api-clusters.md#DeleteDBCluster)
  + [ModifyDBCluster (ação)](api-clusters.md#ModifyDBCluster)
  + [StartDBCluster (ação)](api-clusters.md#StartDBCluster)
  + [StopDBCluster (ação)](api-clusters.md#StopDBCluster)
  + [AddRoleToDBCluster (ação)](api-clusters.md#AddRoleToDBCluster)
  + [RemoveRoleFromDBCluster (ação)](api-clusters.md#RemoveRoleFromDBCluster)
  + [FailoverDBCluster (ação)](api-clusters.md#FailoverDBCluster)
  + [PromoteReadReplicaDBCluster (ação)](api-clusters.md#PromoteReadReplicaDBCluster)
  + [DescribeDBClusters (ação)](api-clusters.md#DescribeDBClusters)
  + [*Estruturas:*](api-clusters.md#api-clusters-structures-spacer)
  + [DBCluster (estrutura)](api-clusters.md#DBCluster)
  + [DBClusterMember (estrutura)](api-clusters.md#DBClusterMember)
  + [DBClusterRole (estrutura)](api-clusters.md#DBClusterRole)
  + [CloudwatchLogsExportConfiguration (estrutura)](api-clusters.md#CloudwatchLogsExportConfiguration)
  + [PendingCloudwatchLogsExports (estrutura)](api-clusters.md#PendingCloudwatchLogsExports)
  + [ClusterPendingModifiedValues (estrutura)](api-clusters.md#ClusterPendingModifiedValues)
+ [API de banco de dados global do Neptune](api-global-dbs.md)
  + [CreateGlobalCluster (ação)](api-global-dbs.md#CreateGlobalCluster)
  + [DeleteGlobalCluster (ação)](api-global-dbs.md#DeleteGlobalCluster)
  + [ModifyGlobalCluster (ação)](api-global-dbs.md#ModifyGlobalCluster)
  + [DescribeGlobalClusters (ação)](api-global-dbs.md#DescribeGlobalClusters)
  + [FailoverGlobalCluster (ação)](api-global-dbs.md#FailoverGlobalCluster)
  + [RemoveFromGlobalCluster (ação)](api-global-dbs.md#RemoveFromGlobalCluster)
  + [*Estruturas:*](api-global-dbs.md#api-global-dbs-structures-spacer)
  + [GlobalCluster (estrutura)](api-global-dbs.md#GlobalCluster)
  + [GlobalClusterMember (estrutura)](api-global-dbs.md#GlobalClusterMember)
+ [API de instâncias do Neptune](api-instances.md)
  + [CreateDBInstance (ação)](api-instances.md#CreateDBInstance)
  + [DeleteDBInstance (ação)](api-instances.md#DeleteDBInstance)
  + [ModifyDBInstance (ação)](api-instances.md#ModifyDBInstance)
  + [RebootDBInstance (ação)](api-instances.md#RebootDBInstance)
  + [DescribeDBInstances (ação)](api-instances.md#DescribeDBInstances)
  + [DescribeOrderableDBInstanceOptions (ação)](api-instances.md#DescribeOrderableDBInstanceOptions)
  + [DescribeValidDBInstanceModifications (ação)](api-instances.md#DescribeValidDBInstanceModifications)
  + [*Estruturas:*](api-instances.md#api-instances-structures-spacer)
  + [DBInstance (estrutura)](api-instances.md#DBInstance)
  + [DBInstanceStatusInfo (estrutura)](api-instances.md#DBInstanceStatusInfo)
  + [OrderableDBInstanceOption (estrutura)](api-instances.md#OrderableDBInstanceOption)
  + [PendingModifiedValues (estrutura)](api-instances.md#PendingModifiedValues)
  + [ValidStorageOptions (estrutura)](api-instances.md#ValidStorageOptions)
  + [ValidDBInstanceModificationsMessage (estrutura)](api-instances.md#ValidDBInstanceModificationsMessage)
+ [API de parâmetros do Neptune](api-parameters.md)
  + [CopyDBParameterGroup (ação)](api-parameters.md#CopyDBParameterGroup)
  + [CopyDBClusterParameterGroup (ação)](api-parameters.md#CopyDBClusterParameterGroup)
  + [CreateDBParameterGroup (ação)](api-parameters.md#CreateDBParameterGroup)
  + [CreateDBClusterParameterGroup (ação)](api-parameters.md#CreateDBClusterParameterGroup)
  + [DeleteDBParameterGroup (ação)](api-parameters.md#DeleteDBParameterGroup)
  + [DeleteDBClusterParameterGroup (ação)](api-parameters.md#DeleteDBClusterParameterGroup)
  + [ModifyDBParameterGroup (ação)](api-parameters.md#ModifyDBParameterGroup)
  + [ModifyDBClusterParameterGroup (ação)](api-parameters.md#ModifyDBClusterParameterGroup)
  + [ResetDBParameterGroup (ação)](api-parameters.md#ResetDBParameterGroup)
  + [ResetDBClusterParameterGroup (ação)](api-parameters.md#ResetDBClusterParameterGroup)
  + [DescribeDBParameters (ação)](api-parameters.md#DescribeDBParameters)
  + [DescribeDBParameterGroups (ação)](api-parameters.md#DescribeDBParameterGroups)
  + [DescribeDBClusterParameters (ação)](api-parameters.md#DescribeDBClusterParameters)
  + [DescribeDBClusterParameterGroups (ação)](api-parameters.md#DescribeDBClusterParameterGroups)
  + [DescribeEngineDefaultParameters (ação)](api-parameters.md#DescribeEngineDefaultParameters)
  + [DescribeEngineDefaultClusterParameters (ação)](api-parameters.md#DescribeEngineDefaultClusterParameters)
  + [*Estruturas:*](api-parameters.md#api-parameters-structures-spacer)
  + [Parâmetro (estrutura)](api-parameters.md#Parameter)
  + [DBParameterGroup (estrutura)](api-parameters.md#DBParameterGroup)
  + [DBClusterParameterGroup (estrutura)](api-parameters.md#DBClusterParameterGroup)
  + [DBParameterGroupStatus (estrutura)](api-parameters.md#DBParameterGroupStatus)
+ [API da sub-rede do Neptune](api-subnets.md)
  + [CreateDBSubnetGroup (ação)](api-subnets.md#CreateDBSubnetGroup)
  + [DeleteDBSubnetGroup (ação)](api-subnets.md#DeleteDBSubnetGroup)
  + [ModifyDBSubnetGroup (ação)](api-subnets.md#ModifyDBSubnetGroup)
  + [DescribeDBSubnetGroups (ação)](api-subnets.md#DescribeDBSubnetGroups)
  + [*Estruturas:*](api-subnets.md#api-subnets-structures-spacer)
  + [Sub-rede (estrutura)](api-subnets.md#Subnet)
  + [DBSubnetGroup (estrutura)](api-subnets.md#DBSubnetGroup)
+ [API de snapshots do Neptune](api-snapshots.md)
  + [CreateDBClusterSnapshot (ação)](api-snapshots.md#CreateDBClusterSnapshot)
  + [DeleteDBClusterSnapshot (ação)](api-snapshots.md#DeleteDBClusterSnapshot)
  + [CopyDBClusterSnapshot (ação)](api-snapshots.md#CopyDBClusterSnapshot)
  + [ModifyDBClusterSnapshotAttribute (ação)](api-snapshots.md#ModifyDBClusterSnapshotAttribute)
  + [RestoreDBClusterFromSnapshot (ação)](api-snapshots.md#RestoreDBClusterFromSnapshot)
  + [RestoreDBClusterToPointInTime (ação)](api-snapshots.md#RestoreDBClusterToPointInTime)
  + [DescribeDBClusterSnapshots (ação)](api-snapshots.md#DescribeDBClusterSnapshots)
  + [DescribeDBClusterSnapshotAttributes (ação)](api-snapshots.md#DescribeDBClusterSnapshotAttributes)
  + [*Estruturas:*](api-snapshots.md#api-snapshots-structures-spacer)
  + [DBClusterSnapshot (estrutura)](api-snapshots.md#DBClusterSnapshot)
  + [DBClusterSnapshotAttribute (estrutura)](api-snapshots.md#DBClusterSnapshotAttribute)
  + [DBClusterSnapshotAttributesResult (estrutura)](api-snapshots.md#DBClusterSnapshotAttributesResult)
+ [API de eventos do Neptune](api-events.md)
  + [CreateEventSubscription (ação)](api-events.md#CreateEventSubscription)
  + [DeleteEventSubscription (ação)](api-events.md#DeleteEventSubscription)
  + [ModifyEventSubscription (ação)](api-events.md#ModifyEventSubscription)
  + [DescribeEventSubscriptions (ação)](api-events.md#DescribeEventSubscriptions)
  + [AddSourceIdentifierToSubscription (ação)](api-events.md#AddSourceIdentifierToSubscription)
  + [RemoveSourceIdentifierFromSubscription (ação)](api-events.md#RemoveSourceIdentifierFromSubscription)
  + [DescribeEvents (ação)](api-events.md#DescribeEvents)
  + [DescribeEventCategories (ação)](api-events.md#DescribeEventCategories)
  + [*Estruturas:*](api-events.md#api-events-structures-spacer)
  + [Evento (estrutura)](api-events.md#Event)
  + [EventCategoriesMap (estrutura)](api-events.md#EventCategoriesMap)
  + [EventSubscription (estrutura)](api-events.md#EventSubscription)
+ [Outras APIs do Neptune](api-other-apis.md)
  + [AddTagsToResource (ação)](api-other-apis.md#AddTagsToResource)
  + [ListTagsForResource (ação)](api-other-apis.md#ListTagsForResource)
  + [RemoveTagsFromResource (ação)](api-other-apis.md#RemoveTagsFromResource)
  + [ApplyPendingMaintenanceAction (ação)](api-other-apis.md#ApplyPendingMaintenanceAction)
  + [DescribePendingMaintenanceActions (ação)](api-other-apis.md#DescribePendingMaintenanceActions)
  + [DescribeDBEngineVersions (ação)](api-other-apis.md#DescribeDBEngineVersions)
  + [*Estruturas:*](api-other-apis.md#api-other-apis-structures-spacer)
  + [DBEngineVersion (estrutura)](api-other-apis.md#DBEngineVersion)
  + [EngineDefaults (estrutura)](api-other-apis.md#EngineDefaults)
  + [PendingMaintenanceAction (estrutura)](api-other-apis.md#PendingMaintenanceAction)
  + [ResourcePendingMaintenanceActions (estrutura)](api-other-apis.md#ResourcePendingMaintenanceActions)
  + [UpgradeTarget (estrutura)](api-other-apis.md#UpgradeTarget)
  + [Tag (estrutura)](api-other-apis.md#Tag)
+ [Tipos de dados comuns do Neptune](api-datatypes.md)
  + [AvailabilityZone (estrutura)](api-datatypes.md#AvailabilityZone)
  + [DBSecurityGroupMembership (estrutura)](api-datatypes.md#DBSecurityGroupMembership)
  + [DomainMembership (estrutura)](api-datatypes.md#DomainMembership)
  + [DoubleRange (estrutura)](api-datatypes.md#DoubleRange)
  + [Endpoint (estrutura)](api-datatypes.md#Endpoint)
  + [Filtro (estrutura)](api-datatypes.md#Filter)
  + [Intervalo (estrutura)](api-datatypes.md#Range)
  + [ServerlessV2ScalingConfiguration (estrutura)](api-datatypes.md#ServerlessV2ScalingConfiguration)
  + [ServerlessV2ScalingConfigurationInfo (estrutura)](api-datatypes.md#ServerlessV2ScalingConfigurationInfo)
  + [Fuso horário (estrutura)](api-datatypes.md#Timezone)
  + [VpcSecurityGroupMembership (estrutura)](api-datatypes.md#VpcSecurityGroupMembership)
+ [Exceções do Neptune específicas de APIs individuais](api-faults.md)
  + [AuthorizationAlreadyExistsFault (estrutura)](api-faults.md#AuthorizationAlreadyExistsFault)
  + [AuthorizationNotFoundFault (estrutura)](api-faults.md#AuthorizationNotFoundFault)
  + [AuthorizationQuotaExceededFault (estrutura)](api-faults.md#AuthorizationQuotaExceededFault)
  + [CertificateNotFoundFault (estrutura)](api-faults.md#CertificateNotFoundFault)
  + [DBClusterAlreadyExistsFault (estrutura)](api-faults.md#DBClusterAlreadyExistsFault)
  + [DBClusterNotFoundFault (estrutura)](api-faults.md#DBClusterNotFoundFault)
  + [DBClusterParameterGroupNotFoundFault (estrutura)](api-faults.md#DBClusterParameterGroupNotFoundFault)
  + [DBClusterQuotaExceededFault (estrutura)](api-faults.md#DBClusterQuotaExceededFault)
  + [DBClusterRoleAlreadyExistsFault (estrutura)](api-faults.md#DBClusterRoleAlreadyExistsFault)
  + [DBClusterRoleNotFoundFault (estrutura)](api-faults.md#DBClusterRoleNotFoundFault)
  + [DBClusterRoleQuotaExceededFault (estrutura)](api-faults.md#DBClusterRoleQuotaExceededFault)
  + [DBClusterSnapshotAlreadyExistsFault (estrutura)](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
  + [DBClusterSnapshotNotFoundFault (estrutura)](api-faults.md#DBClusterSnapshotNotFoundFault)
  + [DBInstanceAlreadyExistsFault (estrutura)](api-faults.md#DBInstanceAlreadyExistsFault)
  + [DBInstanceNotFoundFault (estrutura)](api-faults.md#DBInstanceNotFoundFault)
  + [DBLogFileNotFoundFault (estrutura)](api-faults.md#DBLogFileNotFoundFault)
  + [DBParameterGroupAlreadyExistsFault (estrutura)](api-faults.md#DBParameterGroupAlreadyExistsFault)
  + [DBParameterGroupNotFoundFault (estrutura)](api-faults.md#DBParameterGroupNotFoundFault)
  + [DBParameterGroupQuotaExceededFault (estrutura)](api-faults.md#DBParameterGroupQuotaExceededFault)
  + [DBSecurityGroupAlreadyExistsFault (estrutura)](api-faults.md#DBSecurityGroupAlreadyExistsFault)
  + [DBSecurityGroupNotFoundFault (estrutura)](api-faults.md#DBSecurityGroupNotFoundFault)
  + [DBSecurityGroupNotSupportedFault (estrutura)](api-faults.md#DBSecurityGroupNotSupportedFault)
  + [DBSecurityGroupQuotaExceededFault (estrutura)](api-faults.md#DBSecurityGroupQuotaExceededFault)
  + [DBSnapshotAlreadyExistsFault (estrutura)](api-faults.md#DBSnapshotAlreadyExistsFault)
  + [DBSnapshotNotFoundFault (estrutura)](api-faults.md#DBSnapshotNotFoundFault)
  + [DBSubnetGroupAlreadyExistsFault (estrutura)](api-faults.md#DBSubnetGroupAlreadyExistsFault)
  + [DBSubnetGroupDoesNotCoverEnoughAZs (estrutura)](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
  + [DBSubnetGroupNotAllowedFault (estrutura)](api-faults.md#DBSubnetGroupNotAllowedFault)
  + [DBSubnetGroupNotFoundFault (estrutura)](api-faults.md#DBSubnetGroupNotFoundFault)
  + [DBSubnetGroupQuotaExceededFault (estrutura)](api-faults.md#DBSubnetGroupQuotaExceededFault)
  + [DBSubnetQuotaExceededFault (estrutura)](api-faults.md#DBSubnetQuotaExceededFault)
  + [DBUpgradeDependencyFailureFault (estrutura)](api-faults.md#DBUpgradeDependencyFailureFault)
  + [DomainNotFoundFault (estrutura)](api-faults.md#DomainNotFoundFault)
  + [EventSubscriptionQuotaExceededFault (estrutura)](api-faults.md#EventSubscriptionQuotaExceededFault)
  + [GlobalClusterAlreadyExistsFault (estrutura)](api-faults.md#GlobalClusterAlreadyExistsFault)
  + [GlobalClusterNotFoundFault (estrutura)](api-faults.md#GlobalClusterNotFoundFault)
  + [GlobalClusterQuotaExceededFault (estrutura)](api-faults.md#GlobalClusterQuotaExceededFault)
  + [InstanceQuotaExceededFault (estrutura)](api-faults.md#InstanceQuotaExceededFault)
  + [InsufficientDBClusterCapacityFault (estrutura)](api-faults.md#InsufficientDBClusterCapacityFault)
  + [InsufficientDBInstanceCapacityFault (estrutura)](api-faults.md#InsufficientDBInstanceCapacityFault)
  + [InsufficientStorageClusterCapacityFault (estrutura)](api-faults.md#InsufficientStorageClusterCapacityFault)
  + [InvalidDBClusterEndpointStateFault (estrutura)](api-faults.md#InvalidDBClusterEndpointStateFault)
  + [InvalidDBClusterSnapshotStateFault (estrutura)](api-faults.md#InvalidDBClusterSnapshotStateFault)
  + [InvalidDBClusterStateFault (estrutura)](api-faults.md#InvalidDBClusterStateFault)
  + [InvalidDBInstanceStateFault (estrutura)](api-faults.md#InvalidDBInstanceStateFault)
  + [InvalidDBParameterGroupStateFault (estrutura)](api-faults.md#InvalidDBParameterGroupStateFault)
  + [InvalidDBSecurityGroupStateFault (estrutura)](api-faults.md#InvalidDBSecurityGroupStateFault)
  + [InvalidDBSnapshotStateFault (estrutura)](api-faults.md#InvalidDBSnapshotStateFault)
  + [InvalidDBSubnetGroupFault (estrutura)](api-faults.md#InvalidDBSubnetGroupFault)
  + [InvalidDBSubnetGroupStateFault (estrutura)](api-faults.md#InvalidDBSubnetGroupStateFault)
  + [InvalidDBSubnetStateFault (estrutura)](api-faults.md#InvalidDBSubnetStateFault)
  + [InvalidEventSubscriptionStateFault (estrutura)](api-faults.md#InvalidEventSubscriptionStateFault)
  + [InvalidGlobalClusterStateFault (estrutura)](api-faults.md#InvalidGlobalClusterStateFault)
  + [InvalidOptionGroupStateFault (estrutura)](api-faults.md#InvalidOptionGroupStateFault)
  + [InvalidRestoreFault (estrutura)](api-faults.md#InvalidRestoreFault)
  + [InvalidSubnet (estrutura)](api-faults.md#InvalidSubnet)
  + [InvalidVPCNetworkStateFault (estrutura)](api-faults.md#InvalidVPCNetworkStateFault)
  + [KMSKeyNotAccessibleFault (estrutura)](api-faults.md#KMSKeyNotAccessibleFault)
  + [OptionGroupNotFoundFault (estrutura)](api-faults.md#OptionGroupNotFoundFault)
  + [PointInTimeRestoreNotEnabledFault (estrutura)](api-faults.md#PointInTimeRestoreNotEnabledFault)
  + [ProvisionedIopsNotAvailableInAZFault (estrutura)](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
  + [ResourceNotFoundFault (estrutura)](api-faults.md#ResourceNotFoundFault)
  + [SNSInvalidTopicFault (estrutura)](api-faults.md#SNSInvalidTopicFault)
  + [SNSNoAuthorizationFault (estrutura)](api-faults.md#SNSNoAuthorizationFault)
  + [SNSTopicArnNotFoundFault (estrutura)](api-faults.md#SNSTopicArnNotFoundFault)
  + [SharedSnapshotQuotaExceededFault (estrutura)](api-faults.md#SharedSnapshotQuotaExceededFault)
  + [SnapshotQuotaExceededFault (estrutura)](api-faults.md#SnapshotQuotaExceededFault)
  + [SourceNotFoundFault (estrutura)](api-faults.md#SourceNotFoundFault)
  + [StorageQuotaExceededFault (estrutura)](api-faults.md#StorageQuotaExceededFault)
  + [StorageTypeNotSupportedFault (estrutura)](api-faults.md#StorageTypeNotSupportedFault)
  + [SubnetAlreadyInUse (estrutura)](api-faults.md#SubnetAlreadyInUse)
  + [SubscriptionAlreadyExistFault (estrutura)](api-faults.md#SubscriptionAlreadyExistFault)
  + [SubscriptionCategoryNotFoundFault (estrutura)](api-faults.md#SubscriptionCategoryNotFoundFault)
  + [SubscriptionNotFoundFault (estrutura)](api-faults.md#SubscriptionNotFoundFault)