@Generated(value="software.amazon.awssdk:codegen") public interface NeptuneClient extends SdkClient
builder()
method.
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.
Amazon Neptune API Reference
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddRoleToDBClusterResponse |
addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
|
default AddRoleToDBClusterResponse |
addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest)
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon Neptune resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds metadata tags to an Amazon Neptune resource.
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
static NeptuneClientBuilder |
builder()
Create a builder that can be used to configure and create a
NeptuneClient . |
default CopyDbClusterParameterGroupResponse |
copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)
Copies the specified DB cluster parameter group.
|
default CopyDbClusterParameterGroupResponse |
copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest)
Copies the specified DB cluster parameter group.
|
default CopyDbClusterSnapshotResponse |
copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest)
Copies a snapshot of a DB cluster.
|
default CopyDbClusterSnapshotResponse |
copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
Copies a snapshot of a DB cluster.
|
default CopyDbParameterGroupResponse |
copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest)
Copies the specified DB parameter group.
|
default CopyDbParameterGroupResponse |
copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest)
Copies the specified DB parameter group.
|
static NeptuneClient |
create()
Create a
NeptuneClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateDbClusterResponse |
createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)
Creates a new Amazon Neptune DB cluster.
|
default CreateDbClusterResponse |
createDBCluster(CreateDbClusterRequest createDbClusterRequest)
Creates a new Amazon Neptune DB cluster.
|
default CreateDbClusterParameterGroupResponse |
createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)
Creates a new DB cluster parameter group.
|
default CreateDbClusterParameterGroupResponse |
createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
Creates a new DB cluster parameter group.
|
default CreateDbClusterSnapshotResponse |
createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest)
Creates a snapshot of a DB cluster.
|
default CreateDbClusterSnapshotResponse |
createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
Creates a snapshot of a DB cluster.
|
default CreateDbInstanceResponse |
createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
Creates a new DB instance.
|
default CreateDbInstanceResponse |
createDBInstance(CreateDbInstanceRequest createDbInstanceRequest)
Creates a new DB instance.
|
default CreateDbParameterGroupResponse |
createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)
Creates a new DB parameter group.
|
default CreateDbParameterGroupResponse |
createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)
Creates a new DB parameter group.
|
default CreateDbSubnetGroupResponse |
createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest)
Creates a new DB subnet group.
|
default CreateDbSubnetGroupResponse |
createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
Creates a new DB subnet group.
|
default CreateEventSubscriptionResponse |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an event notification subscription.
|
default CreateEventSubscriptionResponse |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an event notification subscription.
|
default DeleteDbClusterResponse |
deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
default DeleteDbClusterResponse |
deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
default DeleteDBClusterParameterGroupResponse |
deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group.
|
default DeleteDBClusterParameterGroupResponse |
deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group.
|
default DeleteDbClusterSnapshotResponse |
deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest)
Deletes a DB cluster snapshot.
|
default DeleteDbClusterSnapshotResponse |
deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
Deletes a DB cluster snapshot.
|
default DeleteDbInstanceResponse |
deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
default DeleteDbInstanceResponse |
deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
default DeleteDBParameterGroupResponse |
deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest)
Deletes a specified DBParameterGroup.
|
default DeleteDBParameterGroupResponse |
deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest)
Deletes a specified DBParameterGroup.
|
default DeleteDBSubnetGroupResponse |
deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest)
Deletes a DB subnet group.
|
default DeleteDBSubnetGroupResponse |
deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
Deletes a DB subnet group.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an event notification subscription.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an event notification subscription.
|
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDbClustersResponse |
describeDBClusters()
Returns information about provisioned DB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned DB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned DB clusters.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots()
Returns information about DB cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions()
Returns a list of the available DB engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator()
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available DB engines.
|
default DescribeDbInstancesResponse |
describeDBInstances()
Returns information about provisioned instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator()
Returns information about provisioned instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned instances.
|
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups()
Returns a list of
DBParameterGroup descriptions. |
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDbParameterGroupsResponse |
describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator()
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParameterGroupsIterable |
describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
default DescribeDbParametersResponse |
describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDbParametersResponse |
describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDBParametersIterable |
describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDBParametersIterable |
describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups()
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator()
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEventCategoriesResponse |
describeEventCategories()
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventsResponse |
describeEvents()
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions()
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator()
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions()
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribeValidDbInstanceModificationsResponse |
describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB
instance.
|
default DescribeValidDbInstanceModificationsResponse |
describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB
instance.
|
default FailoverDbClusterResponse |
failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest)
Forces a failover for a DB cluster.
|
default FailoverDbClusterResponse |
failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
Forces a failover for a DB cluster.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an Amazon Neptune resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon Neptune resource.
|
default ModifyDbClusterResponse |
modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)
Modify a setting for a DB cluster.
|
default ModifyDbClusterResponse |
modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
Modify a setting for a DB cluster.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group.
|
default ModifyDbClusterSnapshotAttributeResponse |
modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
default ModifyDbClusterSnapshotAttributeResponse |
modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
default ModifyDbInstanceResponse |
modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest)
Modifies settings for a DB instance.
|
default ModifyDbInstanceResponse |
modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)
Modifies settings for a DB instance.
|
default ModifyDbParameterGroupResponse |
modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest)
Modifies the parameters of a DB parameter group.
|
default ModifyDbParameterGroupResponse |
modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest)
Modifies the parameters of a DB parameter group.
|
default ModifyDbSubnetGroupResponse |
modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest)
Modifies an existing DB subnet group.
|
default ModifyDbSubnetGroupResponse |
modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
Modifies an existing DB subnet group.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing event notification subscription.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing event notification subscription.
|
default PromoteReadReplicaDbClusterResponse |
promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest)
Promotes a Read Replica DB cluster to a standalone DB cluster.
|
default PromoteReadReplicaDbClusterResponse |
promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest)
Promotes a Read Replica DB cluster to a standalone DB cluster.
|
default RebootDbInstanceResponse |
rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest)
You might need to reboot your DB instance, usually for maintenance reasons.
|
default RebootDbInstanceResponse |
rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
You might need to reboot your DB instance, usually for maintenance reasons.
|
default RemoveRoleFromDBClusterResponse |
removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest)
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
|
default RemoveRoleFromDBClusterResponse |
removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest)
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing event notification subscription.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing event notification subscription.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes metadata tags from an Amazon Neptune resource.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon Neptune resource.
|
default ResetDbClusterParameterGroupResponse |
resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value.
|
default ResetDbClusterParameterGroupResponse |
resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value.
|
default ResetDbParameterGroupResponse |
resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest)
Modifies the parameters of a DB parameter group to the engine/system default value.
|
default ResetDbParameterGroupResponse |
resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest)
Modifies the parameters of a DB parameter group to the engine/system default value.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static NeptuneClient create()
NeptuneClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static NeptuneClientBuilder builder()
NeptuneClient
.default AddRoleToDBClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
addRoleToDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddRoleToDBClusterResponse addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
This is a convenience which creates an instance of the AddRoleToDbClusterRequest.Builder
avoiding the
need to create one manually via AddRoleToDbClusterRequest.builder()
addRoleToDbClusterRequest
- A Consumer
that will call methods on AddRoleToDBClusterMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest
- SubscriptionNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Adds a source identifier to an existing event notification subscription.
This is a convenience which creates an instance of the AddSourceIdentifierToSubscriptionRequest.Builder
avoiding the need to create one manually via AddSourceIdentifierToSubscriptionRequest.builder()
addSourceIdentifierToSubscriptionRequest
- A Consumer
that will call methods on AddSourceIdentifierToSubscriptionMessage.Builder
to
create a request.SubscriptionNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
addTagsToResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Applies a pending maintenance action to a resource (for example, to a DB instance).
This is a convenience which creates an instance of the ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually via ApplyPendingMaintenanceActionRequest.builder()
applyPendingMaintenanceActionRequest
- A Consumer
that will call methods on ApplyPendingMaintenanceActionMessage.Builder
to
create a request.ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB cluster parameter group.
copyDbClusterParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB cluster parameter group.
This is a convenience which creates an instance of the CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CopyDbClusterParameterGroupRequest.builder()
copyDbClusterParameterGroupRequest
- A Consumer
that will call methods on CopyDBClusterParameterGroupMessage.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
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.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination AWS Region.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier
in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
copyDbClusterSnapshotRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
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.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination AWS Region.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier
in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
This is a convenience which creates an instance of the CopyDbClusterSnapshotRequest.Builder
avoiding the
need to create one manually via CopyDbClusterSnapshotRequest.builder()
copyDbClusterSnapshotRequest
- A Consumer
that will call methods on CopyDBClusterSnapshotMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB parameter group.
copyDbParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopyDbParameterGroupResponse copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
Copies the specified DB parameter group.
This is a convenience which creates an instance of the CopyDbParameterGroupRequest.Builder
avoiding the
need to create one manually via CopyDbParameterGroupRequest.builder()
copyDbParameterGroupRequest
- A Consumer
that will call methods on CopyDBParameterGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, AwsServiceException, SdkClientException, NeptuneException
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. For cross-region replication where the DB cluster identified by
ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
createDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, AwsServiceException, SdkClientException, NeptuneException
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. For cross-region replication where the DB cluster identified by
ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
This is a convenience which creates an instance of the CreateDbClusterRequest.Builder
avoiding the need
to create one manually via CreateDbClusterRequest.builder()
createDbClusterRequest
- A Consumer
that will call methods on CreateDBClusterMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
createDbClusterParameterGroupRequest
- DbParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CreateDbClusterParameterGroupRequest.builder()
createDbClusterParameterGroupRequest
- A Consumer
that will call methods on CreateDBClusterParameterGroupMessage.Builder
to
create a request.DbParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a snapshot of a DB cluster.
createDbClusterSnapshotRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
Creates a snapshot of a DB cluster.
This is a convenience which creates an instance of the CreateDbClusterSnapshotRequest.Builder
avoiding
the need to create one manually via CreateDbClusterSnapshotRequest.builder()
createDbClusterSnapshotRequest
- A Consumer
that will call methods on CreateDBClusterSnapshotMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB instance.
createDbInstanceRequest
- 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
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB instance.
This is a convenience which creates an instance of the CreateDbInstanceRequest.Builder
avoiding the need
to create one manually via CreateDbInstanceRequest.builder()
createDbInstanceRequest
- A Consumer
that will call methods on CreateDBInstanceMessage.Builder
to create a request.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
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbParameterGroupResponse createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
createDbParameterGroupRequest
- DbParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbParameterGroupResponse createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the CreateDbParameterGroupRequest.Builder
avoiding the
need to create one manually via CreateDbParameterGroupRequest.builder()
createDbParameterGroupRequest
- A Consumer
that will call methods on CreateDBParameterGroupMessage.Builder
to create a
request.DbParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DbParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
createDbSubnetGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
This is a convenience which creates an instance of the CreateDbSubnetGroupRequest.Builder
avoiding the
need to create one manually via CreateDbSubnetGroupRequest.builder()
createDbSubnetGroupRequest
- A Consumer
that will call methods on CreateDBSubnetGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
createEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
SubscriptionAlreadyExistException
SnsInvalidTopicException
SnsNoAuthorizationException
SnsTopicArnNotFoundException
SubscriptionCategoryNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the CreateEventSubscriptionRequest.Builder
avoiding
the need to create one manually via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest
- A Consumer
that will call methods on CreateEventSubscriptionMessage.Builder
to create a
request.EventSubscriptionQuotaExceededException
SubscriptionAlreadyExistException
SnsInvalidTopicException
SnsNoAuthorizationException
SnsTopicArnNotFoundException
SubscriptionCategoryNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
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.
deleteDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DeleteDbClusterRequest.Builder
avoiding the need
to create one manually via DeleteDbClusterRequest.builder()
deleteDbClusterRequest
- A Consumer
that will call methods on DeleteDBClusterMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
deleteDbClusterParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
This is a convenience which creates an instance of the DeleteDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via DeleteDbClusterParameterGroupRequest.builder()
deleteDbClusterParameterGroupRequest
- A Consumer
that will call methods on DeleteDBClusterParameterGroupMessage.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
deleteDbClusterSnapshotRequest
- InvalidDbClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DeleteDbClusterSnapshotRequest.Builder
avoiding
the need to create one manually via DeleteDbClusterSnapshotRequest.builder()
deleteDbClusterSnapshotRequest
- A Consumer
that will call methods on DeleteDBClusterSnapshotMessage.Builder
to create a
request.InvalidDbClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
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
.
If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a Read Replica of another DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the
DB cluster so it's no longer a Read Replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB cluster.
deleteDbInstanceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
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
.
If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a Read Replica of another DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the
DB cluster so it's no longer a Read Replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB cluster.
This is a convenience which creates an instance of the DeleteDbInstanceRequest.Builder
avoiding the need
to create one manually via DeleteDbInstanceRequest.builder()
deleteDbInstanceRequest
- A Consumer
that will call methods on DeleteDBInstanceMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBParameterGroupResponse deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
deleteDbParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBParameterGroupResponse deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
This is a convenience which creates an instance of the DeleteDbParameterGroupRequest.Builder
avoiding the
need to create one manually via DeleteDbParameterGroupRequest.builder()
deleteDbParameterGroupRequest
- A Consumer
that will call methods on DeleteDBParameterGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDbSubnetGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDBSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the DeleteDbSubnetGroupRequest.Builder
avoiding the
need to create one manually via DeleteDbSubnetGroupRequest.builder()
deleteDbSubnetGroupRequest
- A Consumer
that will call methods on DeleteDBSubnetGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes an event notification subscription.
deleteEventSubscriptionRequest
- SubscriptionNotFoundException
InvalidEventSubscriptionStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException
Deletes an event notification subscription.
This is a convenience which creates an instance of the DeleteEventSubscriptionRequest.Builder
avoiding
the need to create one manually via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest
- A Consumer
that will call methods on DeleteEventSubscriptionMessage.Builder
to create a
request.SubscriptionNotFoundException
InvalidEventSubscriptionStateException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest)
,
AWS API Documentationdefault DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
describeDbClusterParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBClusterParameterGroupsMessage.Builder
to
create a request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
describeDbClusterParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB cluster parameter group.
This is a convenience which creates an instance of the DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest
- A Consumer
that will call methods on DescribeDBClusterParametersMessage.Builder
to create
a request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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.
describeDbClusterSnapshotAttributesRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually via DescribeDbClusterSnapshotAttributesRequest.builder()
describeDbClusterSnapshotAttributesRequest
- A Consumer
that will call methods on DescribeDBClusterSnapshotAttributesMessage.Builder
to
create a request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest)
,
AWS API Documentationdefault DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
describeDbClusterSnapshotsRequest
- DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about DB cluster snapshots. This API action supports pagination.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotsRequest.Builder
avoiding
the need to create one manually via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest
- A Consumer
that will call methods on DescribeDBClusterSnapshotsMessage.Builder
to create a
request.DbClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned DB clusters. This API supports pagination.
DbClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBClusters(DescribeDbClustersRequest)
,
AWS API
Documentationdefault DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned DB clusters. This API supports pagination.
describeDbClustersRequest
- DbClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned DB clusters. This API supports pagination.
This is a convenience which creates an instance of the DescribeDbClustersRequest.Builder
avoiding the
need to create one manually via DescribeDbClustersRequest.builder()
describeDbClustersRequest
- A Consumer
that will call methods on DescribeDBClustersMessage.Builder
to create a
request.DbClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBEngineVersions(DescribeDbEngineVersionsRequest)
,
AWS API Documentationdefault DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
describeDbEngineVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder
avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest
- A Consumer
that will call methods on DescribeDBEngineVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest)
,
AWS API Documentationdefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.
describeDbEngineVersionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of the available DB engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder
avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest
- A Consumer
that will call methods on DescribeDBEngineVersionsMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstances(DescribeDbInstancesRequest)
,
AWS
API Documentationdefault DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
describeDbInstancesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder
avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest
- A Consumer
that will call methods on DescribeDBInstancesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBInstancesPaginator(DescribeDbInstancesRequest)
,
AWS
API Documentationdefault DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
describeDbInstancesRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns information about provisioned instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder
avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest
- A Consumer
that will call methods on DescribeDBInstancesMessage.Builder
to create a
request.DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBParameterGroups(DescribeDbParameterGroupsRequest)
,
AWS API Documentationdefault DescribeDbParameterGroupsResponse describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
describeDbParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParameterGroupsResponse describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
This is a convenience which creates an instance of the DescribeDbParameterGroupsRequest.Builder
avoiding
the need to create one manually via DescribeDbParameterGroupsRequest.builder()
describeDbParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBParameterGroupsMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.
DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest)
,
AWS API Documentationdefault DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.
describeDbParameterGroupsRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbParameterGroupsRequest.Builder
avoiding
the need to create one manually via DescribeDbParameterGroupsRequest.builder()
describeDbParameterGroupsRequest
- A Consumer
that will call methods on DescribeDBParameterGroupsMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
describeDbParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbParametersResponse describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a convenience which creates an instance of the DescribeDbParametersRequest.Builder
avoiding the
need to create one manually via DescribeDbParametersRequest.builder()
describeDbParametersRequest
- A Consumer
that will call methods on DescribeDBParametersMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.
describeDbParametersRequest
- DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBParametersIterable describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns the detailed parameter list for a particular DB parameter group.
This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeDbParametersRequest.Builder
avoiding the
need to create one manually via DescribeDbParametersRequest.builder()
describeDbParametersRequest
- A Consumer
that will call methods on DescribeDBParametersMessage.Builder
to create a
request.DbParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest)
,
AWS
API Documentationdefault DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
describeDbSubnetGroupsRequest
- DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder
avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest
- A Consumer
that will call methods on DescribeDBSubnetGroupsMessage.Builder
to create a
request.DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.
DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest)
,
AWS
API Documentationdefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.
describeDbSubnetGroupsRequest
- DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder
avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest
- A Consumer
that will call methods on DescribeDBSubnetGroupsMessage.Builder
to create a
request.DbSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the cluster database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builder
avoiding the need to create one manually via
DescribeEngineDefaultClusterParametersRequest.builder()
describeEngineDefaultClusterParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultClusterParametersMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.
describeEngineDefaultParametersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns the default engine and system parameter information for the specified database engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest
- A Consumer
that will call methods on DescribeEngineDefaultParametersMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventCategories(DescribeEventCategoriesRequest)
,
AWS API Documentationdefault DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
This is a convenience which creates an instance of the DescribeEventCategoriesRequest.Builder
avoiding
the need to create one manually via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest
- A Consumer
that will call methods on DescribeEventCategoriesMessage.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptions(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.
SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest)
,
AWS API Documentationdefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- A Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
to create a
request.SubscriptionNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, NeptuneException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEvents(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
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.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventsPaginator(DescribeEventsRequest)
,
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.
describeEventsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException
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.
This is a variant of describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- A Consumer
that will call methods on DescribeEventsMessage.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDbInstanceOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest
- A Consumer
that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
describeOrderableDbInstanceOptionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException
Returns a list of orderable DB instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest
- A Consumer
that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
,
AWS API Documentationdefault DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest
- A Consumer
that will call methods on DescribePendingMaintenanceActionsMessage.Builder
to
create a request.ResourceNotFoundException
- The specified resource ID was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
describeValidDbInstanceModificationsRequest
- DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException
- The specified DB instance is not in the available state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This is a convenience which creates an instance of the
DescribeValidDbInstanceModificationsRequest.Builder
avoiding the need to create one manually via
DescribeValidDbInstanceModificationsRequest.builder()
describeValidDbInstanceModificationsRequest
- A Consumer
that will call methods on DescribeValidDBInstanceModificationsMessage.Builder
to create a request.DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDbInstanceStateException
- The specified DB instance is not in the available state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
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.
failoverDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the FailoverDbClusterRequest.Builder
avoiding the need
to create one manually via FailoverDbClusterRequest.builder()
failoverDbClusterRequest
- A Consumer
that will call methods on FailoverDBClusterMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all tags on an Amazon Neptune resource.
listTagsForResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Lists all tags on an Amazon Neptune resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
modifyDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ModifyDbClusterRequest.Builder
avoiding the need
to create one manually via ModifyDbClusterRequest.builder()
modifyDbClusterRequest
- A Consumer
that will call methods on ModifyDBClusterMessage.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
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.
modifyDbClusterParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ModifyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ModifyDbClusterParameterGroupRequest.builder()
modifyDbClusterParameterGroupRequest
- A Consumer
that will call methods on ModifyDBClusterParameterGroupMessage.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS 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 AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use
all
as a value for that parameter in this case.
To view which AWS 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.
modifyDbClusterSnapshotAttributeRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS 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 AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use
all
as a value for that parameter in this case.
To view which AWS 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.
This is a convenience which creates an instance of the ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually via ModifyDbClusterSnapshotAttributeRequest.builder()
modifyDbClusterSnapshotAttributeRequest
- A Consumer
that will call methods on ModifyDBClusterSnapshotAttributeMessage.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
modifyDbInstanceRequest
- 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
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ModifyDbInstanceRequest.Builder
avoiding the need
to create one manually via ModifyDbInstanceRequest.builder()
modifyDbInstanceRequest
- A Consumer
that will call methods on ModifyDBInstanceMessage.Builder
to create a request.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
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbParameterGroupResponse modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
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.
modifyDbParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbParameterGroupResponse modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ModifyDbParameterGroupRequest.Builder
avoiding the
need to create one manually via ModifyDbParameterGroupRequest.builder()
modifyDbParameterGroupRequest
- A Consumer
that will call methods on ModifyDBParameterGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
modifyDbSubnetGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
This is a convenience which creates an instance of the ModifyDbSubnetGroupRequest.Builder
avoiding the
need to create one manually via ModifyDbSubnetGroupRequest.builder()
modifyDbSubnetGroupRequest
- A Consumer
that will call methods on ModifyDBSubnetGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
modifyEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
SubscriptionNotFoundException
SnsInvalidTopicException
SnsNoAuthorizationException
SnsTopicArnNotFoundException
SubscriptionCategoryNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ModifyEventSubscriptionRequest.Builder
avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest
- A Consumer
that will call methods on ModifyEventSubscriptionMessage.Builder
to create a
request.EventSubscriptionQuotaExceededException
SubscriptionNotFoundException
SnsInvalidTopicException
SnsNoAuthorizationException
SnsTopicArnNotFoundException
SubscriptionCategoryNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Promotes a Read Replica DB cluster to a standalone DB cluster.
promoteReadReplicaDbClusterRequest
- DbClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException
- The DB cluster is not in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Promotes a Read Replica DB cluster to a standalone DB cluster.
This is a convenience which creates an instance of the PromoteReadReplicaDbClusterRequest.Builder
avoiding the need to create one manually via PromoteReadReplicaDbClusterRequest.builder()
promoteReadReplicaDbClusterRequest
- A Consumer
that will call methods on PromoteReadReplicaDBClusterMessage.Builder
to create
a request.DbClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDbClusterStateException
- The DB cluster is not in a valid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
rebootDbInstanceRequest
- InvalidDbInstanceStateException
- The specified DB instance is not in the available state.DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the RebootDbInstanceRequest.Builder
avoiding the need
to create one manually via RebootDbInstanceRequest.builder()
rebootDbInstanceRequest
- A Consumer
that will call methods on RebootDBInstanceMessage.Builder
to create a request.InvalidDbInstanceStateException
- The specified DB instance is not in the available state.DbInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveRoleFromDBClusterResponse removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
removeRoleFromDbClusterRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveRoleFromDBClusterResponse removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
This is a convenience which creates an instance of the RemoveRoleFromDbClusterRequest.Builder
avoiding
the need to create one manually via RemoveRoleFromDbClusterRequest.builder()
removeRoleFromDbClusterRequest
- A Consumer
that will call methods on RemoveRoleFromDBClusterMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes a source identifier from an existing event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
- SubscriptionNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes a source identifier from an existing event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builder
avoiding the need to create one manually via
RemoveSourceIdentifierFromSubscriptionRequest.builder()
removeSourceIdentifierFromSubscriptionRequest
- A Consumer
that will call methods on RemoveSourceIdentifierFromSubscriptionMessage.Builder
to create a request.SubscriptionNotFoundException
SourceNotFoundException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes metadata tags from an Amazon Neptune resource.
removeTagsFromResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException
Removes metadata tags from an Amazon Neptune resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
resetDbClusterParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ResetDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ResetDbClusterParameterGroupRequest.builder()
resetDbClusterParameterGroupRequest
- A Consumer
that will call methods on ResetDBClusterParameterGroupMessage.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetDbParameterGroupResponse resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
resetDbParameterGroupRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetDbParameterGroupResponse resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the ResetDbParameterGroupRequest.Builder
avoiding the
need to create one manually via ResetDbParameterGroupRequest.builder()
resetDbParameterGroupRequest
- A Consumer
that will call methods on ResetDBParameterGroupMessage.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
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.
restoreDbClusterFromSnapshotRequest
- 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
KmsKeyNotAccessibleException
- Error accessing KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the RestoreDbClusterFromSnapshotRequest.Builder
avoiding the need to create one manually via RestoreDbClusterFromSnapshotRequest.builder()
restoreDbClusterFromSnapshotRequest
- A Consumer
that will call methods on RestoreDBClusterFromSnapshotMessage.Builder
to create
a request.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
KmsKeyNotAccessibleException
- Error accessing KMS key.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
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.
restoreDbClusterToPointInTimeRequest
- 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
StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException
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.
This is a convenience which creates an instance of the RestoreDbClusterToPointInTimeRequest.Builder
avoiding the need to create one manually via RestoreDbClusterToPointInTimeRequest.builder()
restoreDbClusterToPointInTimeRequest
- A Consumer
that will call methods on RestoreDBClusterToPointInTimeMessage.Builder
to
create a request.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
StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptuneException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.