integrations.sh
← all integrations

amazonaws.com – neptune

OpenAPI apis-guru cloud

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.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:neptune/2014-10-31.json
Provider
amazonaws.com:neptune / neptune
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/neptune/2014-10-31/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/neptune/2014-10-31/openapi.yaml

Tools (140)

Extracted live via the executor SDK.

  • actionAddRoleToDbCluster.getAddRoleToDbCluster

    Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.

  • actionAddRoleToDbCluster.postAddRoleToDbCluster

    Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.

  • actionAddSourceIdentifierToSubscription.getAddSourceIdentifierToSubscription

    Adds a source identifier to an existing event notification subscription.

  • actionAddSourceIdentifierToSubscription.postAddSourceIdentifierToSubscription

    Adds a source identifier to an existing event notification subscription.

  • actionAddTagsToResource.getAddTagsToResource

    Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

  • actionAddTagsToResource.postAddTagsToResource

    Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

  • actionApplyPendingMaintenanceAction.getApplyPendingMaintenanceAction

    Applies a pending maintenance action to a resource (for example, to a DB instance).

  • actionApplyPendingMaintenanceAction.postApplyPendingMaintenanceAction

    Applies a pending maintenance action to a resource (for example, to a DB instance).

  • actionCopyDbClusterParameterGroup.getCopyDbClusterParameterGroup

    Copies the specified DB cluster parameter group.

  • actionCopyDbClusterParameterGroup.postCopyDbClusterParameterGroup

    Copies the specified DB cluster parameter group.

  • actionCopyDbClusterSnapshot.getCopyDbClusterSnapshot

    Copies a snapshot of a DB cluster.

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

  • actionCopyDbClusterSnapshot.postCopyDbClusterSnapshot

    Copies a snapshot of a DB cluster.

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

  • actionCopyDbParameterGroup.getCopyDbParameterGroup

    Copies the specified DB parameter group.

  • actionCopyDbParameterGroup.postCopyDbParameterGroup

    Copies the specified DB parameter group.

  • actionCreateDbCluster.getCreateDbCluster

    Creates a new Amazon Neptune DB cluster.

    You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

    Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

  • actionCreateDbCluster.postCreateDbCluster

    Creates a new Amazon Neptune DB cluster.

    You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

    Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

  • actionCreateDbClusterEndpoint.getCreateDbClusterEndpoint

    Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

  • actionCreateDbClusterEndpoint.postCreateDbClusterEndpoint

    Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

  • actionCreateDbClusterParameterGroup.getCreateDbClusterParameterGroup

    Creates a new DB cluster parameter group.

    Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

    A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup [blocked]. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster [blocked]. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters [blocked] command to verify that your DB cluster parameter group has been created or modified.

  • actionCreateDbClusterParameterGroup.postCreateDbClusterParameterGroup

    Creates a new DB cluster parameter group.

    Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

    A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup [blocked]. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster [blocked]. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the or the DescribeDBClusterParameters [blocked] command to verify that your DB cluster parameter group has been created or modified.

  • actionCreateDbClusterSnapshot.getCreateDbClusterSnapshot

    Creates a snapshot of a DB cluster.

  • actionCreateDbClusterSnapshot.postCreateDbClusterSnapshot

    Creates a snapshot of a DB cluster.

  • actionCreateDbInstance.getCreateDbInstance

    Creates a new DB instance.

  • actionCreateDbInstance.postCreateDbInstance

    Creates a new DB instance.

  • actionCreateDbParameterGroup.getCreateDbParameterGroup

    Creates a new DB parameter group.

    A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionCreateDbParameterGroup.postCreateDbParameterGroup

    Creates a new DB parameter group.

    A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionCreateDbSubnetGroup.getCreateDbSubnetGroup

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

  • actionCreateDbSubnetGroup.postCreateDbSubnetGroup

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

  • actionCreateEventSubscription.getCreateEventSubscription

    Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

  • actionCreateEventSubscription.postCreateEventSubscription

    Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

  • actionCreateGlobalCluster.getCreateGlobalCluster

    Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

    You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

  • actionCreateGlobalCluster.postCreateGlobalCluster

    Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

    You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

  • actionDeleteDbCluster.getDeleteDbCluster

    The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

    Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

  • actionDeleteDbCluster.postDeleteDbCluster

    The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

    Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

  • actionDeleteDbClusterEndpoint.getDeleteDbClusterEndpoint

    Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

  • actionDeleteDbClusterEndpoint.postDeleteDbClusterEndpoint

    Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

  • actionDeleteDbClusterParameterGroup.getDeleteDbClusterParameterGroup

    Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

  • actionDeleteDbClusterParameterGroup.postDeleteDbClusterParameterGroup

    Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

  • actionDeleteDbClusterSnapshot.getDeleteDbClusterSnapshot

    Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

    The DB cluster snapshot must be in the available state to be deleted.

  • actionDeleteDbClusterSnapshot.postDeleteDbClusterSnapshot

    Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

    The DB cluster snapshot must be in the available state to be deleted.

  • actionDeleteDbInstance.getDeleteDbInstance

    The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

    You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

  • actionDeleteDbInstance.postDeleteDbInstance

    The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

    You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

  • actionDeleteDbParameterGroup.getDeleteDbParameterGroup

    Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

  • actionDeleteDbParameterGroup.postDeleteDbParameterGroup

    Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

  • actionDeleteDbSubnetGroup.getDeleteDbSubnetGroup

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances.

  • actionDeleteDbSubnetGroup.postDeleteDbSubnetGroup

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances.

  • actionDeleteEventSubscription.getDeleteEventSubscription

    Deletes an event notification subscription.

  • actionDeleteEventSubscription.postDeleteEventSubscription

    Deletes an event notification subscription.

  • actionDeleteGlobalCluster.getDeleteGlobalCluster

    Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.

  • actionDeleteGlobalCluster.postDeleteGlobalCluster

    Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.

  • actionDescribeDbClusterEndpoints.getDescribeDbClusterEndpoints

    Returns information about endpoints for an Amazon Neptune DB cluster.

    This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

  • actionDescribeDbClusterEndpoints.postDescribeDbClusterEndpoints

    Returns information about endpoints for an Amazon Neptune DB cluster.

    This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

  • actionDescribeDbClusterParameterGroups.getDescribeDbClusterParameterGroups

    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

  • actionDescribeDbClusterParameterGroups.postDescribeDbClusterParameterGroups

    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

  • actionDescribeDbClusterParameters.getDescribeDbClusterParameters

    Returns the detailed parameter list for a particular DB cluster parameter group.

  • actionDescribeDbClusterParameters.postDescribeDbClusterParameters

    Returns the detailed parameter list for a particular DB cluster parameter group.

  • actionDescribeDbClusters.getDescribeDbClusters

    Returns information about provisioned DB clusters, and supports pagination.

    This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

  • actionDescribeDbClusters.postDescribeDbClusters

    Returns information about provisioned DB clusters, and supports pagination.

    This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

  • actionDescribeDbClusterSnapshotAttributes.getDescribeDbClusterSnapshotAttributes

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.

    To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute [blocked] API action.

  • actionDescribeDbClusterSnapshotAttributes.postDescribeDbClusterSnapshotAttributes

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts.

    To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute [blocked] API action.

  • actionDescribeDbClusterSnapshots.getDescribeDbClusterSnapshots

    Returns information about DB cluster snapshots. This API action supports pagination.

  • actionDescribeDbClusterSnapshots.postDescribeDbClusterSnapshots

    Returns information about DB cluster snapshots. This API action supports pagination.

  • actionDescribeDbEngineVersions.getDescribeDbEngineVersions

    Returns a list of the available DB engines.

  • actionDescribeDbEngineVersions.postDescribeDbEngineVersions

    Returns a list of the available DB engines.

  • actionDescribeDbInstances.getDescribeDbInstances

    Returns information about provisioned instances, and supports pagination.

    This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

  • actionDescribeDbInstances.postDescribeDbInstances

    Returns information about provisioned instances, and supports pagination.

    This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

  • actionDescribeDbParameterGroups.getDescribeDbParameterGroups

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

  • actionDescribeDbParameterGroups.postDescribeDbParameterGroups

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

  • actionDescribeDbParameters.getDescribeDbParameters

    Returns the detailed parameter list for a particular DB parameter group.

  • actionDescribeDbParameters.postDescribeDbParameters

    Returns the detailed parameter list for a particular DB parameter group.

  • actionDescribeDbSubnetGroups.getDescribeDbSubnetGroups

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the .

  • actionDescribeDbSubnetGroups.postDescribeDbSubnetGroups

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the .

  • actionDescribeEngineDefaultClusterParameters.getDescribeEngineDefaultClusterParameters

    Returns the default engine and system parameter information for the cluster database engine.

  • actionDescribeEngineDefaultClusterParameters.postDescribeEngineDefaultClusterParameters

    Returns the default engine and system parameter information for the cluster database engine.

  • actionDescribeEngineDefaultParameters.getDescribeEngineDefaultParameters

    Returns the default engine and system parameter information for the specified database engine.

  • actionDescribeEngineDefaultParameters.postDescribeEngineDefaultParameters

    Returns the default engine and system parameter information for the specified database engine.

  • actionDescribeEventCategories.getDescribeEventCategories

    Displays a list of categories for all event source types, or, if specified, for a specified source type.

  • actionDescribeEventCategories.postDescribeEventCategories

    Displays a list of categories for all event source types, or, if specified, for a specified source type.

  • actionDescribeEvents.getDescribeEvents

    Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

  • actionDescribeEvents.postDescribeEvents

    Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

  • actionDescribeEventSubscriptions.getDescribeEventSubscriptions

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

  • actionDescribeEventSubscriptions.postDescribeEventSubscriptions

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

  • actionDescribeGlobalClusters.getDescribeGlobalClusters

    Returns information about Neptune global database clusters. This API supports pagination.

  • actionDescribeGlobalClusters.postDescribeGlobalClusters

    Returns information about Neptune global database clusters. This API supports pagination.

  • actionDescribeOrderableDbInstanceOptions.getDescribeOrderableDbInstanceOptions

    Returns a list of orderable DB instance options for the specified engine.

  • actionDescribeOrderableDbInstanceOptions.postDescribeOrderableDbInstanceOptions

    Returns a list of orderable DB instance options for the specified engine.

  • actionDescribePendingMaintenanceActions.getDescribePendingMaintenanceActions

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

  • actionDescribePendingMaintenanceActions.postDescribePendingMaintenanceActions

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

  • actionDescribeValidDbInstanceModifications.getDescribeValidDbInstanceModifications

    You can call DescribeValidDBInstanceModifications [blocked] to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance [blocked].

  • actionDescribeValidDbInstanceModifications.postDescribeValidDbInstanceModifications

    You can call DescribeValidDBInstanceModifications [blocked] to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance [blocked].

  • actionFailoverDbCluster.getFailoverDbCluster

    Forces a failover for a DB cluster.

    A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

    Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

  • actionFailoverDbCluster.postFailoverDbCluster

    Forces a failover for a DB cluster.

    A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

    Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

  • actionFailoverGlobalCluster.getFailoverGlobalCluster

    Initiates the failover process for a Neptune global database.

    A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

    This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

  • actionFailoverGlobalCluster.postFailoverGlobalCluster

    Initiates the failover process for a Neptune global database.

    A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

    This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

  • actionListTagsForResource.getListTagsForResource

    Lists all tags on an Amazon Neptune resource.

  • actionListTagsForResource.postListTagsForResource

    Lists all tags on an Amazon Neptune resource.

  • actionModifyDbCluster.getModifyDbCluster

    Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

  • actionModifyDbCluster.postModifyDbCluster

    Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

  • actionModifyDbClusterEndpoint.getModifyDbClusterEndpoint

    Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

  • actionModifyDbClusterEndpoint.postModifyDbClusterEndpoint

    Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

  • actionModifyDbClusterParameterGroup.getModifyDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters [blocked] command to verify that your DB cluster parameter group has been created or modified.

  • actionModifyDbClusterParameterGroup.postModifyDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters [blocked] command to verify that your DB cluster parameter group has been created or modified.

  • actionModifyDbClusterSnapshotAttribute.getModifyDbClusterSnapshotAttribute

    Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

    To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes [blocked] API action.

  • actionModifyDbClusterSnapshotAttribute.postModifyDbClusterSnapshotAttribute

    Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

    To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes [blocked] API action.

  • actionModifyDbInstance.getModifyDbInstance

    Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications [blocked] before you call ModifyDBInstance [blocked].

  • actionModifyDbInstance.postModifyDbInstance

    Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications [blocked] before you call ModifyDBInstance [blocked].

  • actionModifyDbParameterGroup.getModifyDbParameterGroup

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionModifyDbParameterGroup.postModifyDbParameterGroup

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

  • actionModifyDbSubnetGroup.getModifyDbSubnetGroup

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

  • actionModifyDbSubnetGroup.postModifyDbSubnetGroup

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

  • actionModifyEventSubscription.getModifyEventSubscription

    Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription [blocked] and RemoveSourceIdentifierFromSubscription [blocked] calls.

    You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

  • actionModifyEventSubscription.postModifyEventSubscription

    Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription [blocked] and RemoveSourceIdentifierFromSubscription [blocked] calls.

    You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

  • actionModifyGlobalCluster.getModifyGlobalCluster

    Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.

  • actionModifyGlobalCluster.postModifyGlobalCluster

    Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.

  • actionPromoteReadReplicaDbCluster.getPromoteReadReplicaDbCluster

    Not supported.

  • actionPromoteReadReplicaDbCluster.postPromoteReadReplicaDbCluster

    Not supported.

  • actionRebootDbInstance.getRebootDbInstance

    You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

    Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

  • actionRebootDbInstance.postRebootDbInstance

    You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

    Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

  • actionRemoveFromGlobalCluster.getRemoveFromGlobalCluster

    Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.

  • actionRemoveFromGlobalCluster.postRemoveFromGlobalCluster

    Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.

  • actionRemoveRoleFromDbCluster.getRemoveRoleFromDbCluster

    Disassociates an Identity and Access Management (IAM) role from a DB cluster.

  • actionRemoveRoleFromDbCluster.postRemoveRoleFromDbCluster

    Disassociates an Identity and Access Management (IAM) role from a DB cluster.

  • actionRemoveSourceIdentifierFromSubscription.getRemoveSourceIdentifierFromSubscription

    Removes a source identifier from an existing event notification subscription.

  • actionRemoveSourceIdentifierFromSubscription.postRemoveSourceIdentifierFromSubscription

    Removes a source identifier from an existing event notification subscription.

  • actionRemoveTagsFromResource.getRemoveTagsFromResource

    Removes metadata tags from an Amazon Neptune resource.

  • actionRemoveTagsFromResource.postRemoveTagsFromResource

    Removes metadata tags from an Amazon Neptune resource.

  • actionResetDbClusterParameterGroup.getResetDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

    When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance [blocked] request. You must call RebootDBInstance [blocked] for every DB instance in your DB cluster that you want the updated static parameter to apply to.

  • actionResetDbClusterParameterGroup.postResetDbClusterParameterGroup

    Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

    When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance [blocked] request. You must call RebootDBInstance [blocked] for every DB instance in your DB cluster that you want the updated static parameter to apply to.

  • actionResetDbParameterGroup.getResetDbParameterGroup

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

  • actionResetDbParameterGroup.postResetDbParameterGroup

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

  • actionRestoreDbClusterFromSnapshot.getRestoreDbClusterFromSnapshot

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

    If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

  • actionRestoreDbClusterFromSnapshot.postRestoreDbClusterFromSnapshot

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

    If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

  • actionRestoreDbClusterToPointInTime.getRestoreDbClusterToPointInTime

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance [blocked] action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

  • actionRestoreDbClusterToPointInTime.postRestoreDbClusterToPointInTime

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance [blocked] action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

  • actionStartDbCluster.getStartDbCluster

    Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

  • actionStartDbCluster.postStartDbCluster

    Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

  • actionStopDbCluster.getStopDbCluster

    Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

    Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

  • actionStopDbCluster.postStopDbCluster

    Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

    Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools