AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Neptune 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.

Inheritance Hierarchy

Amazon.Neptune.IAmazonNeptune

Namespace: Amazon.Neptune
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonNeptune
         IAmazonService, IDisposable

The IAmazonNeptune type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Neptune.Model.INeptunePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddRoleToDBCluster(AddRoleToDBClusterRequest)

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

Public Method AddRoleToDBClusterAsync(AddRoleToDBClusterRequest, CancellationToken)

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

Public Method AddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest)

Adds a source identifier to an existing event notification subscription.

Public Method AddSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest, CancellationToken)

Adds a source identifier to an existing event notification subscription.

Public Method AddTagsToResource(AddTagsToResourceRequest)

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.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken)

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.

Public Method ApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest)

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

Public Method ApplyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest, CancellationToken)

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

Public Method CopyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest)

Copies the specified DB cluster parameter group.

Public Method CopyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest, CancellationToken)

Copies the specified DB cluster parameter group.

Public Method CopyDBClusterSnapshot(CopyDBClusterSnapshotRequest)

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.

Public Method CopyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest, CancellationToken)

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.

Public Method CopyDBParameterGroup(CopyDBParameterGroupRequest)

Copies the specified DB parameter group.

Public Method CopyDBParameterGroupAsync(CopyDBParameterGroupRequest, CancellationToken)

Copies the specified DB parameter group.

Public Method CreateDBCluster(CreateDBClusterRequest)

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.

Public Method CreateDBClusterAsync(CreateDBClusterRequest, CancellationToken)

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.

Public Method CreateDBClusterEndpoint(CreateDBClusterEndpointRequest)

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

Public Method CreateDBClusterEndpointAsync(CreateDBClusterEndpointRequest, CancellationToken)

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

Public Method CreateDBClusterParameterGroup(CreateDBClusterParameterGroupRequest)

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. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. 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 Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Public Method CreateDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest, CancellationToken)

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. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. 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 Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Public Method CreateDBClusterSnapshot(CreateDBClusterSnapshotRequest)

Creates a snapshot of a DB cluster.

Public Method CreateDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest, CancellationToken)

Creates a snapshot of a DB cluster.

Public Method CreateDBInstance(CreateDBInstanceRequest)

Creates a new DB instance.

Public Method CreateDBInstanceAsync(CreateDBInstanceRequest, CancellationToken)

Creates a new DB instance.

Public Method CreateDBParameterGroup(CreateDBParameterGroupRequest)

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.

Public Method CreateDBParameterGroupAsync(CreateDBParameterGroupRequest, CancellationToken)

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.

Public Method CreateDBSubnetGroup(CreateDBSubnetGroupRequest)

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

Public Method CreateDBSubnetGroupAsync(CreateDBSubnetGroupRequest, CancellationToken)

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

Public Method CreateEventSubscription(CreateEventSubscriptionRequest)

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.

Public Method CreateEventSubscriptionAsync(CreateEventSubscriptionRequest, CancellationToken)

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.

Public Method DeleteDBCluster(DeleteDBClusterRequest)

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.

Public Method DeleteDBClusterAsync(DeleteDBClusterRequest, CancellationToken)

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.

Public Method DeleteDBClusterEndpoint(DeleteDBClusterEndpointRequest)

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

Public Method DeleteDBClusterEndpointAsync(DeleteDBClusterEndpointRequest, CancellationToken)

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

Public Method DeleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest)

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

Public Method DeleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest, CancellationToken)

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

Public Method DeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest)

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.

Public Method DeleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest, CancellationToken)

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.

Public Method DeleteDBInstance(DeleteDBInstanceRequest)

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.

Public Method DeleteDBInstanceAsync(DeleteDBInstanceRequest, CancellationToken)

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.

Public Method DeleteDBParameterGroup(DeleteDBParameterGroupRequest)

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

Public Method DeleteDBParameterGroupAsync(DeleteDBParameterGroupRequest, CancellationToken)

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

Public Method DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest)

Deletes a DB subnet group.

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

Public Method DeleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest, CancellationToken)

Deletes a DB subnet group.

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

Public Method DeleteEventSubscription(DeleteEventSubscriptionRequest)

Deletes an event notification subscription.

Public Method DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest, CancellationToken)

Deletes an event notification subscription.

Public Method DescribeDBClusterEndpoints(DescribeDBClusterEndpointsRequest)

Returns information about endpoints for an Amazon Neptune DB cluster.

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

Public Method DescribeDBClusterEndpointsAsync(DescribeDBClusterEndpointsRequest, CancellationToken)

Returns information about endpoints for an Amazon Neptune DB cluster.

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

Public Method DescribeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)

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.

Public Method DescribeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest, CancellationToken)

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.

Public Method DescribeDBClusterParameters(DescribeDBClusterParametersRequest)

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

Public Method DescribeDBClusterParametersAsync(DescribeDBClusterParametersRequest, CancellationToken)

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

Public Method DescribeDBClusters(DescribeDBClustersRequest)

Returns information about provisioned DB clusters, and supports pagination.

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

Public Method DescribeDBClustersAsync(DescribeDBClustersRequest, CancellationToken)

Returns information about provisioned DB clusters, and supports pagination.

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

Public Method DescribeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest)

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 API action.

Public Method DescribeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest, CancellationToken)

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 API action.

Public Method DescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)

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

Public Method DescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest, CancellationToken)

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

Public Method DescribeDBEngineVersions(DescribeDBEngineVersionsRequest)

Returns a list of the available DB engines.

Public Method DescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest, CancellationToken)

Returns a list of the available DB engines.

Public Method DescribeDBInstances(DescribeDBInstancesRequest)

Returns information about provisioned instances, and supports pagination.

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

Public Method DescribeDBInstancesAsync(DescribeDBInstancesRequest, CancellationToken)

Returns information about provisioned instances, and supports pagination.

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

Public Method DescribeDBParameterGroups(DescribeDBParameterGroupsRequest)

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

Public Method DescribeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest, CancellationToken)

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

Public Method DescribeDBParameters(DescribeDBParametersRequest)

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

Public Method DescribeDBParametersAsync(DescribeDBParametersRequest, CancellationToken)

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

Public Method DescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest)

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 Wikipedia Tutorial.

Public Method DescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest, CancellationToken)

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 Wikipedia Tutorial.

Public Method DescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest)

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

Public Method DescribeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest, CancellationToken)

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

Public Method DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest)

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

Public Method DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest, CancellationToken)

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

Public Method DescribeEventCategories(DescribeEventCategoriesRequest)

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

Public Method DescribeEventCategoriesAsync(DescribeEventCategoriesRequest, CancellationToken)

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

Public Method DescribeEvents(DescribeEventsRequest)

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.

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

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.

Public Method DescribeEventSubscriptions(DescribeEventSubscriptionsRequest)

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.

Public Method DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest, CancellationToken)

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.

Public Method DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest)

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

Public Method DescribeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest, CancellationToken)

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

Public Method DescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)

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

Public Method DescribePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest, CancellationToken)

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

Public Method DescribeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest)

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

Public Method DescribeValidDBInstanceModificationsAsync(DescribeValidDBInstanceModificationsRequest, CancellationToken)

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

Public Method FailoverDBCluster(FailoverDBClusterRequest)

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.

Public Method FailoverDBClusterAsync(FailoverDBClusterRequest, CancellationToken)

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.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags on an Amazon Neptune resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists all tags on an Amazon Neptune resource.

Public Method ModifyDBCluster(ModifyDBClusterRequest)

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.

Public Method ModifyDBClusterAsync(ModifyDBClusterRequest, CancellationToken)

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.

Public Method ModifyDBClusterEndpoint(ModifyDBClusterEndpointRequest)

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

Public Method ModifyDBClusterEndpointAsync(ModifyDBClusterEndpointRequest, CancellationToken)

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

Public Method ModifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest)

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 command to verify that your DB cluster parameter group has been created or modified.

Public Method ModifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest, CancellationToken)

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 command to verify that your DB cluster parameter group has been created or modified.

Public Method ModifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest)

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 API action.

Public Method ModifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest, CancellationToken)

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 API action.

Public Method ModifyDBInstance(ModifyDBInstanceRequest)

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 before you call ModifyDBInstance.

Public Method ModifyDBInstanceAsync(ModifyDBInstanceRequest, CancellationToken)

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 before you call ModifyDBInstance.

Public Method ModifyDBParameterGroup(ModifyDBParameterGroupRequest)

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.

Public Method ModifyDBParameterGroupAsync(ModifyDBParameterGroupRequest, CancellationToken)

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.

Public Method ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest)

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

Public Method ModifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest, CancellationToken)

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

Public Method ModifyEventSubscription(ModifyEventSubscriptionRequest)

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 and RemoveSourceIdentifierFromSubscription calls.

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

Public Method ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest, CancellationToken)

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 and RemoveSourceIdentifierFromSubscription calls.

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

Public Method PromoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest)

Not supported.

Public Method PromoteReadReplicaDBClusterAsync(PromoteReadReplicaDBClusterRequest, CancellationToken)

Not supported.

Public Method RebootDBInstance(RebootDBInstanceRequest)

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.

Public Method RebootDBInstanceAsync(RebootDBInstanceRequest, CancellationToken)

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.

Public Method RemoveRoleFromDBCluster(RemoveRoleFromDBClusterRequest)

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

Public Method RemoveRoleFromDBClusterAsync(RemoveRoleFromDBClusterRequest, CancellationToken)

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

Public Method RemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest)

Removes a source identifier from an existing event notification subscription.

Public Method RemoveSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest, CancellationToken)

Removes a source identifier from an existing event notification subscription.

Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest)

Removes metadata tags from an Amazon Neptune resource.

Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken)

Removes metadata tags from an Amazon Neptune resource.

Public Method ResetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest)

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 request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

Public Method ResetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest, CancellationToken)

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 request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

Public Method ResetDBParameterGroup(ResetDBParameterGroupRequest)

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.

Public Method ResetDBParameterGroupAsync(ResetDBParameterGroupRequest, CancellationToken)

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.

Public Method RestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest)

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.

Public Method RestoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest, CancellationToken)

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.

Public Method RestoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest)

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 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.

Public Method RestoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest, CancellationToken)

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 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.

Public Method StartDBCluster(StartDBClusterRequest)

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

Public Method StartDBClusterAsync(StartDBClusterRequest, CancellationToken)

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

Public Method StopDBCluster(StopDBClusterRequest)

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.

Public Method StopDBClusterAsync(StopDBClusterRequest, CancellationToken)

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5