com.amazonaws.services.neptune

Interface AmazonNeptune

All Known Subinterfaces:

AmazonNeptuneAsync

All Known Implementing Classes:

AbstractAmazonNeptune, AbstractAmazonNeptuneAsync, AmazonNeptuneAsyncClient, AmazonNeptuneClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonNeptune

Interface for accessing Amazon Neptune.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonNeptune instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddRoleToDBClusterResult	addRoleToDBCluster(AddRoleToDBClusterRequest addRoleToDBClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
EventSubscription	addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource.
ResourcePendingMaintenanceActions	applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).
DBClusterParameterGroup	copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest) Copies the specified DB cluster parameter group.
DBClusterSnapshot	copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) Copies a snapshot of a DB cluster.
DBParameterGroup	copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest) Copies the specified DB parameter group.
DBCluster	createDBCluster(CreateDBClusterRequest createDBClusterRequest) Creates a new Amazon Neptune DB cluster.
CreateDBClusterEndpointResult	createDBClusterEndpoint(CreateDBClusterEndpointRequest createDBClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
DBClusterParameterGroup	createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) Creates a new DB cluster parameter group.
DBClusterSnapshot	createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) Creates a snapshot of a DB cluster.
DBInstance	createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.
DBParameterGroup	createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest) Creates a new DB parameter group.
DBSubnetGroup	createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new DB subnet group.
EventSubscription	createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an event notification subscription.
DBCluster	deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.
DeleteDBClusterEndpointResult	deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest deleteDBClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
DeleteDBClusterParameterGroupResult	deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.
DBClusterSnapshot	deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) Deletes a DB cluster snapshot.
DBInstance	deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.
DeleteDBParameterGroupResult	deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) Deletes a specified DBParameterGroup.
DeleteDBSubnetGroupResult	deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.
EventSubscription	deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an event notification subscription.
DescribeDBClusterEndpointsResult	describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest describeDBClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.
DescribeDBClusterParameterGroupsResult	describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) Returns a list of DBClusterParameterGroup descriptions.
DescribeDBClusterParametersResult	describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
DescribeDBClustersResult	describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest) Returns information about provisioned DB clusters, and supports pagination.
DBClusterSnapshotAttributesResult	describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
DescribeDBClusterSnapshotsResult	describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) Returns information about DB cluster snapshots.
DescribeDBEngineVersionsResult	describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB engines.
DescribeDBInstancesResult	describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned instances, and supports pagination.
DescribeDBParameterGroupsResult	describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) Returns a list of DBParameterGroup descriptions.
DescribeDBParametersResult	describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) Returns the detailed parameter list for a particular DB parameter group.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.
EngineDefaults	describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
EngineDefaults	describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
DescribeEventCategoriesResult	describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.
DescribeEventSubscriptionsResult	describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.
DescribeOrderableDBInstanceOptionsResult	describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.
DescribePendingMaintenanceActionsResult	describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
ValidDBInstanceModificationsMessage	describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest describeValidDBInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.
DBCluster	failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest) Forces a failover for a DB cluster.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.
DBCluster	modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest) Modify a setting for a DB cluster.
ModifyDBClusterEndpointResult	modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest modifyDBClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
ModifyDBClusterParameterGroupResult	modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.
DBClusterSnapshotAttributesResult	modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
DBInstance	modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) Modifies settings for a DB instance.
ModifyDBParameterGroupResult	modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DB parameter group.
DBSubnetGroup	modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing DB subnet group.
EventSubscription	modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing event notification subscription.
DBCluster	promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest) Not supported.
DBInstance	rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.
RemoveRoleFromDBClusterResult	removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.
EventSubscription	removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.
ResetDBClusterParameterGroupResult	resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.
ResetDBParameterGroupResult	resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.
DBCluster	restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
DBCluster	restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
DBCluster	startDBCluster(StartDBClusterRequest 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.
DBCluster	stopDBCluster(StopDBClusterRequest stopDBClusterRequest) Stops an Amazon Neptune DB cluster.
AmazonNeptuneWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

addRoleToDBCluster

AddRoleToDBClusterResult addRoleToDBCluster(AddRoleToDBClusterRequest addRoleToDBClusterRequest)

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

Parameters:

addRoleToDBClusterRequest -

Returns:

Result of the AddRoleToDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

DBClusterRoleAlreadyExistsException - The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

DBClusterRoleQuotaExceededException - You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

See Also:

AWS API Documentation

addSourceIdentifierToSubscription

EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)

Adds a source identifier to an existing event notification subscription.

Parameters:

addSourceIdentifierToSubscriptionRequest -

Returns:

Result of the AddSourceIdentifierToSubscription operation returned by the service.

Throws:

SubscriptionNotFoundException - The designated subscription could not be found.

SourceNotFoundException - The source could not be found.

See Also:

AWS API Documentation

addTagsToResource

AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest 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.

Parameters:

addTagsToResourceRequest -

Returns:

Result of the AddTagsToResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

See Also:

AWS API Documentation

applyPendingMaintenanceAction

ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)

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

Parameters:

applyPendingMaintenanceActionRequest -

Returns:

Result of the ApplyPendingMaintenanceAction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource ID was not found.

See Also:

AWS API Documentation

copyDBClusterParameterGroup

DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)

Copies the specified DB cluster parameter group.

Parameters:

copyDBClusterParameterGroupRequest -

Returns:

Result of the CopyDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.

See Also:

AWS API Documentation

copyDBClusterSnapshot

DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest 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.

Parameters:

copyDBClusterSnapshotRequest -

Returns:

Result of the CopyDBClusterSnapshot operation returned by the service.

Throws:

DBClusterSnapshotAlreadyExistsException - User already has a DB cluster snapshot with the given identifier.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.

KMSKeyNotAccessibleException - Error accessing KMS key.

See Also:

AWS API Documentation

copyDBParameterGroup

DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)

Copies the specified DB parameter group.

Parameters:

copyDBParameterGroupRequest -

Returns:

Result of the CopyDBParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.

DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.

See Also:

AWS API Documentation

createDBCluster

DBCluster createDBCluster(CreateDBClusterRequest 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.

Parameters:

createDBClusterRequest -

Returns:

Result of the CreateDBCluster operation returned by the service.

Throws:

DBClusterAlreadyExistsException - User already has a DB cluster with the given identifier.

InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

DBClusterQuotaExceededException - User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it is in use.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

KMSKeyNotAccessibleException - Error accessing KMS key.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

See Also:

AWS API Documentation

createDBClusterEndpoint

CreateDBClusterEndpointResult createDBClusterEndpoint(CreateDBClusterEndpointRequest createDBClusterEndpointRequest)

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

Parameters:

createDBClusterEndpointRequest -

Returns:

Result of the CreateDBClusterEndpoint operation returned by the service.

Throws:

DBClusterEndpointQuotaExceededException - The cluster already has the maximum number of custom endpoints.

DBClusterEndpointAlreadyExistsException - The specified custom endpoint cannot be created because it already exists.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

createDBClusterParameterGroup

DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest 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.

Parameters:

createDBClusterParameterGroupRequest -

Returns:

Result of the CreateDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.

See Also:

AWS API Documentation

createDBClusterSnapshot

DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)

Creates a snapshot of a DB cluster.

Parameters:

createDBClusterSnapshotRequest -

Returns:

Result of the CreateDBClusterSnapshot operation returned by the service.

Throws:

DBClusterSnapshotAlreadyExistsException - User already has a DB cluster snapshot with the given identifier.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

See Also:

AWS API Documentation

createDBInstance

DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)

Creates a new DB instance.

Parameters:

createDBInstanceRequest -

Returns:

Result of the CreateDBInstance operation returned by the service.

Throws:

DBInstanceAlreadyExistsException - User already has a DB instance with the given identifier.

InsufficientDBInstanceCapacityException - Specified DB instance class is not available in the specified Availability Zone.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

DBSecurityGroupNotFoundException - DBSecurityGroupName does not refer to an existing DB security group.

InstanceQuotaExceededException - Request would result in user exceeding the allowed number of DB instances.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

ProvisionedIopsNotAvailableInAZException - Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundException - The designated option group could not be found.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

StorageTypeNotSupportedException - StorageType specified cannot be associated with the DB Instance.

AuthorizationNotFoundException - Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

Neptune may not also be authorized via IAM to perform necessary actions on your behalf.

KMSKeyNotAccessibleException - Error accessing KMS key.

DomainNotFoundException - Domain does not refer to an existing Active Directory Domain.

See Also:

AWS API Documentation

createDBParameterGroup

DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest 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.

Parameters:

createDBParameterGroupRequest -

Returns:

Result of the CreateDBParameterGroup operation returned by the service.

Throws:

DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.

See Also:

AWS API Documentation

createDBSubnetGroup

DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest 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.

Parameters:

createDBSubnetGroupRequest -

Returns:

Result of the CreateDBSubnetGroup operation returned by the service.

Throws:

DBSubnetGroupAlreadyExistsException - DBSubnetGroupName is already used by an existing DB subnet group.

DBSubnetGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB subnet groups.

DBSubnetQuotaExceededException - Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

See Also:

AWS API Documentation

createEventSubscription

EventSubscription createEventSubscription(CreateEventSubscriptionRequest 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.

Parameters:

createEventSubscriptionRequest -

Returns:

Result of the CreateEventSubscription operation returned by the service.

Throws:

EventSubscriptionQuotaExceededException - You have exceeded the number of events you can subscribe to.

SubscriptionAlreadyExistException - This subscription already exists.

SNSInvalidTopicException - The SNS topic is invalid.

SNSNoAuthorizationException - There is no SNS authorization.

SNSTopicArnNotFoundException - The ARN of the SNS topic could not be found.

SubscriptionCategoryNotFoundException - The designated subscription category could not be found.

SourceNotFoundException - The source could not be found.

See Also:

AWS API Documentation

deleteDBCluster

DBCluster deleteDBCluster(DeleteDBClusterRequest 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.

Parameters:

deleteDBClusterRequest -

Returns:

Result of the DeleteDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

DBClusterSnapshotAlreadyExistsException - User already has a DB cluster snapshot with the given identifier.

SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

See Also:

AWS API Documentation

deleteDBClusterEndpoint

DeleteDBClusterEndpointResult deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest deleteDBClusterEndpointRequest)

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

Parameters:

deleteDBClusterEndpointRequest -

Returns:

Result of the DeleteDBClusterEndpoint operation returned by the service.

Throws:

InvalidDBClusterEndpointStateException - The requested operation cannot be performed on the endpoint while the endpoint is in this state.

DBClusterEndpointNotFoundException - The specified custom endpoint doesn't exist.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

See Also:

AWS API Documentation

deleteDBClusterParameterGroup

DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)

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

Parameters:

deleteDBClusterParameterGroupRequest -

Returns:

Result of the DeleteDBClusterParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

deleteDBClusterSnapshot

DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest 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.

Parameters:

deleteDBClusterSnapshotRequest -

Returns:

Result of the DeleteDBClusterSnapshot operation returned by the service.

Throws:

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

See Also:

AWS API Documentation

deleteDBInstance

DBInstance deleteDBInstance(DeleteDBInstanceRequest 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.

Parameters:

deleteDBInstanceRequest -

Returns:

Result of the DeleteDBInstance operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already used by an existing snapshot.

SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

See Also:

AWS API Documentation

deleteDBParameterGroup

DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)

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

Parameters:

deleteDBParameterGroupRequest -

Returns:

Result of the DeleteDBParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

deleteDBSubnetGroup

DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)

Deletes a DB subnet group.

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

Parameters:

deleteDBSubnetGroupRequest -

Returns:

Result of the DeleteDBSubnetGroup operation returned by the service.

Throws:

InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it is in use.

InvalidDBSubnetStateException - The DB subnet is not in the available state.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

See Also:

AWS API Documentation

deleteEventSubscription

EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)

Deletes an event notification subscription.

Parameters:

deleteEventSubscriptionRequest -

Returns:

Result of the DeleteEventSubscription operation returned by the service.

Throws:

SubscriptionNotFoundException - The designated subscription could not be found.

InvalidEventSubscriptionStateException - The event subscription is in an invalid state.

See Also:

AWS API Documentation

describeDBClusterEndpoints

DescribeDBClusterEndpointsResult describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest 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.

Parameters:

describeDBClusterEndpointsRequest -

Returns:

Result of the DescribeDBClusterEndpoints operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

See Also:

AWS API Documentation

describeDBClusterParameterGroups

DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest 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.

Parameters:

describeDBClusterParameterGroupsRequest -

Returns:

Result of the DescribeDBClusterParameterGroups operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

describeDBClusterParameters

DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)

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

Parameters:

describeDBClusterParametersRequest -

Returns:

Result of the DescribeDBClusterParameters operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

describeDBClusterSnapshotAttributes

DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest 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.

Parameters:

describeDBClusterSnapshotAttributesRequest -

Returns:

Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

See Also:

AWS API Documentation

describeDBClusterSnapshots

DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)

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

Parameters:

describeDBClusterSnapshotsRequest -

Returns:

Result of the DescribeDBClusterSnapshots operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

See Also:

AWS API Documentation

describeDBClusters

DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)

Returns information about provisioned DB clusters, and supports pagination.

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

Parameters:

describeDBClustersRequest -

Returns:

Result of the DescribeDBClusters operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

See Also:

AWS API Documentation

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)

Returns a list of the available DB engines.

Parameters:

describeDBEngineVersionsRequest -

Returns:

Result of the DescribeDBEngineVersions operation returned by the service.

See Also:

AWS API Documentation

describeDBInstances

DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)

Returns information about provisioned instances, and supports pagination.

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

Parameters:

describeDBInstancesRequest -

Returns:

Result of the DescribeDBInstances operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

See Also:

AWS API Documentation

describeDBParameterGroups

DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest 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.

Parameters:

describeDBParameterGroupsRequest -

Returns:

Result of the DescribeDBParameterGroups operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

describeDBParameters

DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)

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

Parameters:

describeDBParametersRequest -

Returns:

Result of the DescribeDBParameters operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest 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.

Parameters:

describeDBSubnetGroupsRequest -

Returns:

Result of the DescribeDBSubnetGroups operation returned by the service.

Throws:

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

See Also:

AWS API Documentation

describeEngineDefaultClusterParameters

EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)

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

Parameters:

describeEngineDefaultClusterParametersRequest -

Returns:

Result of the DescribeEngineDefaultClusterParameters operation returned by the service.

See Also:

AWS API Documentation

describeEngineDefaultParameters

EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)

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

Parameters:

describeEngineDefaultParametersRequest -

Returns:

Result of the DescribeEngineDefaultParameters operation returned by the service.

See Also:

AWS API Documentation

describeEventCategories

DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)

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

Parameters:

describeEventCategoriesRequest -

Returns:

Result of the DescribeEventCategories operation returned by the service.

See Also:

AWS API Documentation

describeEventSubscriptions

DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest 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.

Parameters:

describeEventSubscriptionsRequest -

Returns:

Result of the DescribeEventSubscriptions operation returned by the service.

Throws:

SubscriptionNotFoundException - The designated subscription could not be found.

See Also:

AWS API Documentation

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest 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.

Parameters:

describeEventsRequest -

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeOrderableDBInstanceOptions

DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)

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

Parameters:

describeOrderableDBInstanceOptionsRequest -

Returns:

Result of the DescribeOrderableDBInstanceOptions operation returned by the service.

See Also:

AWS API Documentation

describePendingMaintenanceActions

DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)

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

Parameters:

describePendingMaintenanceActionsRequest -

Returns:

Result of the DescribePendingMaintenanceActions operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource ID was not found.

See Also:

AWS API Documentation

describeValidDBInstanceModifications

ValidDBInstanceModificationsMessage describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest 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.

Parameters:

describeValidDBInstanceModificationsRequest -

Returns:

Result of the DescribeValidDBInstanceModifications operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

failoverDBCluster

DBCluster failoverDBCluster(FailoverDBClusterRequest 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.

Parameters:

failoverDBClusterRequest -

Returns:

Result of the FailoverDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on an Amazon Neptune resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

See Also:

AWS API Documentation

modifyDBCluster

DBCluster modifyDBCluster(ModifyDBClusterRequest 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.

Parameters:

modifyDBClusterRequest -

Returns:

Result of the ModifyDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it is in use.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

InvalidDBSecurityGroupStateException - The state of the DB security group does not allow deletion.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

DBClusterAlreadyExistsException - User already has a DB cluster with the given identifier.

See Also:

AWS API Documentation

modifyDBClusterEndpoint

ModifyDBClusterEndpointResult modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest modifyDBClusterEndpointRequest)

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

Parameters:

modifyDBClusterEndpointRequest -

Returns:

Result of the ModifyDBClusterEndpoint operation returned by the service.

Throws:

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBClusterEndpointStateException - The requested operation cannot be performed on the endpoint while the endpoint is in this state.

DBClusterEndpointNotFoundException - The specified custom endpoint doesn't exist.

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

modifyDBClusterParameterGroup

ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest 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.

Parameters:

modifyDBClusterParameterGroupRequest -

Returns:

Result of the ModifyDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

See Also:

AWS API Documentation

modifyDBClusterSnapshotAttribute

DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest 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.

Parameters:

modifyDBClusterSnapshotAttributeRequest -

Returns:

Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

See Also:

AWS API Documentation

modifyDBInstance

DBInstance modifyDBInstance(ModifyDBInstanceRequest 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.

Parameters:

modifyDBInstanceRequest -

Returns:

Result of the ModifyDBInstance operation returned by the service.

Throws:

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

InvalidDBSecurityGroupStateException - The state of the DB security group does not allow deletion.

DBInstanceAlreadyExistsException - User already has a DB instance with the given identifier.

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

DBSecurityGroupNotFoundException - DBSecurityGroupName does not refer to an existing DB security group.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

InsufficientDBInstanceCapacityException - Specified DB instance class is not available in the specified Availability Zone.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

ProvisionedIopsNotAvailableInAZException - Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundException - The designated option group could not be found.

DBUpgradeDependencyFailureException - The DB upgrade failed because a resource the DB depends on could not be modified.

StorageTypeNotSupportedException - StorageType specified cannot be associated with the DB Instance.

AuthorizationNotFoundException - Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

Neptune may not also be authorized via IAM to perform necessary actions on your behalf.

CertificateNotFoundException - CertificateIdentifier does not refer to an existing certificate.

DomainNotFoundException - Domain does not refer to an existing Active Directory Domain.

See Also:

AWS API Documentation

modifyDBParameterGroup

ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest 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.

Parameters:

modifyDBParameterGroupRequest -

Returns:

Result of the ModifyDBParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

See Also:

AWS API Documentation

modifyDBSubnetGroup

DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest 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.

Parameters:

modifyDBSubnetGroupRequest -

Returns:

Result of the ModifyDBSubnetGroup operation returned by the service.

Throws:

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

DBSubnetQuotaExceededException - Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

SubnetAlreadyInUseException - The DB subnet is already in use in the Availability Zone.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

See Also:

AWS API Documentation

modifyEventSubscription

EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest 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.

Parameters:

modifyEventSubscriptionRequest -

Returns:

Result of the ModifyEventSubscription operation returned by the service.

Throws:

EventSubscriptionQuotaExceededException - You have exceeded the number of events you can subscribe to.

SubscriptionNotFoundException - The designated subscription could not be found.

SNSInvalidTopicException - The SNS topic is invalid.

SNSNoAuthorizationException - There is no SNS authorization.

SNSTopicArnNotFoundException - The ARN of the SNS topic could not be found.

SubscriptionCategoryNotFoundException - The designated subscription category could not be found.

See Also:

AWS API Documentation

promoteReadReplicaDBCluster

DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest)

Not supported.

Parameters:

promoteReadReplicaDBClusterRequest -

Returns:

Result of the PromoteReadReplicaDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

See Also:

AWS API Documentation

rebootDBInstance

DBInstance rebootDBInstance(RebootDBInstanceRequest 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.

Parameters:

rebootDBInstanceRequest -

Returns:

Result of the RebootDBInstance operation returned by the service.

Throws:

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

See Also:

AWS API Documentation

removeRoleFromDBCluster

RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest)

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

Parameters:

removeRoleFromDBClusterRequest -

Returns:

Result of the RemoveRoleFromDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

DBClusterRoleNotFoundException - The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

See Also:

AWS API Documentation

removeSourceIdentifierFromSubscription

EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)

Removes a source identifier from an existing event notification subscription.

Parameters:

removeSourceIdentifierFromSubscriptionRequest -

Returns:

Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.

Throws:

SubscriptionNotFoundException - The designated subscription could not be found.

SourceNotFoundException - The source could not be found.

See Also:

AWS API Documentation

removeTagsFromResource

RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes metadata tags from an Amazon Neptune resource.

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

See Also:

AWS API Documentation

resetDBClusterParameterGroup

ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest 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.

Parameters:

resetDBClusterParameterGroupRequest -

Returns:

Result of the ResetDBClusterParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

resetDBParameterGroup

ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest 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.

Parameters:

resetDBParameterGroupRequest -

Returns:

Result of the ResetDBParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.

See Also:

AWS API Documentation

restoreDBClusterFromSnapshot

DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest 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.

Parameters:

restoreDBClusterFromSnapshotRequest -

Returns:

Result of the RestoreDBClusterFromSnapshot operation returned by the service.

Throws:

DBClusterAlreadyExistsException - User already has a DB cluster with the given identifier.

DBClusterQuotaExceededException - User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

InsufficientDBClusterCapacityException - The DB cluster does not have enough capacity for the current operation.

InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

InvalidDBSnapshotStateException - The state of the DB snapshot does not allow deletion.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

InvalidRestoreException - Cannot restore from vpc backup to non-vpc DB instance.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

OptionGroupNotFoundException - The designated option group could not be found.

KMSKeyNotAccessibleException - Error accessing KMS key.

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

See Also:

AWS API Documentation

restoreDBClusterToPointInTime

DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest 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.

Parameters:

restoreDBClusterToPointInTimeRequest -

Returns:

Result of the RestoreDBClusterToPointInTime operation returned by the service.

Throws:

DBClusterAlreadyExistsException - User already has a DB cluster with the given identifier.

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

DBClusterQuotaExceededException - User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

DBSubnetGroupNotFoundException - DBSubnetGroupName does not refer to an existing DB subnet group.

InsufficientDBClusterCapacityException - The DB cluster does not have enough capacity for the current operation.

InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBSnapshotStateException - The state of the DB snapshot does not allow deletion.

InvalidRestoreException - Cannot restore from vpc backup to non-vpc DB instance.

InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidVPCNetworkStateException - DB subnet group does not cover all Availability Zones after it is created because users' change.

KMSKeyNotAccessibleException - Error accessing KMS key.

OptionGroupNotFoundException - The designated option group could not be found.

StorageQuotaExceededException - Request would result in user exceeding the allowed amount of storage available across all DB instances.

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

See Also:

AWS API Documentation

startDBCluster

DBCluster startDBCluster(StartDBClusterRequest 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.

Parameters:

startDBClusterRequest -

Returns:

Result of the StartDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

stopDBCluster

DBCluster stopDBCluster(StopDBClusterRequest 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.

Parameters:

stopDBClusterRequest -

Returns:

Result of the StopDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.

InvalidDBClusterStateException - The DB cluster is not in a valid state.

InvalidDBInstanceStateException - The specified DB instance is not in the available state.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AmazonNeptuneWaiters waiters()