AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <NeptuneClient.h>
<fullname>Amazon Neptune</fullname>
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.
Definition at line 39 of file NeptuneClient.h.
Definition at line 42 of file NeptuneClient.h.
Definition at line 46 of file NeptuneClient.h.
Definition at line 47 of file NeptuneClient.h.
Aws::Neptune::NeptuneClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Neptune::NeptuneClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Neptune::NeptuneClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
nullptr
An Async wrapper for AddRoleToDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 125 of file NeptuneClient.h.
A Callable wrapper for AddRoleToDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 116 of file NeptuneClient.h.
Adds a source identifier to an existing event notification subscription.
nullptr
An Async wrapper for AddSourceIdentifierToSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 151 of file NeptuneClient.h.
A Callable wrapper for AddSourceIdentifierToSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 142 of file NeptuneClient.h.
nullptr
An Async wrapper for AddTagsToResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 179 of file NeptuneClient.h.
A Callable wrapper for AddTagsToResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 170 of file NeptuneClient.h.
Applies a pending maintenance action to a resource (for example, to a DB instance).
nullptr
An Async wrapper for ApplyPendingMaintenanceAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 205 of file NeptuneClient.h.
A Callable wrapper for ApplyPendingMaintenanceAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 196 of file NeptuneClient.h.
Converts any request object to a presigned URL with the GET method, using region for the signer and a timeout of 15 minutes.
nullptr
An Async wrapper for CopyDBClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 231 of file NeptuneClient.h.
A Callable wrapper for CopyDBClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 222 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for CopyDBClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 259 of file NeptuneClient.h.
A Callable wrapper for CopyDBClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 250 of file NeptuneClient.h.
nullptr
An Async wrapper for CopyDBParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 284 of file NeptuneClient.h.
A Callable wrapper for CopyDBParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 275 of file NeptuneClient.h.
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
.
nullptr
An Async wrapper for CreateDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 316 of file NeptuneClient.h.
A Callable wrapper for CreateDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 307 of file NeptuneClient.h.
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
nullptr
An Async wrapper for CreateDBClusterEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 342 of file NeptuneClient.h.
A Callable wrapper for CreateDBClusterEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 333 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for CreateDBClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 388 of file NeptuneClient.h.
A Callable wrapper for CreateDBClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 379 of file NeptuneClient.h.
nullptr
An Async wrapper for CreateDBClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 413 of file NeptuneClient.h.
A Callable wrapper for CreateDBClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 404 of file NeptuneClient.h.
nullptr
An Async wrapper for CreateDBInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 438 of file NeptuneClient.h.
A Callable wrapper for CreateDBInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 429 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for CreateDBParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 481 of file NeptuneClient.h.
A Callable wrapper for CreateDBParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 472 of file NeptuneClient.h.
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
nullptr
An Async wrapper for CreateDBSubnetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 507 of file NeptuneClient.h.
A Callable wrapper for CreateDBSubnetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 498 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for CreateEventSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 547 of file NeptuneClient.h.
A Callable wrapper for CreateEventSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 538 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for CreateGlobalCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 579 of file NeptuneClient.h.
A Callable wrapper for CreateGlobalCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 570 of file NeptuneClient.h.
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
.
nullptr
An Async wrapper for DeleteDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 610 of file NeptuneClient.h.
A Callable wrapper for DeleteDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 601 of file NeptuneClient.h.
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
nullptr
An Async wrapper for DeleteDBClusterEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 636 of file NeptuneClient.h.
A Callable wrapper for DeleteDBClusterEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 627 of file NeptuneClient.h.
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
nullptr
An Async wrapper for DeleteDBClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 663 of file NeptuneClient.h.
A Callable wrapper for DeleteDBClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 654 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for DeleteDBClusterSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 691 of file NeptuneClient.h.
A Callable wrapper for DeleteDBClusterSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 682 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for DeleteDBInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 729 of file NeptuneClient.h.
A Callable wrapper for DeleteDBInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 720 of file NeptuneClient.h.
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
nullptr
An Async wrapper for DeleteDBParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 755 of file NeptuneClient.h.
A Callable wrapper for DeleteDBParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 746 of file NeptuneClient.h.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
nullptr
An Async wrapper for DeleteDBSubnetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 782 of file NeptuneClient.h.
A Callable wrapper for DeleteDBSubnetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 773 of file NeptuneClient.h.
nullptr
An Async wrapper for DeleteEventSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 807 of file NeptuneClient.h.
A Callable wrapper for DeleteEventSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 798 of file NeptuneClient.h.
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
nullptr
An Async wrapper for DeleteGlobalCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 833 of file NeptuneClient.h.
A Callable wrapper for DeleteGlobalCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 824 of file NeptuneClient.h.
{}
)
const
Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
nullptr
,
{}
An Async wrapper for DescribeDBClusterEndpoints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 860 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBClusterEndpoints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 851 of file NeptuneClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeDBClusterParameterGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 888 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBClusterParameterGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 879 of file NeptuneClient.h.
Returns the detailed parameter list for a particular DB cluster parameter group.
nullptr
An Async wrapper for DescribeDBClusterParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 914 of file NeptuneClient.h.
A Callable wrapper for DescribeDBClusterParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 905 of file NeptuneClient.h.
{}
)
const
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
nullptr
,
{}
An Async wrapper for DescribeDBClusters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1003 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBClusters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 994 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for DescribeDBClusterSnapshotAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 950 of file NeptuneClient.h.
A Callable wrapper for DescribeDBClusterSnapshotAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 941 of file NeptuneClient.h.
{}
)
const
Returns information about DB cluster snapshots. This API action supports pagination.
nullptr
,
{}
An Async wrapper for DescribeDBClusterSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 976 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBClusterSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 967 of file NeptuneClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeDBEngineVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1028 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBEngineVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1019 of file NeptuneClient.h.
{}
)
const
Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
nullptr
,
{}
An Async wrapper for DescribeDBInstances that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1055 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBInstances that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1046 of file NeptuneClient.h.
{}
)
const
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
nullptr
,
{}
An Async wrapper for DescribeDBParameterGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1082 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBParameterGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1073 of file NeptuneClient.h.
Returns the detailed parameter list for a particular DB parameter group.
nullptr
An Async wrapper for DescribeDBParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1108 of file NeptuneClient.h.
A Callable wrapper for DescribeDBParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1099 of file NeptuneClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeDBSubnetGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1137 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeDBSubnetGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1128 of file NeptuneClient.h.
Returns the default engine and system parameter information for the cluster database engine.
nullptr
An Async wrapper for DescribeEngineDefaultClusterParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1163 of file NeptuneClient.h.
A Callable wrapper for DescribeEngineDefaultClusterParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1154 of file NeptuneClient.h.
Returns the default engine and system parameter information for the specified database engine.
nullptr
An Async wrapper for DescribeEngineDefaultParameters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1189 of file NeptuneClient.h.
A Callable wrapper for DescribeEngineDefaultParameters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1180 of file NeptuneClient.h.
{}
)
const
Displays a list of categories for all event source types, or, if specified, for a specified source type.
nullptr
,
{}
An Async wrapper for DescribeEventCategories that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1215 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeEventCategories that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1206 of file NeptuneClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1273 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1264 of file NeptuneClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeEventSubscriptions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1244 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeEventSubscriptions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1235 of file NeptuneClient.h.
{}
)
const
Returns information about Neptune global database clusters. This API supports pagination.
nullptr
,
{}
An Async wrapper for DescribeGlobalClusters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1299 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribeGlobalClusters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1290 of file NeptuneClient.h.
Returns a list of orderable DB instance options for the specified engine.
nullptr
An Async wrapper for DescribeOrderableDBInstanceOptions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1325 of file NeptuneClient.h.
A Callable wrapper for DescribeOrderableDBInstanceOptions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1316 of file NeptuneClient.h.
{}
)
const
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
nullptr
,
{}
An Async wrapper for DescribePendingMaintenanceActions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1351 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for DescribePendingMaintenanceActions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1342 of file NeptuneClient.h.
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
nullptr
An Async wrapper for DescribeValidDBInstanceModifications that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1378 of file NeptuneClient.h.
A Callable wrapper for DescribeValidDBInstanceModifications that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1369 of file NeptuneClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for FailoverDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1411 of file NeptuneClient.h.
{}
)
const
A Callable wrapper for FailoverDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1402 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for FailoverGlobalCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1446 of file NeptuneClient.h.
A Callable wrapper for FailoverGlobalCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1437 of file NeptuneClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1471 of file NeptuneClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1462 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1498 of file NeptuneClient.h.
A Callable wrapper for ModifyDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1489 of file NeptuneClient.h.
nullptr
An Async wrapper for ModifyDBClusterEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1524 of file NeptuneClient.h.
A Callable wrapper for ModifyDBClusterEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1515 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyDBClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1566 of file NeptuneClient.h.
A Callable wrapper for ModifyDBClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1557 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyDBClusterSnapshotAttribute that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1607 of file NeptuneClient.h.
A Callable wrapper for ModifyDBClusterSnapshotAttribute that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1598 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyDBInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1636 of file NeptuneClient.h.
A Callable wrapper for ModifyDBInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1627 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyDBParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1677 of file NeptuneClient.h.
A Callable wrapper for ModifyDBParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1668 of file NeptuneClient.h.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
nullptr
An Async wrapper for ModifyDBSubnetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1704 of file NeptuneClient.h.
A Callable wrapper for ModifyDBSubnetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1695 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyEventSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1734 of file NeptuneClient.h.
A Callable wrapper for ModifyEventSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1725 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ModifyGlobalCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1761 of file NeptuneClient.h.
A Callable wrapper for ModifyGlobalCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1752 of file NeptuneClient.h.
nullptr
An Async wrapper for PromoteReadReplicaDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1786 of file NeptuneClient.h.
A Callable wrapper for PromoteReadReplicaDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1777 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for RebootDBInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1817 of file NeptuneClient.h.
A Callable wrapper for RebootDBInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1808 of file NeptuneClient.h.
nullptr
An Async wrapper for RemoveFromGlobalCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1845 of file NeptuneClient.h.
A Callable wrapper for RemoveFromGlobalCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1836 of file NeptuneClient.h.
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
nullptr
An Async wrapper for RemoveRoleFromDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1871 of file NeptuneClient.h.
A Callable wrapper for RemoveRoleFromDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1862 of file NeptuneClient.h.
Removes a source identifier from an existing event notification subscription.
nullptr
An Async wrapper for RemoveSourceIdentifierFromSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1897 of file NeptuneClient.h.
A Callable wrapper for RemoveSourceIdentifierFromSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1888 of file NeptuneClient.h.
nullptr
An Async wrapper for RemoveTagsFromResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1923 of file NeptuneClient.h.
A Callable wrapper for RemoveTagsFromResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1914 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ResetDBClusterParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1957 of file NeptuneClient.h.
A Callable wrapper for ResetDBClusterParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1948 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for ResetDBParameterGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1989 of file NeptuneClient.h.
A Callable wrapper for ResetDBParameterGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1980 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for RestoreDBClusterFromSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2020 of file NeptuneClient.h.
A Callable wrapper for RestoreDBClusterFromSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2011 of file NeptuneClient.h.
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.
nullptr
An Async wrapper for RestoreDBClusterToPointInTime that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2056 of file NeptuneClient.h.
A Callable wrapper for RestoreDBClusterToPointInTime that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2047 of file NeptuneClient.h.
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
nullptr
An Async wrapper for StartDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2083 of file NeptuneClient.h.
A Callable wrapper for StartDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2074 of file NeptuneClient.h.
nullptr
An Async wrapper for StopDBCluster that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2111 of file NeptuneClient.h.
A Callable wrapper for StopDBCluster that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2102 of file NeptuneClient.h.
Definition at line 2118 of file NeptuneClient.h.